qdb_backup()

Start a database backup

Synopsis:

#include <qdb/qdb.h>

int qdb_backup( qdb_hdt_t *db,
                int scope );

Arguments:

db

A pointer to the database handle.

scope

The scope of the backup. Possible values are:

• QDB_ATTACH_DEFAULT — Act on attached databases as specified in the configuration file (honouring the value of the Vacuum Attached, Backup Attached, and Size Attached parameters. This gives backwards-compatable behavior.
• QDB_ATTACH_ALWAYS — Always act on any attached databases, regardless of configuration file settings.
• QDB_ATTACH_NEVER — Act only on the connected database itself, and never on any attached databses.

Library:

qdb

Description:

This function performs a backup on the connected database hdl, and optionally any attached databases, depending on the scope argument. Backups are controlled in the configuration file, via the Backup Dir= and Compression= options. For more information about these options, see the Configuration File section of the chapter Starting QDB.

A client can cancel a backup operation by calling qdb_bkcancel(). If a backup is cancelled (either by a client or via the QDB resource manager interface), the call to qdb_backup() fails and returns -1, with errno set to EINTR.

Returns:

>0

Success.

-1

An error occurred (errno is set).

Classification:

QNX Neutrino

See also:

qdb_bkcancel()