log_put.html   [plain text]


<!--$Id: log_put.html,v 1.1.1.1 2003/02/15 04:55:53 zarzycki Exp $-->
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: DbEnv.log_put</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
</head>
<body bgcolor=white>
<a name="2"><!--meow--></a>
<table width="100%"><tr valign=top>
<td>
<h1>DbEnv.log_put</h1>
</td>
<td align=right>
<a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<hr size=1 noshade>
<tt>
<h3><pre>
import com.sleepycat.db.*;
<p>
public void log_put(DbLsn lsn, Dbt data, int flags)
    throws DbException;
</pre></h3>
<h1>Description</h1>
<p>The DbEnv.log_put method appends records to the log.  The <a href="../api_java/lsn_class.html">DbLsn</a> of
the put record is returned in the <b>lsn</b> argument.  The <b>flags</b>
argument may be set to one of the following values:
<p><dl compact>
<p><dt><a name="Db.DB_FLUSH">Db.DB_FLUSH</a><dd>The log is forced to disk after this record is written, guaranteeing
that all records with <a href="../api_java/lsn_class.html">DbLsn</a> values less than or equal to the
one being "put" are on disk before DbEnv.log_put returns.
</dl>
<p>The caller is responsible for providing any necessary structure to
<b>data</b>.  (For example, in a write-ahead logging protocol, the
application must understand what part of <b>data</b> is an operation
code, what part is redo information, and what part is undo information.
In addition, most transaction managers will store in <b>data</b> the
<a href="../api_java/lsn_class.html">DbLsn</a> of the previous log record for the same transaction, to
support chaining back through the transaction's log records during
undo.)
<p>The DbEnv.log_put method throws an exception that encapsulates a non-zero error value on
failure.
<h1>Errors</h1>
<p>The <a href="../api_java/log_flush.html">DbEnv.log_flush</a> method may fail and throw an exception encapsulating a non-zero error for the following conditions:
<p><dl compact>
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
<p>The record to be logged is larger than the maximum log record.
</dl>
<p>The DbEnv.log_put method may fail and throw an exception for errors specified for other Berkeley DB and C library or system methods.
If a catastrophic error has occurred, the DbEnv.log_put method may fail and
throw a <a href="../api_java/runrec_class.html">DbRunRecoveryException</a>,
in which case all subsequent Berkeley DB calls will fail in the same way.
<h1>Class</h1>
<a href="../api_java/env_class.html">DbEnv</a>, <a href="../api_java/logc_class.html">DbLogc</a>, <a href="../api_java/lsn_class.html">DbLsn</a>
<h1>See Also</h1>
<a href="../api_java/log_list.html">Logging Subsystem and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
</body>
</html>