qdb_vacuum()

Vacuum a database

Synopsis:

#include <qdb/qdb.h>

int qdb_vacuum ( qdb_hdt_t *db,
                 int scope );

Arguments:

db: A pointer to the database handle.
scope: The scope of the operation (see the scope argument in qdb_backup() for more information).

Library:

qdb

Description:

This function starts a vacuum operation on the specified database and any auto-attached databases (which are listed in the main databases' .aa file). This is an alternative to using the VACUUM command for each database.

You can call qdb_getdbsize() to determine whether a database should be vacuumed.

If the auto-vacuum mode is enabled (see the PRAGMA SQL command for details), databases are vacuumed whenever free space is created. By default, auto-vacuum mode is disabled.

Returns:

0: Success.
-1: An error occurred (errno is set).

Classification:

QNX Neutrino

Safety:
Interrupt handler	No
Signal handler	No
Thread	Yes