ttBackup

Description

Creates a backup copy of a data store that can be restored at a later time using the ttRestore utility. If the data store is in use at the time of backup, it must be in shared mode to enable ttBackup. For an overview of the TimesTen backup and restore facility, see "Copying, migrating, backing up and restoring a data store" in the Oracle TimesTen In-Memory Database Operations Guide.

Required privilege

This utility requires the ADMIN privilege.

If authentication information is not supplied in the connection string or DSN, this utility prompts for a user ID and password before continuing.

Syntax

ttBackup {-h | -help | -?}
ttBackup {-V | -version}
ttBackup -dir directory [-type backupType]
[-fname fileprefix] [-force]
{-connStr connection_string | DSN}

Options

ttBackup has the options:

Option	Description
`-connStr` `connection_string`	An ODBC connection string containing the name of the data store, the server name and DSN (if necessary) and any relevant connection attributes.
`DSN`	Specifies an ODBC data source name of the data store to be backed up.
`-dir` `directory`	Specifies the directory where the backup files should be stored.
`-fname` `fileprefix`	Specifies the file prefix for the backup files in the backup directory. The default value for this option is the file name portion of the `DataStore` parameter of the data store's ODBC definition.
`-force`	Forces the backup into the specified directory. If a backup already exists in that directory, ttBackup overwrites it. If this option is not specified ttBackup terminates with an end message without overwriting existing files.
`-h -help` `-?`	Prints a usage message and exits.
`-type` `backupType`	Specifies the type of backup to be performed. Valid values are: `fileFull` - Performs a full file backup to the backup path specified by the `directory` and `fileprefix` parameters (default). The resulting backup is not enabled for incremental backup. `fileFullEnable` - Performs a full file backup to the backup path specified by the `directory` and `fileprefix` parameters. The resulting backup is enabled for incremental backup. `fileIncremental` - Performs an incremental file backup to the backup path specified by the `directory` and `fileprefix` parameters, if that backup path contains an incremental-enabled backup of the data store. Otherwise, an error is returned. `fileIncrOrFull` - Performs an incremental file backup to the backup path specified by the `directory` and `fileprefix` parameters if that backup path contains an incremental-enabled backup of the data store. Otherwise, it performs a full file backup of the data store and marks it incremental enabled. `streamFull`- Performs a stream backup to standard out `incrementalStop`- Does not perform a backup. Disables incremental backups for the backup path specified by the `directory` and `fileprefix` parameters. This prevents transaction log files from accumulating for an incremental backup.
`-V \| -version`	Prints the release number of ttBackup and exits.

Examples

To perform a full file backup of the FastIns data store to the backup directory in/users/pat/TimesTen/backups, use:

ttBackup -type fileFullEnable -dir /users/pat/TimesTen/backups FastIns

To copy the FastIns data store to the file FastIns.back, use:

ttBackup -type streamFull FastIns > FastIns.back

On Unix, to save the FastIns data store to a backup tape, use:

ttBackup -type streamFull FastIns | dd bs=64k of=/dev/rmt0

To back up a data store named origDSN to the directory /users/rob/tmp and restore it to the data store named restoredDSN, use:

ttBackup -type fileFull -dir /users/rob/tmp -fname restored origDSN
ttRestore -dir /users/rob/tmp -fname restored restoredDSN

Notes

When an incremental backup has been enabled, TimesTen creates a backup hold in the transaction log file. This hold can be seen using the ttLogHolds built-in procedure. The backup hold is used to determine which log records should be backed up upon subsequent incremental backups. Only changes since the last incremental backup are updated. A side effect to creating the backup hold is that it prevents transaction log files from being purged upon a checkpoint operation until the hold is advanced by performing another incremental backup or removed by disabling incremental backups.

Transactions that committed after the most recent checkpoint are not reflected in the backup.

Up to one checkpoint and one backup may be active at the same time, with the following limitations:

A backup never needs to wait for a checkpoint to complete.
A backup may need to wait for another backup to complete.
A checkpoint may need to wait for a backup to complete.

This utility is supported only where the TimesTen Data Manager is installed.

You cannot back up temporary data stores.