vbr Reference
vbr
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.
Most tasks cannot run concurrently; however, replication tasks can run concurrently with each other and with backups. Concurrent tasks must not use the same snapshot name.
vbr
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 node[,...] ]
[ --showconfig ]
Where command is one of the following:
Full | Short Command | Description |
---|---|
--help | -h
|
Shows a brief usage guide for the command. |
--showconfig
|
Displays the current configuration settings. |
{--task | -t } { backup | collect-garbage | copycluster* | full-check | init | listbackup | quick-check | quick-repair | remove | replicate | restore } |
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 |
--nodes node[,...] |
Specifies any nodes, in a comma-separated list, on which to perform a 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 |
--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. If you are using wildcards, use --include-objects and --exclude-objects instead. |
--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. |
--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. |
--dry-run |
Used with the --task command for backup, restore and replicate tasks. Performs a test run of the specified command without actually performing the task. You can use this command to evaluate the impact of a particular vbr command without actually performing that command. For example, you could see the size of a potential backup, or the objects contained in that backup. Any task performed with the dry-run parameter has no impact on your database. |
--include-objects pattern
|
Specifies database objects or patterns of objects to restore from a full or object-level backup. Use commas to delimit multiple objects and wildcard patterns. For more information, refer to Including and Excluding Objects Using Wildcards. You cannot use this parameter with the |
--exclude-objects pattern
|
Along with You cannot use this parameter with the |
Interrupting vbr
To cancel a backup, use Ctrl+C or send a SIGINT to the Python process running vbr
. vbr
stops the backup process after it has completed copying the data. Canceling a vbr
backup with Ctrl+C closes the session immediately.
The files generated by an interrupted backup process remain in the target backup location directory. The next backup process picks up where the interrupted process left off.
Backup operations are atomic, so that interrupting a backup operation does not affect the previous backup. Vertica replaces the previous backup only as the very last step of backing up your database.
restore
or copycluster
operations overwrite the database catalog directory. Interrupting either of these processes leaves the database unusable until you restart the process and allow it to finish.