#include <db_cxx.h>

int
Db::close(u_int32_t flags);

Description: Db::close

The Db::close method flushes any cached database information to disk, closes any open cursors, frees any allocated resources, and closes any underlying files.

The Db handle should not be closed while any other handle that refers to it is not yet closed; for example, database handles must not be closed while cursor handles into the database remain open, or transactions that include operations on the database have not yet been committed or aborted. Specifically, this includes Dbc and DbTxn handles.

Because key/data pairs are cached in memory, failing to sync the file with the Db::close or Db::sync method may result in inconsistent or lost information.

When called on a database that is the primary database for a secondary index, the primary database should be closed only after all secondary indices which reference it have been closed.

When multiple threads are using the Db concurrently, only a single thread may call the Db::close method.

The Db handle may not be accessed again after Db::close is called, regardless of its return.

The Db::close 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

flags

The flags parameter must be set to 0 or by bitwise inclusively OR'ing together one or more of the following values:

DB_NOSYNC

Do not flush cached information to disk. The DB_NOSYNC flag is a dangerous option. It should be set only if the application is doing logging (with transactions) so that the database is recoverable after a system or application crash, or if the database is always generated from scratch after any system or application crash.

It is important to understand that flushing cached information to disk only minimizes the window of opportunity for corrupted data. Although unlikely, it is possible for database corruption to happen if a system or application crash occurs while writing data to the database. To ensure that database corruption never occurs, applications must either: use transactions and logging with automatic recovery; use logging and application-specific recovery; or edit a copy of the database, and once all applications using the database have successfully called Db::close, atomically replace the original database with the updated copy.

Errors

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

EINVAL

An invalid flag value or parameter was specified.

Class

See Also