File: put.html

package info (click to toggle)
db 2%3A2.4.14-2.7.7.1.c
  • links: PTS
  • area: main
  • in suites: potato
  • size: 12,716 kB
  • ctags: 9,382
  • sloc: ansic: 35,556; tcl: 8,564; cpp: 4,890; sh: 2,075; makefile: 1,723; java: 1,632; sed: 419; awk: 153; asm: 41
file content (120 lines) | stat: -rw-r--r-- 3,757 bytes parent folder | download | duplicates (6)
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
<! "@(#)put.so	10.9 (Sleepycat) 10/2/98">
<!Copyright 1997, 1998 by Sleepycat Software, Inc.  All rights reserved.>
<html>
<body bgcolor=white>
<head>
<title>Berkeley DB: log_put</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btr
ee,hash,hashing,transaction,transactions,locking,logging,access method,access me
thods,java,C,C++">
</head>
<h1>log_put</h1>
<hr size=1 noshade>
<tt>
<h3>
<pre>
#include &lt;db.h&gt;
<p>
int
log_put(DB_LOG *logp,
    DB_LSN *lsn, const DBT *data, u_int32_t flags);
</pre>
</h3>
<h1>Description</h1>
<p>
The log_put function appends records to the log.  The DB_LSN 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:
<dl compact>
<a name="DB_CHECKPOINT">
<p><dt>DB_CHECKPOINT<dd>The log should write a checkpoint record, recording any information
necessary to make the log structures recoverable after a crash.
<a name="DB_CURLSN">
<p><dt>DB_CURLSN<dd>The DB_LSN of the next record to be put is returned in the
<b>lsn</b> argument.].
<a name="DB_FLUSH">
<p><dt>DB_FLUSH<dd>The log is forced to disk after this record is written, guaranteeing
that all records with DB_LSN values less than or equal to the
one being put are on disk before this function returns (this function
is most often used for a transaction commit, see <a href="../../api_c/DbTxn/commit.html">txn_commit</a> for
more information).
<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
DB_LSN of the previous log record for the same transaction, to
support chaining back through the transaction's log records during undo.)
</dl>
<p>
The log_put
function returns the value of <b>errno</b> on failure, and 0 on success.
<p>
<h1>Errors</h1>
If a fatal error occurs in Berkeley DB, the log_put function may fail and return
DB_RUNRECOVERY, at which point all subsequent database calls will also
return DB_RUNRECOVERY.
<p>
The log_put
function may fail and return <b>errno</b>
for any of the errors specified for the following Berkeley DB and C library
functions:
abort(3),
close(3),
dbenv->db_paniccall(3),
fcntl(3),
fflush(3),
fprintf(3),
free(3),
fsync(3),
getenv(3),
getpid(3),
getuid(3),
isdigit(3),
lseek(3),
malloc(3),
memcpy(3),
memset(3),
open(3),
sigfillset(3),
sigprocmask(3),
snprintf(3),
stat(3),
strerror(3),
strlen(3),
time(3),
unlink(3),
vfprintf(3),
vsnprintf(3),
and
write(3).
<p>
In addition, the <a href="../../api_c/DbLog/flush.html">log_flush</a>
function may fail and return <b>errno</b>
for the following conditions:
<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>
<h1>See Also</h1>
<a href="../../api_c/DbLog/archive.html">log_archive</a>,
<a href="../../api_c/DbLog/close.html">log_close</a>,
<a href="../../api_c/DbLog/compare.html">log_compare</a>,
<a href="../../api_c/DbLog/file.html">log_file</a>,
<a href="../../api_c/DbLog/flush.html">log_flush</a>,
<a href="../../api_c/DbLog/get.html">log_get</a>,
<a href="../../api_c/DbLog/open.html">log_open</a>,
log_put,
<a href="../../api_c/DbLog/db_register.html">log_register</a>,
<a href="../../api_c/DbLog/stat.html">log_stat</a>,
<a href="../../api_c/DbLog/unlink.html">log_unlink</a>
and
<a href="../../api_c/DbLog/db_unregister.html">log_unregister</a>.
</tt>
</body>
</html>