DOC HOME SITE MAP MAN PAGES GNU INFO SEARCH PRINT BOOK
 

DbEnv::txn_checkpoint

API Ref

#include <db_cxx.h>

int DbEnv::txn_checkpoint(u_int32_t kbyte, u_int32_t min, u_int32_t flags) const;


Description: DbEnv::txn_checkpoint

If there has been any logging activity in the database environment since the last checkpoint, the DbEnv::txn_checkpoint method flushes the underlying memory pool, writes a checkpoint record to the log, and then flushes the log.

The DbEnv::txn_checkpoint 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 the following value:
DB_FORCE
Force a checkpoint record, even if there has been no activity since the last checkpoint.
kbyte
If the kbyte parameter is non-zero, a checkpoint will be done if more than kbyte kilobytes of log data have been written since the last checkpoint.
min
If the min parameter is non-zero, a checkpoint will be done if more than min minutes have passed since the last checkpoint.

Errors

The DbEnv::txn_checkpoint 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

DbEnv, DbTxn

See Also

Transaction Subsystem and Related Methods

APIRef

Copyright (c) 1996-2005 Sleepycat Software, Inc. - All rights reserved.