Administration Tools - oobackup

Printer-friendly version
Archives a federated database to a backup medium.
oobackup
(([-full] | -incremental | -subincremental)
[-destination backupDirPath] )
| (-set setName -backup backupName -volume volName
-device deviceSpecifier [-level backupLevel])
[-capacity size]
[-procfiles programName]
[-purgeAps]
[-quiet]
[-timestamp]
[-standalone]
[-notitle]
[-help]
[backupBootFilePath]
Options
-full
Take a full backup of the specified federated database. This is the default if you omit the backup-level options -full, -incremental, and -subincremental.
This option may be used with the -destination option.
-incremental
Take an incremental backup of the specified federated database. An incremental backup records all changes made since the most recent full backup.
This option may be used with the -destination option.
-subincremental
Take a subincremental backup of the specified federated database. A subincremental backup records all changes made since the most recent incremental backup.
This option may be used with the -destination option.
-destination backupDirPath
Full path to the disk directory in which to write the backup files. The default is the current directory (the directory in which you are executing oobackup).
This option may be used with the -full, -incremental, or -subincremental option.
-set setName
Name of the backup set that is to contain the backup event.
This option must be used with the -backup, -volume, -device, and -level options.
-backup backupName
Name of the backup event to be executed. The name must be unique within the scope of the backup set specified by setName.
This option must be used with the -set, -volume, -device, and -level options.
-volume volName
Volume name prefix. Each volume name consists of the volume name prefix plus a sequential numeric value. For example, if volName is myVol, the first volume of a federated database backup has the name myVol_1. The second volume has the name myVol_2. Multiple volumes are generated only if the backup size exceeds the backup capacity value.
This option must be used with the -set, -backup, -device, and -level options.
-device deviceSpecifier
Full path to the disk directory in which to store the backup volumes. For example, if the value for deviceSpecifier is /dba/backups and the value for volName is fdb020492, then the actual disk filename for the first backup volume is /dba/backups/fdb020492_1.
This option must be used with the -set, -backup, -volume, and -level options.
-level backupLevel
Backup level. Valid values are integers 0 through 9. The default level is 0, which executes a full backup.
This option must be used with the -set, -backup, -volume, and -device options.
-capacity size
Capacity of each backup volume in kilobytes. The default is 1000 (1 MB).
-procfiles programName
Full or relative path to the shell script or program to be executed after each backup volume is written.
During the execution of oobackup, the name of the backup volume just written and the total size in bytes of the backup volumes written so far are passed to the script as command-line arguments. If the script exits with a nonzero status, oobackup reports an error and terminates immediately.
-purgeAps
(For backward compatibility only) (HA) Skips the system-database file of any autonomous partition other than the boot partition. This option enables you to back up the data in a pre-Release 9.0 partitioned federated database when some partitions are inaccessible.
If you specify this option, oobackup must be able to access (at least) a quorum of partitions and quorum for each database. If you omit this option, oobackup must be able to access all partitions. If you specify this option on a full backup, then you must also specify the option on all subsequent incremental backups and on oorestore.
Note: Do not use this option when backing up a Release 9.0 (or later) partitioned federated database.
-quiet
Suppresses all normal program output.
You must omit this option if you specify -timestamp.
-timestamp
Includes the current date and time (hours:minutes:seconds) at the beginning of each progress message in the program output. You must omit this option if you specify -quiet.
-standalone
Nonconcurrent mode. Use this option if no lock server is running or to bypass a running lock server.
Warning: Corruption can occur if concurrent access to the federated database is attempted while any process is using this mode.
-notitle
Suppresses the copyright notice and program title banner. Useful when invoking the tool from another tool or product.
-help
Prints the tool syntax and definition to the screen.
backupBootFilePath
Path to the backup boot file for the federated database to be archived. You can omit this argument if you set the OO_FD_BOOT environment variable to the correct path. You must use the same boot file when restoring the federated database.
Discussion
Depending on your requirements, you can perform:
n
A basic backup, where you simply specify one of three backup levels (-full, -incremental, or -subincremental) and the directory (-destination) in which to write the resulting backup files. Objectivity/DB automatically generates the names of all backup files and other administrative structures. If you omit all of the backup-level options, a full backup is taken.
n
A customized backup, where you can specify one of 10 backup levels (-level) and you must provide naming information for the backup files (-device and -volume) and other administrative structures (-set and -backup).
You can use a combination of basic and customized backups to archive a given federated database:
n
A full backup (taken with -full) and is internally a level 0 backup.
n
An incremental backup (taken with -incremental) and is internally a level 3 backup.
n
A subincremental backup (taken with -subincremental) is internally a level 6 backup.
Some federated databases have multiple boot files—for example, a distributed federated database may require multiple copies of the boot file. Similarly, in a partitioned federated database, each autonomous partition has its own boot file. When a federated database has multiple boot files, you must choose one specific boot file, called the backup boot file, to specify the federated database for both backup and restore operations.
(HA) In a partitioned federated database, the oobackup tool must be able to access (at least) a quorum of partitions and quorum for each database.
If the size of the backup event exceeds the volume capacity, multiple backup volumes with the same volume name prefix are generated.
The oobackup tool reports an error and quits in any of the following cases:
n
You start oobackup while another oobackup process is running on the same federated database. You may perform only one backup on a federated database at a time.
n
You start oobackup while a concurrent user application is in a transaction that created or deleted a container in the same federated database, and oobackup times out while waiting for the transaction to end (abort, commit, or checkpoint). The timeout period is 10 minutes.
Warning: Do not run oobackup and either oogc or ootidy concurrently, because these tools may delete objects that oobackup references.
See also

Date: 
Tuesday, October 30, 2012
Product: 
Objectivity/DB
Version: 
10.2.1
10.2
10.1.4
10.1.2
9.4.1