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
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
|
<?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::set_flags()</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="dbset_feedback.html" title="Db::set_feedback()" />
<link rel="next" href="dbset_h_compare.html" title="Db::set_h_compare()" />
</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::set_flags()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="dbset_feedback.html">Prev</a> </td>
<th width="60%" align="center">Chapter 2.
The Db Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="dbset_h_compare.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="dbset_flags"></a>Db::set_flags()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include <db_cxx.h>
int
Db::set_flags(u_int32_t flags); </pre>
<p>
Configure a database. Calling <code class="methodname">Db::set_flags()</code> is additive; there is
no way to clear flags.
</p>
<p>
The <code class="methodname">Db::set_flags()</code> method may not be called after the
<a class="xref" href="dbopen.html" title="Db::open()">Db::open()</a> method is called.
</p>
<p>
The <code class="methodname">Db::set_flags()</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>
</p>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp4388176"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp3117432"></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>
<p>
<span class="bold"><strong>General</strong></span>
</p>
<p>
The following flags may be specified for any Berkeley DB access
method:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p><a id="dbset_flags_DB_CHKSUM"></a>
<code class="literal">DB_CHKSUM</code>
</p>
<p>
Do checksum verification of pages read into the cache from the backing
filestore. Berkeley DB uses the SHA1 Secure Hash Algorithm if
encryption is configured and a general hash algorithm if it is not.
</p>
<p>
Calling <code class="methodname">Db::set_flags()</code> with the DB_CHKSUM flag only affects the
specified <a class="link" href="db.html" title="Chapter 2. The Db Handle">Db</a> handle (and
any other Berkeley DB handles opened within the scope of that handle).
</p>
<p>
If the database already exists when <a class="xref" href="dbopen.html" title="Db::open()">Db::open()</a>
is called, the DB_CHKSUM flag will be ignored.
</p>
</li>
<li>
<p><a id="dbset_flags_DB_ENCRYPT"></a>
<code class="literal">DB_ENCRYPT</code>
</p>
<p>
Encrypt the database using the cryptographic password specified to the
<a class="xref" href="envset_encrypt.html" title="DbEnv::set_encrypt()">DbEnv::set_encrypt()</a> or
<a class="xref" href="dbset_encrypt.html" title="Db::set_encrypt()">Db::set_encrypt()</a>
methods.
</p>
<p>
Calling <code class="methodname">Db::set_flags()</code> with the DB_ENCRYPT flag only affects the
specified <a class="link" href="db.html" title="Chapter 2. The Db Handle">Db</a> handle (and
any other Berkeley DB handles opened within the scope of that handle).
</p>
<p>
If the database already exists when <a class="xref" href="dbopen.html" title="Db::open()">Db::open()</a>
is called, the DB_ENCRYPT flag must be the same as the existing database or an error
will be returned.
</p>
<p>
Encrypted databases are not portable between machines of different
byte orders, that is, encrypted databases created on big-endian
machines cannot be read on little-endian machines, and vice versa.
</p>
</li>
<li>
<p><a id="dbset_flags_DB_TXN_NOT_DURABLE"></a>
<code class="literal">DB_TXN_NOT_DURABLE</code>
</p>
<p>
If set, Berkeley DB will not write log records for this database.
This means that updates of this database exhibit the ACI (atomicity,
consistency, and isolation) properties, but not D (durability); that
is, database integrity will be maintained, but if the application or
system fails, integrity will not persist. The database file must be
verified and/or restored from backup after a failure. In order to
ensure integrity after application shut down, the database handles
must be closed without specifying
<a class="link" href="dbclose.html#dbclose_DB_NOSYNC">DB_NOSYNC</a>, or all
database changes must be flushed from the database environment cache
using either the <a class="xref" href="txncheckpoint.html" title="DbEnv::txn_checkpoint()">DbEnv::txn_checkpoint()</a>
or <a class="xref" href="mempsync.html" title="DbEnv::memp_sync()">DbEnv::memp_sync()</a>
methods. All database handles for a single physical file must set
DB_TXN_NOT_DURABLE, including database handles for different databases
in a physical file.
</p>
<p>
Calling <code class="methodname">Db::set_flags()</code>
with the DB_TXN_NOT_DURABLE flag only affects the
specified <a class="link" href="db.html" title="Chapter 2. The Db Handle">Db</a>
handle (and any other Berkeley DB handles opened
within the scope of that handle).
</p>
</li>
</ul>
</div>
<p>
<span class="bold"><strong>Btree</strong></span>
</p>
<p>
The following flags may be specified for the Btree access method:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p><a id="dbset_flags_DB_DUP"></a>
<code class="literal">DB_DUP</code>
</p>
<p>
Permit duplicate data items in the database; that is, insertion when
the key of the key/data pair being inserted already exists in the
database will be successful. The ordering of duplicates in the
database is determined by the order of insertion, unless the ordering
is otherwise specified by use of a cursor operation or a
duplicate sort function.
</p>
<p>
The DB_DUPSORT flag is preferred to DB_DUP for performance reasons.
The DB_DUP flag should only be used by applications wanting to order
duplicate data items manually.
</p>
<p>
Calling <code class="methodname">Db::set_flags()</code>
with the DB_DUP flag affects the database,
including all threads of control accessing the
database.
</p>
<p>
If the database already exists when
<a class="xref" href="dbopen.html" title="Db::open()">Db::open()</a>
is called, the DB_DUP flag must be the same as
the existing database or an error will be
returned.
</p>
<p>
It is an error to specify both DB_DUP and DB_RECNUM.
</p>
</li>
<li>
<p><a id="dbset_flags_DB_DUPSORT"></a>
<code class="literal">DB_DUPSORT</code>
</p>
<p>
Permit duplicate data items in the database; that is, insertion when
the key of the key/data pair being inserted already exists in the
database will be successful. The ordering of duplicates in the
database is determined by the duplicate comparison function. If the
application does not specify a comparison function using the
<a class="xref" href="dbset_dup_compare.html" title="Db::set_dup_compare()">Db::set_dup_compare()</a>
method, a default lexical comparison will be used. It is an error to
specify both DB_DUPSORT and DB_RECNUM.
</p>
<p>
Calling <code class="methodname">Db::set_flags()</code>
with the DB_DUPSORT flag affects the database,
including all threads of control accessing the
database.
</p>
<p>
If the database already exists when
<a class="xref" href="dbopen.html" title="Db::open()">Db::open()</a>
is called, the DB_DUPSORT flag must be the same
as the existing database or an error will be
returned.
</p>
</li>
<li>
<p><a id="dbset_flags_DB_RECNUM"></a>
<code class="literal">DB_RECNUM</code>
</p>
<p>
Support retrieval from the Btree using record numbers. For more
information, see the
<a class="link" href="dbget.html#dbget_DB_SET_RECNO">DB_SET_RECNO</a>
flag to the <a class="xref" href="dbget.html" title="Db::get()">Db::get()</a> and
<a class="xref" href="dbcget.html" title="Dbc::get()">Dbc::get()</a> methods.
</p>
<p>
Logical record numbers in Btree databases are mutable in the face of
record insertion or deletion. See the DB_RENUMBER flag in the Recno
access method information for further discussion.
</p>
<p>
Maintaining record counts within a Btree introduces a serious point of
contention, namely the page locations where the record counts are
stored. In addition, the entire database must be locked during both
insertions and deletions, effectively single-threading the database
for those operations. Specifying DB_RECNUM can result in serious
performance degradation for some applications and data sets.
</p>
<p>
It is an error to specify both DB_DUP and DB_RECNUM.
</p>
<p>
Calling <code class="methodname">Db::set_flags()</code> with the DB_RECNUM flag affects the database,
including all threads of control accessing the database.
</p>
<p>
If the database already exists when <a class="xref" href="dbopen.html" title="Db::open()">Db::open()</a>
is called, the DB_RECNUM flag must be the same as the existing database or an error
will be returned.
</p>
</li>
<li>
<p><a id="dbset_flags_DB_REVSPLITOFF"></a>
<code class="literal">DB_REVSPLITOFF</code>
</p>
<p>
Turn off reverse splitting in the Btree. As pages are emptied in a
database, the Berkeley DB Btree implementation attempts to coalesce
empty pages into higher-level pages in order to keep the database as
small as possible and minimize search time. This can hurt performance
in applications with cyclical data demands; that is, applications
where the database grows and shrinks repeatedly. For example, because
Berkeley DB does page-level locking, the maximum level of concurrency
in a database of two pages is far smaller than that in a database of
100 pages, so a database that has shrunk to a minimal size can cause
severe deadlocking when a new cycle of data insertion begins.
</p>
<p>
Calling <code class="methodname">Db::set_flags()</code>
with the DB_REVSPLITOFF flag only affects the
specified <a class="link" href="db.html" title="Chapter 2. The Db Handle">Db</a>
handle (and any other Berkeley DB handles opened
within the scope of that handle).
</p>
</li>
</ul>
</div>
<p>
<span class="bold"><strong>Hash</strong></span>
</p>
<p>
The following flags may be specified for the Hash access method:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p><a id="dbset_flags_h_DB_DUP"></a>
<code class="literal">DB_DUP</code>
</p>
<p>
Permit duplicate data items in the database; that is, insertion when
the key of the key/data pair being inserted already exists in the
database will be successful. The ordering of duplicates in the
database is determined by the order of insertion, unless the ordering
is otherwise specified by use of a cursor operation.
</p>
<p>
The DB_DUPSORT flag is preferred to DB_DUP for performance reasons.
The DB_DUP flag should only be used by applications wanting to order
duplicate data items manually.
</p>
<p>
Calling <code class="methodname">Db::set_flags()</code> with the DB_DUP flag affects the database,
including all threads of control accessing the database.
</p>
<p>
If the database already exists when <a class="xref" href="dbopen.html" title="Db::open()">Db::open()</a>
is called, the DB_DUP flag must be the same as the existing database or an error will be
returned.
</p>
</li>
<li>
<p>
<code class="literal">DB_DUPSORT</code>
</p>
<p>
Permit duplicate data items in the database; that is, insertion when
the key of the key/data pair being inserted already exists in the
database will be successful. The ordering of duplicates in the
database is determined by the duplicate comparison function. If the
application does not specify a comparison function using the
<a class="xref" href="dbset_dup_compare.html" title="Db::set_dup_compare()">Db::set_dup_compare()</a>
method, a default lexical comparison will be used.
</p>
<p>
Calling <code class="methodname">Db::set_flags()</code> with the DB_DUPSORT flag affects the
database, including all threads of control accessing the database.
</p>
<p>
If the database already exists when <a class="xref" href="dbopen.html" title="Db::open()">Db::open()</a>
is called, the DB_DUPSORT flag must be the same as the existing database or an error
will be returned.
</p>
</li>
<li>
<p><a id="dbset_flags_hash_DB_REVSPLITOFF"></a>
<code class="literal">DB_REVSPLITOFF</code>
</p>
<p>
Turns off hash bucket compaction. When a hash bucket is
emptied, the Berkeley DB Hash implementation will decrease
the hash table size, coalescing buckets. This will
decrease the number of pages in the database.
This can hurt performance in applications with cyclical
data demands — that is, applications where the
database grows and shrinks repeatedly — because of
the cost of resplitting buckets when they grow again.
</p>
<p>
Calling <code class="methodname">Db::set_flags()</code> with the
DB_REVSPLITOFF flag only affects the
specified <a class="link" href="db.html" title="Chapter 2. The Db Handle">Db</a> handle (and
any other Berkeley DB handles opened within the scope of that handle).
</p>
</li>
</ul>
</div>
<p>
<span class="bold"><strong>Queue</strong></span>
</p>
<p>
The following flags may be specified for the Queue access method:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p>
<code class="literal">DB_INORDER</code>
</p>
<p>
The DB_INORDER flag modifies the operation of the
<a class="link" href="dbget.html#dbget_DB_CONSUME">DB_CONSUME</a> or
<a class="link" href="dbget.html#dbget_DB_CONSUME_WAIT">DB_CONSUME_WAIT</a>
flags to <a class="xref" href="dbget.html" title="Db::get()">Db::get()</a> to
return key/data pairs in order. That is, they will always return the
key/data item from the head of the queue.
</p>
<p>
The default behavior of queue databases is optimized for multiple
readers, and does not guarantee that record will be retrieved in the
order they are added to the queue. Specifically, if a writing thread
adds multiple records to an empty queue, reading threads may skip some
of the initial records when the next <a class="xref" href="dbget.html" title="Db::get()">Db::get()</a>
call returns.
</p>
<p>
This flag modifies the <a class="xref" href="dbget.html" title="Db::get()">Db::get()</a>
call to verify that the record being returned is in fact the head of the queue. This will
increase contention and reduce concurrency when there are many reading threads.
</p>
<p>
Calling <code class="methodname">Db::set_flags()</code> with the DB_INORDER flag only affects the
specified <a class="link" href="db.html" title="Chapter 2. The Db Handle">Db</a> handle (and
any other Berkeley DB handles opened within the scope of that handle).
</p>
</li>
</ul>
</div>
<p>
<span class="bold"><strong>Recno</strong></span>
</p>
<p>
The following flags may be specified for the Recno access method:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p><a id="dbset_flags_DB_RENUMBER"></a>
<code class="literal">DB_RENUMBER</code>
</p>
<p>
Specifying the DB_RENUMBER flag causes the logical record numbers to
be mutable, and change as records are added to and deleted from the
database.
</p>
<p>
Using the <a class="xref" href="dbput.html" title="Db::put()">Db::put()</a> or
<a class="xref" href="dbcput.html" title="Dbc::put()">Dbc::put()</a> interfaces
to create new records will cause the creation of multiple records if
the record number is more than one greater than the largest record
currently in the database. For example, creating record 28, when
record 25 was previously the last record in the database, will create
records 26 and 27 as well as 28. Attempts to retrieve records that
were created in this manner will result in an error return of <a href="../../programmer_reference/program_errorret.html#program_errorret.DB_KEYEMPTY" class="olink">DB_KEYEMPTY</a>.
</p>
<p>
If a created record is not at the end of the database, all records
following the new record will be automatically renumbered upward by
one. For example, the creation of a new record numbered 8 causes
records numbered 8 and greater to be renumbered upward by one. If a
cursor was positioned to record number 8 or greater before the
insertion, it will be shifted upward one logical record, continuing to
refer to the same record as it did before.
</p>
<p>
If a deleted record is not at the end of the database, all records
following the removed record will be automatically renumbered downward
by one. For example, deleting the record numbered 8 causes records
numbered 9 and greater to be renumbered downward by one. If a
cursor was positioned to record number 9 or greater before the
removal, it will be shifted downward one logical record, continuing to
refer to the same record as it did before.
</p>
<p>
If a record is deleted, all cursors that were positioned on that record
prior to the removal will no longer be positioned on a valid entry.
This includes cursors used to delete an item. For example, if
a cursor was positioned to record number 8 before the removal of
that record, subsequent calls to <a class="xref" href="dbcget.html" title="Dbc::get()">Dbc::get()</a>
with flags of DB_CURRENT will result in an error return of
<a href="../../programmer_reference/program_errorret.html#program_errorret.DB_KEYEMPTY" class="olink">DB_KEYEMPTY</a>
until the cursor is moved to another record. A call to
<a class="xref" href="dbcget.html" title="Dbc::get()">Dbc::get()</a> with flags of DB_NEXT
will return the new record numbered 8 - which is the record that was
numbered 9 prior to the delete (if such a record existed).
</p>
<p>
For these reasons, concurrent access to a Recno database with the
DB_RENUMBER flag specified may be largely meaningless, although it is
supported.
</p>
<p>
Calling <code class="methodname">Db::set_flags()</code> with the DB_RENUMBER flag affects the
database, including all threads of control accessing the database.
</p>
<p>
If the database already exists when <a class="xref" href="dbopen.html" title="Db::open()">Db::open()</a>
is called, the DB_RENUMBER flag must be the same as the existing database or an error
will be returned.
</p>
</li>
<li>
<p><a id="dbset_flags_DB_SNAPSHOT"></a>
<code class="literal">DB_SNAPSHOT</code>
</p>
<p>
This flag specifies that any specified <span class="bold"><strong>re_source</strong></span> file be read in its entirety when
<a class="xref" href="dbopen.html" title="Db::open()">Db::open()</a> is called. If
this flag is not specified, the <span class="bold"><strong>re_source</strong></span> file may be read lazily.
</p>
<p>
See the <a class="xref" href="dbset_re_source.html" title="Db::set_re_source()">Db::set_re_source()</a>
method for information on the <span class="bold"><strong>re_source</strong></span> file.
</p>
<p>
Calling <code class="methodname">Db::set_flags()</code> with the DB_SNAPSHOT flag only affects the
specified <a class="link" href="db.html" title="Chapter 2. The Db Handle">Db</a> handle (and
any other Berkeley DB handles opened within the scope of that handle).
</p>
</li>
</ul>
</div>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp3305048"></a>Errors</h3>
</div>
</div>
</div>
<p>
The <code class="methodname">Db::set_flags()</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="idm335808"></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="idp5592560"></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="idp5587416"></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="dbset_feedback.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="dbset_h_compare.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">Db::set_feedback() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> Db::set_h_compare()</td>
</tr>
</table>
</div>
</body>
</html>
|
