Parameter

Description

backup-directory

The target location on disk for the backup files, relative to the server's current directory at startup. If the directory does not already exist, it is created. Specifying an empty string as a directory allows you to rename or truncate the log without making a copy of it first.

The backslash ( \ ) is an escape character in SQL strings, so each backslash must be doubled (e.g. 'C:\\My\\Backup').

You can use '&1' in place of a fixed directory location. See the examples below.

WAIT BEFORE START

This clause ensures that the backup copy of the database does not contain any information required for recovery. In particular, it ensures that the rollback log for each connection is empty.

If a backup is carried out using this clause, you can start the backup copy of the database in read-only mode and validate it. By enabling validation of the backup database, the customer can avoid making an additional copy of the database.

WAIT AFTER END

This clause may be used if the transaction log is being renamed or truncated. It ensures that all transactions are completed before the log is renamed or truncated. If this clause is used, the backup must wait for other connections to commit or rollback any open transactions before finishing.

MATCH keyword

If you supply the MATCH keyword, the backup copy of the transaction log is given a name of the form YYMMDDnn.log. This enables the same statement to be executed several times without writing over old data.

archive-root

The file name or tape drive device name for the archive file.

To back up to tape, you must specify the device name of the tape drive. For example, on Windows NT or NetWare, the first tape drive is \\.\tape0.

The backslash ( \ ) is an escape character in SQL strings, so each backslash must be doubled.

WITH COMMENT

Record a comment in the archive file and in the backup history file.

ATTENDED

The clause applies only when backing up to a tape device. ATTENDED ON (the default) indicates that someone is available to monitor the status of the tape drive and to place a new tape in the drive when needed. A message is sent to the application that issued the BACKUP statement if the tape drive requires intervention. The database server then waits for the drive to become ready. This may happen, for example, when a new tape is required.

If ATTENDED OFF is specified and a new tape is required or the drive is not ready, no message is sent, and an error is given.