Vertica Analytics Platform Version 9.2.x Documentation

[Misc] Miscellaneous Settings

This section collects basic settings, including the name and location of your backup. The section also indicates whether you are keeping more than a single backup file, as specified by the restorePointLimit parameter.

Parameter Default Configuration Setting and Description
snapshotName
snapshotName

The base name of the backup. This name is used in the directory tree structure that vbr creates for each node.

Each iteration in this series (up to restorePointLimit) consists of the snapshotName and a timestamp for a specific backup. Each series of backups should have a unique and descriptive snapshotName. Full and object-level backups also cannot share names. For most vbr tasks, the snapshotName serves as a useful identifier in diagnostics and system tables. For object restore and replication tasks, snapshotName is used to build schema names in coexist mode operations.

A snapshotName can contain up to 240 characters.

The snapshot name may contain only the following characters; all others are invalid:

  • a–z
  • A–Z
  • 0–9
  • Hyphen (-)
  • Underscore (_)
tempDir
/tmp/vbr

Specifies an absolute path to a temporary storage area on the cluster nodes. The tmp path must be the same on all nodes in the cluster. vbr uses this directory as a temporary location for log files, lock files, and other bookkeeping information while it is copying files from the source cluster node to the destination backup location. vbr also writes backup logs to this location.

Do not specify the same location as your database's data or catalog directory. Any unexpected files or directories in your data or catalog location can cause errors during database start or restore.

The file system at this location must support fcntl lockf (POSIX) file locking.

restorePointLimit
1

Specifies the number of historical backups to retain in addition to the most recent backup. For example, if you set restorePointLimit=3, Vertica saves three historical backups, in addition to the most recent backup, for a total of four backups. By default, Vertica maintains a current backup and one historical backup. Enter a positive integer.

Saves multiple backups to the same location, which are shared through hard links. In such cases, listbackup displays the common backup prefix but indicates unique time and date suffixes:

my_archive20111111_205841
objects

None

For an object-level backup or object replication, specifies the object (schema or table) names to include. To specify more than one object, enter multiple names in a comma-separated list. To identify objects using wildcards, use the includeObjects parameter instead.

Specify table names in the form schema.objectname. For example, to make backups of the table customers from the schema finance, enter finance.customers. If a public table and a schema have the same name, vbr backs up only the schema. Use the schema.objectname convention to avoid confusion.

Object names can include UTF-8 alphanumeric characters. Object names cannot include escape characters, single quote ('), or double quote (") characters.

Specify non-alphanumeric characters with a backslash (\) followed by a hex value. For instance, if the table name is my table (my followed by a space character, then table), enter the object name as follows:

objects=my\20table

This parameter conflicts with the includeObjects parameter. Use one or the other in your configuration file.

If you do not specify any objects, vbr creates a full backup.

objectRestoreMode
createOrReplace

Specifies how vbr handles objects of the same name when restoring schema or table backups.

Valid Values:

  • createOrReplace — vbr creates any objects that do not exist. If the object does exist, vbr overwrites it with the version from the archive.
  • create — vbr creates any objects that do not exist. If an object being restored does exist, vbr displays an error message and skips that object.
  • coexist — vbr creates the restored version of each object with a name of the form <backup>_<timestamp>_<object_name>. This approach allows existing and restored objects to exist simultaneously. If the appended information pushes the schema name past the maximum length of 128 characters, Vertica truncates the name. You can perform a reverse lookup of the original schema name by querying the system table TRUNCATED_SCHEMATA.

In all modes, vbr restores data with the current epoch. Object restore mode settings do not apply to backups and full restores.

retryCount
2

Specifies the number of backup attempts to make. If the backup fails after exceeding the number of retry attempts, vbr reports an error and stops processing.

retryDelay
1

Specifies the number of seconds to wait between backup retry attempts, if a failure occurs.

passwordFile
None
Specifies the file name of the password configuration file.
enableFreeSpaceCheck
True
When enabled, vbr confirms that the specified backup locations contain sufficient free space and inodes to allow a successful backup. If a backup location has insufficient resources, vbr displays an error message and cancels the backup. If vbr cannot determine the amount of available space or number of inodes in the backupDir, it displays a warning and continues with the backup.
If you do not include this setting in your configuration file, vbr performs the space check by default.
SnapshotEpochLagFailureThreshold
3600
When performing a backup, replication, or copycluster task, specifies the maximum acceptable difference, in seconds, between the current epoch and the backup epoch. If the time between the current epoch and the backup epoch exceeds the value specified in this parameter, vbr displays an error message. A value of 0 disables this check. If you do not include this setting in your configuration file, vbr performs this check using the default value. Backups do not contain information committed after the backup epoch.
includeObjects
None

Identifies database objects and wildcard patterns to include with a backup task. Use a comma to delimit multiple objects and wildcard patterns. For more information, refer to Including and Excluding Objects Using Wildcards.

You can use this parameter together with excludeObjects. This parameter conflicts with the objects parameter. Use one or the other in your configuration file.

excludeObjects
None

Identifies database objects and wildcard patterns to exclude from the set specified by includeObjects. Use a comma to delimit multiple objects and wildcard patterns. For more information, refer to Including and Excluding Objects Using Wildcards. Use of this parameter requires use of includeObjects.