show_restore_points

Shows restore points.

Shows restore points.

Syntax

vcluster show_restore_points options

Required options

{ -c | --config } string
The path to the config file. If a configuration file is present in the default location (automatically generated by create_db), you do not need to specify this option.

Default: /opt/vertica/config/vertica_cluster.yaml

Options

--cert-file string
The absolute path to the certificate file. If you specify this option, you must also specify --key-file. You should only use --cert-file and --key-file if you have configured the Node Management Agent (NMA) to use custom certificates.
--communal-storage-location string
[Eon only] The absolute path of your communal storage location.
--config-param PARAMETER=VALUE[,...]
A comma-separated list of PARAMETER=VALUE pairs. Parameters specified with this option override the ones in configuration files, if any, and take the following parameters:
  • AWSAuth
  • AWSEndpoint
  • AWSEnableHttps
  • AWSRegion
--end-timestamp string
Shows restore points up to and including the specified UTC timestamp in either date-time or date-only format. For example:
  • "2006-01-02 15:04:05"
  • "2006-01-02"
  • "2006-01-02 15:04:05.000000000"
{ -h | --help }
Prints help text.
--ipv6
Whether the hosts use IPv6 addresses. Hostnames resolve to IPv4 by default.
--key-file string
Path to the key file. If you specify this option, you must also specify --cert-file. You should only use --cert-file and --key-file if you have configured the Node Management Agent (NMA) to use custom certificates.
{ -l | --log-path } string
The absolute path for debug logs.

Default: /opt/vertica/log/vcluster.log

{ -p | --password } string
The database password.
--password-file string
The absolute path to a file containing the database password.

If you pass a dash(-) (that is, `--password-file -`), the password is read from STDIN.

--read-password-from-prompt
Prompts the user to enter the password.
--restore-point-archive string
Filter for restore point names that include the specified string.
--restore-point-id string
Filter for restore point IDs that include the specified ID.
--restore-point-index string
Filter for restore points indices that include the specified index.
--start-timestamp string
Shows restore points after and including the specified UTC timestamp in either date-time or date-only format. For example:
  • "2006-01-02 15:04:05"
  • "2006-01-02"
  • "2006-01-02 15:04:05.000000000"
--verbose
Shows the details of VCluster run in the console.

Examples

Show all restore points:

$ vcluster show_restore_points --db-name vertica_db \
  --config /opt/vertica/config/vertica_cluster.yaml

Show all restore points on an Eon Mode database:

$ vcluster show_restore_points --db-name vertica_db \
  --hosts 192.0.2.0,192.0.2.1,192.0.2.2 \
  --communal-storage-location /communal

Show restore points with the name db1:

$ vcluster show_restore_points --db-name test_db \
  --hosts 192.0.2.0,192.0.2.1,192.0.2.2 \
  --restore-point-archive db1

Show restore points on an Eon Mode database with the ID 34668031-c63d-4f3b-ba97-70223c4f97d6:

$ vcluster show_restore_points --db-name test_db \
  --hosts 192.0.2.0,192.0.2.1,192.0.2.2 \
  --communal-storage-location /communal \
  --restore-point-id 34668031-c63d-4f3b-ba97-70223c4f97d6

Show restore points on an Eon Mode database between 2024-03-04 08:32:33.277569 and 2024-03-04 08:32:34.176391:

$ vcluster show_restore_points --db-name test_db \
  --hosts 192.0.2.0,192.0.2.1,192.0.2.2 \
  --communal-storage-location /communal \
  --start-timestamp 2024-03-04 08:32:33.277569 \
  --end-timestamp 2024-03-04 08:32:34.176391