Import BSDDB 4.7.25 (as of svn r89086)
This commit is contained in:
72
docs/api_cxx/txn_checkpoint.html
Normal file
72
docs/api_cxx/txn_checkpoint.html
Normal file
@@ -0,0 +1,72 @@
|
||||
<!--$Id: txn_checkpoint.html 63573 2008-05-23 21:43:21Z trent.nelson $-->
|
||||
<!--Copyright (c) 1997,2008 Oracle. All rights reserved.-->
|
||||
<!--See the file LICENSE for redistribution information.-->
|
||||
<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>
|
||||
<b>DbEnv::txn_checkpoint</b>
|
||||
</td>
|
||||
<td align=right>
|
||||
<a href="../api_cxx/api_core.html"><img src="../images/api.gif" alt="API"></a>
|
||||
<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td>
|
||||
</tr></table>
|
||||
<hr size=1 noshade>
|
||||
<tt>
|
||||
<b><pre>
|
||||
#include <db_cxx.h>
|
||||
<p>
|
||||
int
|
||||
DbEnv::txn_checkpoint(u_int32_t kbyte, u_int32_t min, u_int32_t flags) const;
|
||||
</pre></b>
|
||||
<hr size=1 noshade>
|
||||
<b>Description: DbEnv::txn_checkpoint</b>
|
||||
<p>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.</p>
|
||||
<p>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.
|
||||
</p>
|
||||
<b>Parameters</b> <br>
|
||||
<b>flags</b><ul compact><li>The <b>flags</b> parameter must be set to 0 or
|
||||
the following value:
|
||||
<br>
|
||||
<b><a name="DB_FORCE">DB_FORCE</a></b><ul compact><li>Force a checkpoint record, even if there has been no activity since the
|
||||
last checkpoint.</ul>
|
||||
<br></ul>
|
||||
<b>kbyte</b><ul compact><li>If the <b>kbyte</b> parameter is non-zero, a checkpoint will be done
|
||||
if more than <b>kbyte</b> kilobytes of log data have been written since
|
||||
the last checkpoint.</ul>
|
||||
<b>min</b><ul compact><li>If the <b>min</b> parameter is non-zero, a checkpoint will be done if
|
||||
more than <b>min</b> minutes have passed since the last checkpoint.</ul>
|
||||
<br>
|
||||
<br><b>Errors</b>
|
||||
<p>The DbEnv::txn_checkpoint method
|
||||
may fail and throw
|
||||
<a href="../api_cxx/except_class.html">DbException</a>,
|
||||
encapsulating one of the following non-zero errors, or return one of
|
||||
the following non-zero errors:</p>
|
||||
<br>
|
||||
<b>EINVAL</b><ul compact><li>An
|
||||
invalid flag value or parameter was specified.</ul>
|
||||
<br>
|
||||
<hr size=1 noshade>
|
||||
<br><b>Class</b>
|
||||
<a href="../api_cxx/env_class.html">DbEnv</a>, <a href="../api_cxx/txn_class.html">DbTxn</a>
|
||||
<br><b>See Also</b>
|
||||
<a href="../api_cxx/txn_list.html">Transaction Subsystem and Related Methods</a>
|
||||
</tt>
|
||||
<table width="100%"><tr><td><br></td><td align=right>
|
||||
<a href="../api_cxx/api_core.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a>
|
||||
</td></tr></table>
|
||||
<p><font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user