Berkeley DB: DB_ENV->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++

# DB_ENV->txn_checkpoint |

`

###

    #include <db.h>

    int
    DB_ENV->txn_checkpoint(const DB_ENV *env,
        u_int32_t kbyte, u_int32_t min, u_int32_t flags);

# Description

If there has been database environment activity since the last checkpoint, the DB_ENV->txn_checkpoint method flushes the underlying memory pool, writes a checkpoint record to the log, and then flushes the log.

If kbyte or min is non-zero, the checkpoint is done only if 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 DB_ENV->txn_checkpoint method returns a non-zero error value on failure and 0 on success.

The DB_ENV->txn_checkpoint method is the underlying interface used by the db_checkpoint utility. See the db_checkpoint utility source code for an example of using DB_ENV->txn_checkpoint in a IEEE/ANSI Std 1003.1 (POSIX) environment.

# Errors

The DB_ENV->txn_checkpoint method may fail and return a non-zero error for the following conditions:

EINVAL
  An invalid flag value or parameter was specified.

The DB_ENV->txn_checkpoint method may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. If a catastrophic error has occurred, the DB_ENV->txn_checkpoint method may fail and return DB_RUNRECOVERY, in which case all subsequent Berkeley DB calls will fail in the same way.

# Class

DB_ENV, DB_TXN

# See Also

Transaction Subsystem and Related Methods`

Copyright Sleepycat Software