← Back to branch summary

~ubuntu-branches/ubuntu/edgy/rpm/edgy

« back to all changes in this revision

Viewing changes to db/docs/api_java/log_put.html

  • Committer: Bazaar Package Importer
  • Author(s): Joey Hess
  • Date: 2002-01-22 20:56:57 UTC
  • Revision ID: james.westby@ubuntu.com-20020122205657-l74j50mr9z8ofcl5
Tags: upstream-4.0.3
Import upstream version 4.0.3

Show diffs side-by-side

added added

removed removed

Lines of Context:
db/docs/api_java/log_put.html
 
1
<!--$Id: log_put.so,v 10.22 2001/04/02 20:10:06 bostic Exp $-->
 
2
<!--Copyright 1997-2001 by Sleepycat Software, Inc.-->
 
3
<!--All rights reserved.-->
 
4
<html>
 
5
<head>
 
6
<title>Berkeley DB: DbEnv.log_put</title>
 
7
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
 
8
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
 
9
</head>
 
10
<body bgcolor=white>
 
11
<a name="2"><!--meow--></a>
 
12
<table width="100%"><tr valign=top>
 
13
<td>
 
14
<h1>DbEnv.log_put</h1>
 
15
</td>
 
16
<td align=right>
 
17
<a href="../api_java/java_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
 
18
</td></tr></table>
 
19
<hr size=1 noshade>
 
20
<tt>
 
21
<h3><pre>
 
22
import com.sleepycat.db.*;
 
23
<p>
 
24
public void log_put(DbLsn lsn, Dbt data, int flags)
 
25
        throws DbException;
 
26
</pre></h3>
 
27
<h1>Description</h1>
 
28
<p>The DbEnv.log_put method appends records to the log.  The <a href="../api_java/lsn_class.html">DbLsn</a> of
 
29
the put record is returned in the <b>lsn</b> argument.  The <b>flags</b>
 
30
argument may be set to one of the following values:
 
31
<p><dl compact>
 
32
<p><dt><a name="Db.DB_CHECKPOINT">Db.DB_CHECKPOINT</a><dd>The log should write a checkpoint record, recording any information
 
33
necessary to make the log structures recoverable after a crash.
 
34
<p><dt><a name="Db.DB_CURLSN">Db.DB_CURLSN</a><dd>The <a href="../api_java/lsn_class.html">DbLsn</a> of the next record to be put is returned in the
 
35
<b>lsn</b> argument.
 
36
<p><dt><a name="Db.DB_FLUSH">Db.DB_FLUSH</a><dd>The log is forced to disk after this record is written, guaranteeing
 
37
that all records with <a href="../api_java/lsn_class.html">DbLsn</a> values less than or equal to the
 
38
one being put are on disk before this function returns (this function
 
39
is most often used for a transaction commit; see <a href="../api_java/txn_commit.html">DbTxn.commit</a> for
 
40
more information).
 
41
<p>The caller is responsible for providing any necessary structure to
 
42
<b>data</b>.  (For example, in a write-ahead logging protocol, the
 
43
application must understand what part of <b>data</b> is an operation
 
44
code, what part is redo information, and what part is undo information.
 
45
In addition, most transaction managers will store in <b>data</b> the
 
46
<a href="../api_java/lsn_class.html">DbLsn</a> of the previous log record for the same transaction, to
 
47
support chaining back through the transaction's log records during
 
48
undo.)
 
49
</dl>
 
50
<p>The DbEnv.log_put method throws an exception that encapsulates a non-zero error value on
 
51
failure.
 
52
<h1>Errors</h1>
 
53
<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:
 
54
<p><dl compact>
 
55
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
 
56
<p>The record to be logged is larger than the maximum log record.
 
57
</dl>
 
58
<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.
 
59
If a catastrophic error has occurred, the DbEnv.log_put method may fail and throw
 
60
a <a href="../api_java/runrec_class.html">DbRunRecoveryException</a>, in which case all subsequent Berkeley DB calls
 
61
will fail in the same way.
 
62
<h1>Class</h1>
 
63
<a href="../api_java/dbenv_class.html">DbEnv</a>
 
64
<h1>See Also</h1>
 
65
<a href="../api_java/env_set_lg_bsize.html">DbEnv.set_lg_bsize</a>,
 
66
<a href="../api_java/env_set_lg_dir.html">DbEnv.set_lg_dir</a>,
 
67
<a href="../api_java/env_set_lg_max.html">DbEnv.set_lg_max</a>,
 
68
<a href="../api_java/env_set_lg_regionmax.html">DbEnv.set_lg_regionmax</a>,
 
69
<a href="../api_java/log_archive.html">DbEnv.log_archive</a>,
 
70
<a href="../api_java/log_compare.html">DbEnv.log_compare</a>,
 
71
<a href="../api_java/log_file.html">DbEnv.log_file</a>,
 
72
<a href="../api_java/log_flush.html">DbEnv.log_flush</a>,
 
73
<a href="../api_java/log_get.html">DbEnv.log_get</a>,
 
74
<a href="../api_java/log_put.html">DbEnv.log_put</a>,
 
75
<a href="../api_java/log_register.html">DbEnv.log_register</a>,
 
76
<a href="../api_java/log_stat.html">DbEnv.log_stat</a>,
 
77
and
 
78
<a href="../api_java/log_unregister.html">DbEnv.log_unregister</a>.
 
79
</tt>
 
80
<table width="100%"><tr><td><br></td><td align=right>
 
81
<a href="../api_java/java_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
 
82
</td></tr></table>
 
83
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
 
84
</body>
 
85
</html>