#include <db_cxx.h>

int
Db::sync(u_int32_t flags);

Description: Db::sync

The Db::sync method flushes any cached information to disk.

If the database is in memory only, the Db::sync method has no effect and will always succeed.

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.

The Db::sync 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 is currently unused, and must be set to 0.

Errors

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

The database handle has been invalidated because a replication election unrolled a committed transaction.

EINVAL

An invalid flag value or parameter was specified.

Class

See Also