Backup/Restore an Eon Mode Database (eon_backup_restore.ini)

Backups of Eon Mode databases must be to S3. Backups of Enterprise Mode may be to S3. The S3-related configuration settings are identical in these two use cases.

To restore, use the same configuration file that you used to create the backup. To restore selected objects rather than the entire database, specify the objects to restore on the vbr command line using --restore-objects.

; This sample vbr configuration file shows backup of an Eon Mode database, which must be to AWS S3.
; Section headings are enclosed by square brackets.
; Comments have leading semicolons (;) or pound signs (#).
; Option and values are separated by an equal sign.
; Only arguments marked as '!!Mandatory!!' must be specified explicitly.
; All commented parameters are set to their default values.

; ------------------------------------------- ;
;;; BASIC PARAMETERS ;;;
; ------------------------------------------- ;

[S3]
; This section replaces the [Mapping] section and is required to back up to S3.

; !!Mandatory!! S3 bucket name and backup path where backups are stored on S3 (no default). Should be different from your communal storage location so you do not lose your backups if you lose your data location.
s3_backup_path = s3://backup_bucket/database_backup_path/

; !!Mandatory!! directory used to manage locking during a backup (no default).  If the directory is mounted on the initiator host, you should use "[]" instead of the local host name.  The file system must support POSIX fcntl flock.
s3_backup_file_system_path = []:/home/dbadmin/backup_locks_dir/
; s3_backup_file_system_path = otherhost.example:/home/dbadmin/backup_locks_dir/

; Specifies encryption-at-rest on S3
; s3_encrypt_at_rest = sse				
; s3_sse_kms_key_id = <key_id>

; Specifies SSL encrypted transfer.
; s3_encrypt_transport = True

; Specifies the number of threads for upload/download - backup
; s3_concurrency_backup = 10

; Specifies the number of threads for upload/download - restore
; s3_concurrency_restore = 10

[Misc]
; !!Recommended!! Snapshot name
; Backups with the same snapshotName form a time sequence limited by restorePointLimit.
; SnapshotName is used for naming archives in the backup directory, and for monitoring and troubleshooting.
; Valid values: a-z A-Z 0-9 - _
; snapshotName = backup_snapshot

[Database]
; !!Recommended!! If you have more than one database defined on this Vertica cluster, use this parameter to specify which database to backup/restore.
; dbName = current_database

; If this parameter is True, vbr prompts the user for the database password every time.
; If False, specify the location of password config file in 'passwordFile' parameter in [Misc] section.
; dbPromptForPassword = True

; ------------------------------------------- ;
;;; ADVANCED PARAMETERS ;;;
; ------------------------------------------- ;

[Misc]
; The temp directory location on all database hosts.
; The directory must be readable and writeable by the dbadmin, and must implement POSIX style fcntl lockf locking.
; tempDir = /tmp/vbr

; Specifies the number of historical backups to retain in addition to the most recent backup.
; 1 current + n historical backups
; restorePointLimit = 1

; Full path to the password configuration file
; Store this file in directory readable only by the dbadmin.
; (no default)
; passwordFile = /path/to/vbr/pw.txt

; When performing a backup, replication, or copycluster, 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, Vertica displays an error message.
; SnapshotEpochLagFailureThreshold = 3600

[Database]
; Vertica user name for vbr to connect to the database.
; This setting is rarely needed since dbUser is normally identical to the database administrator
; dbUser = current_username