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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>DB_ENV->txn_recover()</title>
<link rel="stylesheet" href="apiReference.css" type="text/css" />
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
<link rel="start" href="index.html" title="Berkeley DB C API Reference" />
<link rel="up" href="txn.html" title="Chapter 12. The DB_TXN Handle" />
<link rel="prev" href="envset_tx_timestamp.html" title="DB_ENV->set_tx_timestamp()" />
<link rel="next" href="txnbegin.html" title="DB_ENV->txn_begin()" />
</head>
<body>
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">DB_ENV->txn_recover()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="envset_tx_timestamp.html">Prev</a> </td>
<th width="60%" align="center">Chapter 12.
The DB_TXN Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="txnbegin.html">Next</a></td>
</tr>
</table>
<hr />
</div>
<div class="sect1" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a id="txnrecover"></a>DB_ENV->txn_recover()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include <db.h>
int
DB_ENV->txn_recover(DB_ENV *dbenv, DB_PREPLIST preplist[],
long count, long *retp, u_int32_t flags); </pre>
<p>
Database environment recovery restores transactions that were
prepared, but not yet resolved at the time of the system shut down or
crash, to their state prior to the shut down or crash, including any
locks previously held. The <code class="methodname">DB_ENV->txn_recover()</code> method returns a
list of those prepared transactions.
</p>
<p>
The <code class="methodname">DB_ENV->txn_recover()</code> method should only be called after the
environment has been recovered.
</p>
<p>
Multiple threads of control may call <code class="methodname">DB_ENV->txn_recover()</code>, but only
one thread of control may resolve each returned transaction, that is,
only one thread of control may call <a class="xref" href="txncommit.html" title="DB_TXN->commit()">DB_TXN->commit()</a>
or <a class="xref" href="txnabort.html" title="DB_TXN->abort()">DB_TXN->abort()</a> on each
returned transaction. Callers of <code class="methodname">DB_ENV->txn_recover()</code> must call
<a class="xref" href="txndiscard.html" title="DB_TXN->discard()">DB_TXN->discard()</a> to
discard each transaction they do not resolve.
</p>
<p>
On return from <code class="methodname">DB_ENV->txn_recover()</code>, the <span class="bold"><strong>preplist</strong></span> parameter will be filled in with a list of transactions
that must be resolved by the application (committed, aborted or discarded). The <span class="bold"><strong>preplist</strong></span> parameter is a structure of type
<code class="literal">DB_PREPLIST</code>; the following <code class="literal">DB_PREPLIST</code> fields will be
filled in:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p>
<span class="bold"><strong>DB_TXN * txn;</strong></span>
</p>
<p>
The transaction handle for the transaction.
</p>
</li>
<li>
<p>
<span class="bold"><strong>u_int8_t gid[DB_GID_SIZE];</strong></span>
</p>
<p>
The global transaction ID for the transaction. The global transaction
ID is the one specified when the transaction was prepared. The
application is responsible for ensuring uniqueness among global
transaction IDs.
</p>
</li>
</ul>
</div>
<p>
The <code class="methodname">DB_ENV->txn_recover()</code> <span>
<span>
method returns a non-zero error value on failure and 0 on success.
</span>
</span>
</p>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp54463800"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp54464448"></a>preplist</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>preplist</strong></span> parameter references
memory into which the list of transactions to be resolved by the
application is copied.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp54463264"></a>count</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>count</strong></span> parameter specifies the
number of available entries in the passed-in <span class="bold"><strong>preplist</strong></span> array. The <span class="bold"><strong>retp</strong></span> parameter returns the number of entries
<code class="methodname">DB_ENV->txn_recover()</code> has filled in, in the array.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp54465408"></a>flags</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>flags</strong></span> parameter must be set to
one of the following values:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p>
<code class="literal">DB_FIRST</code>
</p>
<p>
Begin returning a list of prepared, but not yet resolved transactions.
Specifying this flag begins a new pass over all prepared, but not yet
completed transactions, regardless of whether they have already been
returned in previous calls to <code class="methodname">DB_ENV->txn_recover.()</code> Calls to
<code class="methodname">DB_ENV->txn_recover()</code> from different threads of control should not be
intermixed in the same environment.
</p>
</li>
<li>
<p>
<code class="literal">DB_NEXT</code>
</p>
<p>
Continue returning a list of prepared, but not yet resolved
transactions, starting where the last call to
<code class="methodname">DB_ENV->txn_recover()</code>
left off.
</p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp54471200"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="env.html" title="Chapter 5. The DB_ENV Handle">DB_ENV</a>, <a class="link" href="txn.html" title="Chapter 12. The DB_TXN Handle">DB_TXN</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp54465888"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="txn.html#txnlist" title="Transaction Subsystem and Related Methods">Transaction Subsystem and Related Methods</a>
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="envset_tx_timestamp.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="txn.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="txnbegin.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DB_ENV->set_tx_timestamp() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DB_ENV->txn_begin()</td>
</tr>
</table>
</div>
</body>
</html>
|
