1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
<!--$Id: log_put.so,v 10.41 2004/08/13 03:38:57 bostic Exp $-->
<!--Copyright 1997-2005 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: DB_ENV->log_put</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>
<h3>DB_ENV->log_put</h3>
</td>
<td align=right>
<a href="../api_c/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>
<h3><pre>
#include <db.h>
<p>
int
DB_ENV->log_put(DB_ENV *env,
DB_LSN *lsn, const DBT *data, u_int32_t flags);
</pre></h3>
<hr size=1 noshade>
<h3>Description: DB_ENV->log_put</h3>
<p>The DB_ENV->log_put method appends records to the log. The <a href="../api_c/lsn_class.html">DB_LSN</a> of
the put record is returned in the <b>lsn</b> parameter.</p>
<p>The DB_ENV->log_put method
returns a non-zero error value on failure
and 0 on success.
</p>
<h3>Parameters</h3>
<dl compact>
<dt><b>data</b><dd>The <b>data</b> parameter is the record to write to the log.
<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_c/lsn_class.html">DB_LSN</a> of the previous log record for the same transaction, to
support chaining back through the transaction's log records during
undo.)</p>
<dt><b>flags</b><dd>The <b>flags</b> parameter must be set to 0 or
the following value:
<dl compact>
<dt><a name="DB_FLUSH">DB_FLUSH</a><dd>The log is forced to disk after this record is written, guaranteeing
that all records with <a href="../api_c/lsn_class.html">DB_LSN</a> values less than or equal to the
one being "put" are on disk before DB_ENV->log_put returns.
</dl>
<dt><b>lsn</b><dd>The <b>lsn</b> parameter references memory into which
the <a href="../api_c/lsn_class.html">DB_LSN</a> of the put record is copied.
</dl>
<h3>Errors</h3>
<p>The <a href="../api_c/log_flush.html">DB_ENV->log_flush</a> method
may fail and return one of the following non-zero errors:</p>
<dl compact>
<dt>EINVAL<dd>If the record to be logged is larger than the maximum log record; or if an
invalid flag value or parameter was specified.
</dl>
<hr size=1 noshade>
<h3>Class</h3>
<a href="../api_c/env_class.html">DB_ENV</a>, <a href="../api_c/logc_class.html">DB_LOGC</a>, <a href="../api_c/lsn_class.html">DB_LSN</a>
<h3>See Also</h3>
<a href="../api_c/log_list.html">Logging Subsystem and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../api_c/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><a href="../sleepycat/legal.html">Copyright (c) 1996-2005</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font>
</body>
</html>
|
