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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
|
<?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->cursor()</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="dbc.html" title="Chapter 3. The DBcursor Handle" />
<link rel="prev" href="dbc.html" title="Chapter 3. The DBcursor Handle" />
<link rel="next" href="dbcclose.html" title="DBcursor->close()" />
</head>
<body>
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">DB->cursor()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="dbc.html">Prev</a> </td>
<th width="60%" align="center">Chapter 3.
The DBcursor Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="dbcclose.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="dbcursor"></a>DB->cursor()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include <db.h>
int
DB->cursor(DB *db, DB_TXN *txnid, DBC **cursorp, u_int32_t flags); </pre>
<p>
The <code class="methodname">DB->cursor()</code> method returns a created database cursor.
</p>
<p>
Cursors may span threads, but only serially, that is, the application
must serialize access to the cursor handle.
</p>
<p>
The <code class="methodname">DB->cursor()</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="idp50892384"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp50893320"></a>txnid</h4>
</div>
</div>
</div>
<p>
To transaction-protect cursor operations, cursors must be
opened and closed within the context of a transaction. The
<span class="bold"><strong>txnid</strong></span> parameter specifies the
transaction context in which the cursor may be used.
</p>
<p>
Cursor operations are not automatically transaction-protected, even if the
<a class="link" href="envset_flags.html#envset_flags_DB_AUTO_COMMIT">DB_AUTO_COMMIT</a>
flag is specified to the
<a class="xref" href="envset_flags.html" title="DB_ENV->set_flags()">DB_ENV->set_flags()</a> or
<a class="xref" href="dbopen.html" title="DB->open()">DB->open()</a> methods. If
cursor operations are to be transaction-protected, the <span class="bold"><strong>txnid</strong></span> parameter must be a transaction handle
returned from <a class="xref" href="txnbegin.html" title="DB_ENV->txn_begin()">DB_ENV->txn_begin()</a>; otherwise,
NULL.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp50926640"></a>cursorp</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>cursorp</strong></span> parameter references
memory into which a pointer to the allocated cursor is copied.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp50887992"></a>flags</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>flags</strong></span> parameter must be set to 0
or by bitwise inclusively <span class="bold"><strong>OR</strong></span>'ing
together one or more of the following values:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p><a id="cursor_DB_BULK"></a>
<code class="literal">DB_CURSOR_BULK</code>
</p>
<p>
Configure a cursor to optimize for bulk operations. Each
successive operation on a cursor configured with this flag
attempts to continue on the same database page as the previous
operation, falling back to a search if a different page is
required. This avoids searching if there is a high degree of
locality between cursor operations. This flag is currently
only effective with the btree access method: for other access
methods it is ignored.
</p>
</li>
<li>
<p><a id="cursor_DB_READ_COMMITTED"></a>
<code class="literal">DB_READ_COMMITTED</code>
</p>
<p>
Configure a transactional cursor to have degree 2 isolation. This
ensures the stability of the current data item read by this cursor but
permits data read by this cursor to be modified or deleted prior to
the commit of the transaction for this cursor.
</p>
</li>
<li>
<p><a id="cursor_DB_READ_UNCOMMITTED"></a>
<code class="literal">DB_READ_UNCOMMITTED</code>
</p>
<p>
Configure a transactional cursor to have degree 1 isolation. Read
operations performed by the cursor may return modified but not yet
committed data. Silently ignored if the
<a class="link" href="dbopen.html#dbopen_DB_READ_UNCOMMITTED">DB_READ_UNCOMMITTED</a>
flag was not specified when the underlying database was opened.
</p>
</li>
<li>
<p><a id="cursor_DB_WRITECURSOR"></a>
<code class="literal">DB_WRITECURSOR</code>
</p>
<p>
Specify that the cursor will be used to update the database. The
underlying database environment must have been opened using the
<a class="link" href="envopen.html#envopen_DB_INIT_CDB">DB_INIT_CDB</a> flag.
</p>
</li>
<li>
<p><a id="cursor_DB_TXN_SNAPSHOT"></a>
<code class="literal">DB_TXN_SNAPSHOT</code>
</p>
<p>
Configure a transactional cursor to operate with read-only <a href="../../programmer_reference/transapp_read.html" class="olink">snapshot isolation</a>. For
databases with the
<a class="link" href="dbopen.html#dbopen_DB_MULTIVERSION">DB_MULTIVERSION</a>
flag set, data values will be read as they are when the cursor is
opened, without taking read locks.
</p>
<p>
This flag implicitly begins a transaction that is committed when the cursor is
closed.
</p>
<p>
This flag is silently ignored if
<a class="link" href="dbopen.html#dbopen_DB_MULTIVERSION">DB_MULTIVERSION</a>
is not set on the underlying database or if a transaction is supplied in
the <span class="bold"><strong>txnid</strong></span> parameter.
</p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp50933328"></a>Errors</h3>
</div>
</div>
</div>
<p>
The <code class="methodname">DB->cursor()</code> <span>
<span>
method may fail and return one of the following non-zero errors:
</span>
</span>
</p>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp50924096"></a> DB_REP_HANDLE_DEAD</h4>
</div>
</div>
</div>
<p>
When a client synchronizes with the master, it is possible for committed
transactions to be rolled back. This invalidates all the database and cursor
handles opened in the replication environment. Once this occurs, an attempt to use
such a handle will
return <code class="literal">DB_REP_HANDLE_DEAD</code>.
The application will need to discard the handle and open a new one in order to
continue processing.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp50923472"></a>DB_REP_LOCKOUT</h4>
</div>
</div>
</div>
<p>
The operation was blocked by client/master synchronization.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp50932808"></a>EINVAL</h4>
</div>
</div>
</div>
<p>
An invalid flag value or parameter was specified.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp50924832"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="db.html" title="Chapter 2. The DB Handle">DB</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp50933760"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="dbc.html#dbclist" title="Database Cursors and Related Methods">Database Cursors 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="dbc.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="dbc.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="dbcclose.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">Chapter 3.
The DBcursor Handle
</td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DBcursor->close()</td>
</tr>
</table>
</div>
</body>
</html>
|
