Berkeley DB: DbEnv::txn_checkpoint
Description: Berkeley DB: An embedded database programmatic toolkit.
Keywords: embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++

# DbEnv::txn_checkpoint |

`

###

    #include <db_cxx.h>

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

# Description

The DbEnv::txn_checkpoint method flushes the underlying memory pool, writes a checkpoint record to the log, and then flushes the log.

If either kbyte or min is non-zero, the checkpoint is done only if there has been activity since the last checkpoint, and either more than min minutes have passed since the last checkpoint or if more than kbyte kilobytes of log data have been written since the last checkpoint.

The flags value 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.

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, 0 on success, and returns DB_INCOMPLETE if there were pages that needed to be written to complete the checkpoint but that DbEnv::memp_sync was unable to write immediately.

# Errors

The DbEnv::txn_checkpoint method may fail and throw an exception or return a non-zero error for the following conditions:

EINVAL
  An invalid flag value or parameter was specified.

The DbEnv::txn_checkpoint method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. If a catastrophic error has occurred, the DbEnv::txn_checkpoint method may fail and either return DB_RUNRECOVERY or throw an exception encapsulating DB_RUNRECOVERY, in which case all subsequent Berkeley DB calls will fail in the same way.

# Class

DbEnv, DbTxn

# See Also

DbEnv::set_tx_max, DbEnv::set_tx_recover, DbEnv::set_tx_timestamp, DbTxn::abort, DbEnv::txn_begin, DbEnv::txn_checkpoint, DbTxn::commit, DbTxn::discard, DbTxn::id, DbTxn::prepare, DbEnv::txn_recover, DbTxn::set_timeout and DbEnv::txn_stat.`

Copyright Sleepycat Software