qdb_getdbsize()

Synopsis:

#include <qdb/qdb.h>

int qdb_getdbsize( qdb_hdt_t *db,
                   int scope,
                   uint32_t *page_size,
                   uint32_t *total_pages,
                   uint32_t *free_pages );

Arguments:

db: A pointer to the database handle.
scope: The scope of the operation; see the scope argument in qdb_backup() for more information.
page_size: A pointer to memory for storing the size (in bytes) of each page in the database file.
total_pages: A pointer to memory for storing the total number of pages in the database file.
free_pages: A pointer to memory for storing the number of pages not being used to store data.

Library:

qdb

Description:

This function provides information about the size of the database associated with the db handle. The information reported includes the page size (in bytes) and total number of pages in the database file. In the filesystem, the database's size is page_size × total_pages. The function also reports the number of free pages, which are pages that don't currently store any data.

If you vacuum the database, QDB deletes the free pages so the total page count decreases, the free page count goes to 0, and the database file becomes smaller. For more information, see the VACUUM SQL command, the qdb_vacuum() function, and the Auto-vacuum section of the PRAGMA command.

Note: For an attached database to be included in the size calculation of the main database (i.e., the one with handle db), the attached database must be listed under the SizeAttached option in the configuration object for the main database.

Returns:

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

Classification:

QNX Neutrino

Safety:
Interrupt handler	No
Signal handler	No
Thread	Yes