2
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
3
<!--All rights reserved.-->
4
<!--See the file LICENSE for redistribution information.-->
7
<title>Berkeley DB: DbEnv::log_put</title>
8
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
9
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
12
<a name="2"><!--meow--></a>
13
<table width="100%"><tr valign=top>
15
<h1>DbEnv::log_put</h1>
18
<a href="../api_cxx/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
23
#include <db_cxx.h>
26
DbEnv::log_put(DbLsn *lsn, const Dbt *data, u_int32_t flags);
29
<p>The DbEnv::log_put method appends records to the log. The <a href="../api_cxx/lsn_class.html">DbLsn</a> of
30
the put record is returned in the <b>lsn</b> argument. The <b>flags</b>
31
argument may be set to one of the following values:
33
<p><dt><a name="DB_FLUSH">DB_FLUSH</a><dd>The log is forced to disk after this record is written, guaranteeing
34
that all records with <a href="../api_cxx/lsn_class.html">DbLsn</a> values less than or equal to the
35
one being "put" are on disk before DbEnv::log_put returns.
37
<p>The caller is responsible for providing any necessary structure to
38
<b>data</b>. (For example, in a write-ahead logging protocol, the
39
application must understand what part of <b>data</b> is an operation
40
code, what part is redo information, and what part is undo information.
41
In addition, most transaction managers will store in <b>data</b> the
42
<a href="../api_cxx/lsn_class.html">DbLsn</a> of the previous log record for the same transaction, to
43
support chaining back through the transaction's log records during
45
<p>The DbEnv::log_put method either returns a non-zero error value or throws an exception that
46
encapsulates a non-zero error value on failure, and returns 0 on success.
48
<p>The <a href="../api_cxx/log_flush.html">DbEnv::log_flush</a> method may fail and throw an exception or return a non-zero error for the following conditions:
50
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
51
<p>The record to be logged is larger than the maximum log record.
53
<p>The DbEnv::log_put 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.
54
If a catastrophic error has occurred, the DbEnv::log_put method may fail and
55
either return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw a
56
<a href="../api_cxx/runrec_class.html">DbRunRecoveryException</a>,
57
in which case all subsequent Berkeley DB calls will fail in the same way.
59
<a href="../api_cxx/env_class.html">DbEnv</a>, <a href="../api_cxx/logc_class.html">DbLogc</a>, <a href="../api_cxx/lsn_class.html">DbLsn</a>
61
<a href="../api_cxx/log_list.html">Logging Subsystem and Related Methods</a>
63
<table width="100%"><tr><td><br></td><td align=right>
64
<a href="../api_cxx/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
66
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>