head 1.2; access; symbols RPM_4_2_1:1.1.1.5 RPM_4_2:1.1.1.5 RPM_4_1_1:1.1.1.5 RPM_4_1:1.1.1.4 RPM_4_0_5:1.1.1.3 RPM_4_0_4:1.1.1.2 RPM_4_0_3:1.1.1.1 RPM:1.1.1; locks; strict; comment @# @; 1.2 date 2008.01.02.09.52.59; author rse; state dead; branches; next 1.1; commitid z4cpSiAhOCXk5PLs; 1.1 date 2001.07.23.20.45.36; author rse; state Exp; branches 1.1.1.1; next ; 1.1.1.1 date 2001.07.23.20.45.36; author rse; state Exp; branches; next 1.1.1.2; 1.1.1.2 date 2002.01.08.00.30.08; author rse; state Exp; branches; next 1.1.1.3; 1.1.1.3 date 2003.01.18.13.48.58; author rse; state Exp; branches; next 1.1.1.4; 1.1.1.4 date 2001.12.06.00.08.00; author rse; state Exp; branches; next 1.1.1.5; 1.1.1.5 date 2003.01.18.14.04.57; author rse; state Exp; branches; next ; desc @@ 1.2 log @remove the ancient RPM 4.2.1 source tree copy @ text @ Berkeley DB: txn_checkpoint

txn_checkpoint

 APIRef 

#include <db.h>


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

Description

The txn_checkpoint function 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 txn_checkpoint function returns 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 memp_sync was unable to write immediately.

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

Errors

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

EINVAL
An invalid flag value or parameter was specified.

The txn_checkpoint function 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 txn_checkpoint function may fail and return DB_RUNRECOVERY, in which case all subsequent Berkeley DB calls will fail in the same way.

See Also

DB_ENV->set_tx_max, DB_ENV->set_tx_recover, DB_ENV->set_tx_timestamp, txn_abort, txn_begin, txn_checkpoint, txn_commit, txn_discard, txn_id, txn_prepare, txn_recover, and txn_stat.

APIRef

Copyright Sleepycat Software @ 1.1 log @Initial revision @ text @d1 1 a1 1 @ 1.1.1.1 log @Import: RPM 4.0.3 @ text @@ 1.1.1.2 log @Import: RPM 4.0.4 @ text @d1 1 a1 1 d6 1 a6 1 Berkeley DB: DB_ENV->txn_checkpoint d14 1 a14 1

DB_ENV->txn_checkpoint

d25 1 a25 1 DB_ENV->txn_checkpoint(const DB_ENV *env, d29 1 a29 1

The DB_ENV->txn_checkpoint function flushes the underlying memory pool, d42 2 a43 2

The DB_ENV->txn_checkpoint function returns 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 DB_ENV->memp_sync was unable d45 2 a46 2

The DB_ENV->txn_checkpoint function is the underlying function used by the db_checkpoint utility. See the db_checkpoint utility source code for an example of using DB_ENV->txn_checkpoint d49 1 a49 1

The DB_ENV->txn_checkpoint function may fail and return a non-zero error for the following conditions: d53 2 a54 2

The DB_ENV->txn_checkpoint function 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 function may fail and return d61 8 a68 9 DB_TXN->abort, DB_ENV->txn_begin, DB_ENV->txn_checkpoint, DB_TXN->commit, DB_TXN->discard, DB_TXN->id, DB_TXN->prepare, DB_ENV->txn_recover, DB_TXN->set_timeout d70 1 a70 1 DB_ENV->txn_stat. @ 1.1.1.3 log @Import: RPM 4.0.5 @ text @d1 2 a2 2 a3 1 d29 7 a35 7

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. d42 4 a45 2

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. d49 1 a49 1

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

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 d58 14 a71 1 Transaction Subsystem and Related Methods @ 1.1.1.4 log @Import: RPM 4.1 @ text @d1 2 a2 2 d4 1 d30 7 a36 7

The DB_ENV->txn_checkpoint function 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. d43 2 a44 4

The DB_ENV->txn_checkpoint function returns 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 DB_ENV->memp_sync was unable to write immediately.

The DB_ENV->txn_checkpoint function is the underlying function used by the db_checkpoint utility. d48 1 a48 1

The DB_ENV->txn_checkpoint function may fail and return a non-zero error for the following conditions: d52 6 a57 4

The DB_ENV->txn_checkpoint function 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 function may fail and return DB_RUNRECOVERY, in which case all subsequent Berkeley DB calls will fail in the same way. d59 1 a59 14 DB_ENV->set_tx_max, DB_ENV->set_tx_recover, DB_ENV->set_tx_timestamp, DB_TXN->abort, DB_ENV->txn_begin, DB_ENV->txn_checkpoint, DB_TXN->commit, DB_TXN->discard, DB_TXN->id, DB_TXN->prepare, DB_ENV->txn_recover, DB_TXN->set_timeout and DB_ENV->txn_stat. @ 1.1.1.5 log @Import: RPM 4.1.1 @ text @d1 2 a2 2 a3 1 d29 7 a35 7

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. d42 4 a45 2

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. d49 1 a49 1

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

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 d58 14 a71 1 Transaction Subsystem and Related Methods @