VBR Utility Reference
Allows you to back up and restore either the full database, or one or more schema and table objects of interest. You can also copy a cluster and list backups you created previously.
The utility is located in the Vertica binary directory (/opt/vertica/bin/vbr
on most installations).
Syntax
/opt/vertica/bin/vbr
{ command }
... [ --archive timestamp ]
... [ --config-file file ]
... [ --debug level]
... [ --nodes node1 [, noden, ...] ]
... [ --showconfig ]
Where command is one of the following:
Full Command | Short Command | Description |
---|---|---|
--help
|
-h
|
Shows a brief usage guide for the command. |
--showconfig
|
Displays the current configuration settings. | |
--setupconfig
|
|
Asks a series of questions and generates a configuration file. |
--task {backup | 7.2_upgrade | collect-garbage | copycluster | full-check | init | listbackup | quick-check | quick-repair | remove | replicate | restore } |
-t
|
Performs the specified task:
|
Parameters
Parameter | Description |
---|---|
--archive timestamp |
Used with the
|
-c file --config-file file |
Indicates the configuration file to use as an absolute or relative path to the location from which you start the backup utility. If no file exists, an error occurs and the utility cannot continue. |
--nodes node1[,...] |
Specifies any nodes, in a comma-separated list, on which to perform a Caution: Do not try to restore the entire database cluster from a partial database backup created from a subset of the nodes. Data loss could result. |
--debug level |
Specifies the level of debugging messages (from 0 to 3) that the |
--report-file path/filename |
Optional. Outputs a delimited JSON file that describes the results of the associated full backup integrity check or garbage collection task. |
--restore-objects objects |
Specifies the individual objects to restore from a full or object-level backup. |
--s3-force-init |
Used with the --task init command. Forces the init task to succeed on S3 storage targets when there is an identity/lock file mismatch. For more information, refer to Creating Backups on Amazon S3. |
--showconfig |
The configuration values being used to perform the task, displayed in raw JSON format before |
--list-all |
Used with the --task listbackup command. Displays a list of all backups stored on the hosts and paths listed in the specified configuration file. |
--json |
Used with the --task listbackup command. Displays a JSON delimited list of all backups stored on the hosts and paths listed in the specified configuration file. |
--list-output-file path/filename |
Used with the --task listbackup command. Outputs a file containing a JSON delimited list of all backups stored on the hosts and paths listed in the specified configuration file. |