Edit File - File Manager

Edit File: txn_checkpoint.html

<html>
<head>
<title>Berkeley DB: DbEnv::txn_checkpoint</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
</head>
<body bgcolor=white>
<table width="100%"><tr valign=top>
<td>
DbEnv::txn_checkpoint
</td>
<td align=right>
<a href="../../db4-devel-4.7.25/api_cxx/api_core.html"><img src="../../db4-devel-4.7.25/images/api.gif" alt="API"></a>
<a href="../../db4-devel-4.7.25/ref/toc.html"><img src="../../db4-devel-4.7.25/images/ref.gif" alt="Ref"></a></td>
</tr></table>
<hr size=1 noshade>
<tt>
<pre>
#include &lt;db_cxx.h&gt;

int
DbEnv::txn_checkpoint(u_int32_t kbyte, u_int32_t min, u_int32_t flags) const;
</pre>
<hr size=1 noshade>
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<ul compact><li>The flags parameter must be set to 0 or
the following value:
 
<a name="DB_FORCE">DB_FORCE</a><ul compact><li>Force a checkpoint record, even if there has been no activity since the
last checkpoint.</ul>
 </ul>
 kbyte<ul compact><li>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.</ul>
 min<ul compact><li>If the min parameter is non-zero, a checkpoint will be done if
more than min minutes have passed since the last checkpoint.</ul>
 
 Errors
The DbEnv::txn_checkpoint method
may fail and throw
<a href="../../db4-devel-4.7.25/api_cxx/except_class.html">DbException</a>,
encapsulating one of the following non-zero errors, or return one of
the following non-zero errors:
 
EINVAL<ul compact><li>An
invalid flag value or parameter was specified.</ul>
 
<hr size=1 noshade>
 Class
<a href="../../db4-devel-4.7.25/api_cxx/env_class.html">DbEnv</a>, <a href="../../db4-devel-4.7.25/api_cxx/txn_class.html">DbTxn</a>
 See Also
<a href="../../db4-devel-4.7.25/api_cxx/txn_list.html">Transaction Subsystem and Related Methods</a>
</tt>
<table width="100%"><tr><td> </td><td align=right>
<a href="../../db4-devel-4.7.25/api_cxx/api_core.html"><img src="../../db4-devel-4.7.25/images/api.gif" alt="API"></a><a href="../../db4-devel-4.7.25/ref/toc.html"><img src="../../db4-devel-4.7.25/images/ref.gif" alt="Ref"></a>
</td></tr></table>
Copyright (c) 1996,2008 Oracle. All rights reserved.
</body>
</html>

Back to File Manager