Db::compact API Ref

#include <db_cxx.h>

int Db::compact(DbTxn *txnid, Dbt *start, Dbt *stop, DB_COMPACT *c_data, u_int32_t flags, Dbt *end);


Description: Db::compact

The Db::compact method compacts Btree and Recno access method databases, and optionally returns unused Btree, Hash or Recno database pages to the underlying filesystem.

The Db::compact method either returns a non-zero error value or throws an exception that encapsulates a non-zero error value on failure, and returns 0 on success.

Parameters
txnid start stop c_data flags end

Errors

The Db::compact method may fail and throw DbException, encapsulating one of the following non-zero errors, or return one of the following non-zero errors:


DB_REP_HANDLE_DEAD

DB_REP_LOCKOUT

EACCES

EINVAL

If a transactional database environment operation was selected to resolve a deadlock, the Db::compact method will fail and either return DB_LOCK_DEADLOCK or throw a DbDeadlockException exception.

If a Berkeley DB Concurrent Data Store database environment configured for lock timeouts was unable to grant a lock in the allowed time, the Db::compact method will fail and either return DB_LOCK_NOTGRANTED or throw a DbLockNotGrantedException exception.



Class Db
See Also Databases and Related Methods

APIRef

Copyright (c) 1996,2008 Oracle. All rights reserved.