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
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
|
<?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::close()</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="db.html" title="Chapter 2. The Db Handle" />
<link rel="prev" href="dbassociate_foreign.html" title="Db::associate_foreign()" />
<link rel="next" href="dbcompact.html" title="Db::compact()" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 11.2.5.3</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">Db::close()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="dbassociate_foreign.html">Prev</a> </td>
<th width="60%" align="center">Chapter 2.
The Db Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="dbcompact.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="dbclose"></a>Db::close()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include <db_cxx.h>
int
Db::close(u_int32_t flags);</pre>
<p>
The <code class="methodname">Db::close()</code> method flushes cached database information to
disk, closes any open cursors, frees allocated resources, and
closes underlying files. When the close operation for a cursor fails,
the method returns a non-zero error value for the first instance of such an error,
and continues to close the rest of the cursors and database handles.
</p>
<p>
Although closing a database handle will close any open cursors, it
is recommended that applications explicitly close all their
<a class="link" href="dbc.html" title="Chapter 3. The Dbc Handle">Dbc</a> handles
before closing the database. The reason why is that when
the cursor is explicitly closed, the memory allocated for it is
reclaimed; however, this will <span class="emphasis"><em>not</em></span> happen if
you close a database while cursors are still opened.
</p>
<p>
The same rule, for the same reasons, hold true for
<a class="link" href="txn.html" title="Chapter 13. The DbTxn Handle">DbTxn</a>
handles. Simply make sure you close all your transaction handles
before closing your database handle.
</p>
<p>
Because key/data pairs are cached in memory, applications should
make a point to always either close database handles or sync their
data to disk (using the <a class="xref" href="dbsync.html" title="Db::sync()">Db::sync()</a>
method) before exiting, to ensure that any data cached in main memory are
reflected in the underlying file system.
</p>
<p>
When called on a database that is the primary database for a secondary
index, the primary database should be closed only after all secondary
indices referencing it have been closed.
</p>
<p>
When multiple threads are using the <a class="link" href="db.html" title="Chapter 2. The Db Handle">Db</a>
concurrently, only a single thread may call the <code class="methodname">Db::close()</code> method.
</p>
<p>
The <a class="link" href="db.html" title="Chapter 2. The Db Handle">Db</a> handle may not be
accessed again after <code class="methodname">Db::close()</code> is called, regardless of its return.
</p>
<p>
If you do not close the <a class="link" href="db.html" title="Chapter 2. The Db Handle">Db</a> handle explicitly, it will be closed when
the environment handle that owns the <a class="link" href="db.html" title="Chapter 2. The Db Handle">Db</a> handle is closed.
</p>
<p>
The <code class="methodname">Db::close()</code> <span>
<span>
method either returns a non-zero error value or throws an
exception that encapsulates a non-zero error value on
failure, and returns 0 on success.
</span>
</span>
The error values that <code class="methodname">Db::close()</code> method returns include the error values of <code class="methodname">Dbc::close()</code> and the following:
</p>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp3734048"></a><span>DbDeadlockException or </span>DB_LOCK_DEADLOCK</h4>
</div>
</div>
</div>
<p>
A transactional database environment operation was selected to resolve
a deadlock.
</p>
<p>
<a class="xref" href="dbdeadlock.html" title="DbDeadlockException">DbDeadlockException</a> is thrown if
your Berkeley DB API is configured to throw exceptions.
Otherwise, <code class="literal">DB_LOCK_DEADLOCK</code> is returned.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp2491512"></a><span>DbLockNotGrantedException or </span>DB_LOCK_NOTGRANTED</h4>
</div>
</div>
</div>
<p>
A Berkeley DB Concurrent Data Store database environment configured
for lock timeouts was unable to grant a lock in the allowed time.
</p>
<p>
You attempted to open a database handle that is configured
for no waiting exclusive locking, but the exclusive lock could not be
immediately obtained. See
<a class="xref" href="dbset_lk_exclusive.html" title="Db::set_lk_exclusive()">Db::set_lk_exclusive()</a>
for more information.
</p>
<p>
<a class="xref" href="dblocknotgranted.html" title="DbLockNotGrantedException">DbLockNotGrantedException</a> is thrown if
your Berkeley DB API is configured to throw exceptions.
Otherwise, <code class="literal">DB_LOCK_NOTGRANTED</code> is returned.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp2411120"></a>EINVAL</h4>
</div>
</div>
</div>
<p>
If the cursor is already closed; or if an invalid flag value or parameter was specified.
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp2080096"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp1872976"></a>flags</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>flags</strong></span> parameter must be set to 0
or be set to the following value:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p><a id="dbclose_DB_NOSYNC"></a>
<code class="literal">DB_NOSYNC</code>
</p>
<p>
Do not flush cached information to disk. This flag is a
dangerous option. It should be set only if the application is doing
logging (with transactions) so that the database is recoverable after
a system or application crash, or if the database is always generated
from scratch after any system or application crash.
</p>
<p>
<span class="bold"><strong>It is important to understand that flushing
cached information to disk only minimizes the window of opportunity
for corrupted data.</strong></span> Although unlikely, it is possible for
database corruption to happen if a system or application crash occurs
while writing data to the database. To ensure that database
corruption never occurs, applications must either: use transactions
and logging with automatic recovery; use logging and
application-specific recovery; or edit a copy of the database, and
once all applications using the database have successfully called
<code class="methodname">Db::close()</code>, atomically replace the original database with the
updated copy.
</p>
<p>
Note that this flag only works when the database
has been opened using an environment.
</p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp2046584"></a>Errors</h3>
</div>
</div>
</div>
<p>
The <code class="methodname">Db::close()</code> <span>
<span>
method may fail and throw a <a class="link" href="dbexception.html" title="Chapter 6. The DbException Class">DbException</a>
exception, encapsulating one of the following non-zero errors, or 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="idp1982528"></a>EINVAL</h4>
</div>
</div>
</div>
<p>
An invalid flag value or parameter was specified.
</p>
</div>
<p>
The error messages returned for the first error encountered when <code class="methodname">Db::close()</code> method closes any open cursors include:
</p>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp957072"></a><span>DbDeadlockException or </span>DB_LOCK_DEADLOCK</h4>
</div>
</div>
</div>
<p>
A transactional database environment operation was selected to resolve
a deadlock.
</p>
<p>
<a class="xref" href="dbdeadlock.html" title="DbDeadlockException">DbDeadlockException</a> is thrown if
your Berkeley DB API is configured to throw exceptions.
Otherwise, <code class="literal">DB_LOCK_DEADLOCK</code> is returned.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp1043208"></a><span>DbLockNotGrantedException or </span>DB_LOCK_NOTGRANTED</h4>
</div>
</div>
</div>
<p>
A Berkeley DB Concurrent Data Store database environment configured
for lock timeouts was unable to grant a lock in the allowed time.
</p>
<p>
You attempted to open a database handle that is configured
for no waiting exclusive locking, but the exclusive lock could not be
immediately obtained. See
<a class="xref" href="dbset_lk_exclusive.html" title="Db::set_lk_exclusive()">Db::set_lk_exclusive()</a>
for more information.
</p>
<p>
<a class="xref" href="dblocknotgranted.html" title="DbLockNotGrantedException">DbLockNotGrantedException</a> is thrown if
your Berkeley DB API is configured to throw exceptions.
Otherwise, <code class="literal">DB_LOCK_NOTGRANTED</code> is returned.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp3690800"></a>EINVAL</h4>
</div>
</div>
</div>
<p>
If the cursor is already closed; or if 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="idp1040496"></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="idp84192"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="db.html#dblist" title="Database and Related Methods">Database 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="dbassociate_foreign.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="db.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="dbcompact.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">Db::associate_foreign() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> Db::compact()</td>
</tr>
</table>
</div>
</body>
</html>
|
