revive_db

Revives or restores an Eon Mode database. You cannot revive sandboxes with this command.

Syntax

vcluster revive_db options

Required options

If access to communal storage requires access keys, you must provide the keys with the --config-param option.

--communal-storage-location string

[Eon only] The absolute path of your communal storage location.

{ -d | --db-name } string

The name of the database. You should only use this option if you want to override the database name in your configuration file. This string must conform to the format used for database names.

--hosts strings

Comma-separated list of hosts in the database. The number of hosts that you provide must match the number of hosts in the existing database. You can omit the hosts only if --display-only is specified.

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.

{ -c | --config } string

The path to write the configuration file.

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

--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

--display-only

Shows information about the database in communal storage. If you specify this option, you can omit --hosts.

--force-removal

Deletes any existing database directories before reviving, excluding user storage directories.

{ -h | --help }

Prints help text.

--ignore-cluster-lease

Do not check for the existence of other clusters running on shared storage. If another system is using the same communal storage, using this option results in data corruption.

Default: Disabled

--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.

--load-catalog-timeout uint

The timeout, in seconds, for loading the remote catalog.

Default: 3600

{ -l | --log-path } string

The absolute path for debug logs.

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

{ -o | --output-file } string

Writes the output to the specified file instead of STDOUT.

Default: STDOUT

--restore-point-archive string

The name of the restore point archive to use for bootstrapping. If you specify this option, you must also specify --restore-point-id or -restore-point-index.

--restore-point-id string

The identifier of the restore point in the restore archive.

--restore-point-index int

The index of the restore point in the restore archive to restore from. Restore point indexes are one-indexed.

--verbose

Shows the details of VCluster run in the console.

Examples

To revive the database and write the configuration file to /opt/vertica/config/vertica_cluster.yaml:

$ vcluster revive_db --db-name vertica_db \
  --hosts 192.0.2.0,192.0.2.1,192.0.2.2 \
  --communal-storage-location /communal \
  --config /opt/vertica/config/vertica_cluster.yaml

To restore the database using the restore point archive db at index 1:

$ vcluster revive_db --db-name vertica_db \
  --hosts 192.0.2.0,192.0.2.1,192.0.2.2 \
  --communal-storage-location /communal \
  --config /opt/vertica/config/vertica_cluster.yaml --force-removal \
  --restore-point-archive db --restore-point-index 1