File: db_map.html

package info (click to toggle)
db5.3 5.3.28%2Bdfsg1-0.8
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 158,400 kB
  • sloc: ansic: 448,406; java: 111,824; tcl: 80,544; sh: 44,326; cs: 33,697; cpp: 21,604; perl: 14,557; xml: 10,799; makefile: 4,077; javascript: 1,998; yacc: 1,003; awk: 965; sql: 801; erlang: 342; python: 216; php: 24; asm: 14
file content (540 lines) | stat: -rw-r--r-- 19,331 bytes parent folder | download | duplicates (8)
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
<?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>Chapter 5.  Db_map</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++ Standard Template Library API Reference" />
    <link rel="up" href="index.html" title="Berkeley DB C++ Standard Template Library API Reference" />
    <link rel="prev" href="stldb_vectorclear.html" title="clear" />
    <link rel="next" href="stldb_mapdstr_db_map.html" title="~db_map" />
  </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">Chapter 5. 
 Db_map  </th>
        </tr>
        <tr>
          <td width="20%" align="left"><a accesskey="p" href="stldb_vectorclear.html">Prev</a> </td>
          <th width="60%" align="center"> </th>
          <td width="20%" align="right"> <a accesskey="n" href="stldb_mapdstr_db_map.html">Next</a></td>
        </tr>
      </table>
      <hr />
    </div>
    <div class="chapter" lang="en" xml:lang="en">
      <div class="titlepage">
        <div>
          <div>
            <h2 class="title"><a id="db_map"></a>Chapter 5. 
 Db_map  </h2>
          </div>
        </div>
      </div>
      <p><a class="link" href="db_map.html" title="Chapter 5.  Db_map">db_map</a>
 has identical methods to std::map and the semantics for each method is identical to its std::map counterpart, except that it stores data into underlying Berkeley DB btree or hash database. </p>
      <p>Passing a database handle of btree or hash type creates a <a class="link" href="db_map.html" title="Chapter 5.  Db_map">db_map</a>
 equivalent to std::map and std::hashmap respectively. Database(dbp) and environment(penv) handle requirement(applies to all constructors in this class template): 0. The dbp is opened inside the penv environment. Either one of the two handles can be NULL. If dbp is NULL, an anonymous database is created by dbstl. 1. Database type of dbp should be DB_BTREE or DB_HASH. 2. No DB_DUP or DB_DUPSORT flag set in dbp. 3. No DB_RECNUM flag set in dbp. 4. No DB_TRUNCATE specified in dbp's database open flags. 5. DB_THREAD must be set if you are sharing the dbp across multiple threads directly, or indirectly by sharing the container object across multiple threads. </p>
      <h4><a id="idp50214528"></a>
See Also
</h4>
      <p> </p>
      <p><a class="link" href="db_container.html" title="Chapter 3.  Db_container">db_container</a>
 <a class="link" href="stldb_containerdb_container.html" title="db_container">db_container(Db*, DbEnv*)</a>
 <a class="link" href="stldb_containerdb_container.html" title="db_container">db_container(const db_container&amp;)</a>
 </p>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="idp50349832"></a>
Class Template Parameters</h3>
            </div>
          </div>
        </div>
        <div class="sect3" lang="en" xml:lang="en">
          <div class="titlepage">
            <div>
              <div>
                <h4 class="title"><a id="idp50340488"></a>
kdt</h4>
              </div>
            </div>
          </div>
          <p>The key data type. </p>
        </div>
        <div class="sect3" lang="en" xml:lang="en">
          <div class="titlepage">
            <div>
              <div>
                <h4 class="title"><a id="idp50076336"></a>
ddt</h4>
              </div>
            </div>
          </div>
          <p>The data data type. <a class="link" href="db_map.html" title="Chapter 5.  Db_map">db_map</a>
 stores key/data pairs. </p>
        </div>
        <div class="sect3" lang="en" xml:lang="en">
          <div class="titlepage">
            <div>
              <div>
                <h4 class="title"><a id="idp50350880"></a>
value_type_sub</h4>
              </div>
            </div>
          </div>
          <p>Do not specify anything if ddt type is a class/struct type; Otherwise, specify ElementHolder&lt;ddt&gt; to it. </p>
        </div>
        <div class="sect3" lang="en" xml:lang="en">
          <div class="titlepage">
            <div>
              <div>
                <h4 class="title"><a id="idp50355696"></a>
iterator_t</h4>
              </div>
            </div>
          </div>
          <p>Never specify anything to this type parameter. It is only used internally. </p>
        </div>
      </div>
      <h4><a id="idp50350000"></a> Public Members </h4>
      <div class="informaltable">
        <table border="1" width="80%">
          <colgroup>
            <col />
            <col />
          </colgroup>
          <thead>
            <tr>
              <th>Member</th>
              <th>Description</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <td>
<a class="xref" href="db_map.html#stldb_mapdb_map" title="db_map">db_map</a>
</td>
              <td>
   <p>Create a std::map/hash_map equivalent associative container. </p>        </td>
            </tr>
            <tr>
              <td>
<a class="xref" href="stldb_mapdstr_db_map.html" title="~db_map">~db_map</a>
</td>
              <td>
   </td>
            </tr>
            <tr>
              <td>
<a class="xref" href="stldb_mapinsert.html" title="insert">insert</a>
</td>
              <td>
   <p>Insert a single key/data pair if the key is not in the container. </p>        </td>
            </tr>
            <tr>
              <td>
<a class="xref" href="stldb_mapbegin.html" title="begin">
begin
</a>
</td>
              <td>
   <p>Begin a read-write or readonly iterator which sits on the first key/data pair of the database. </p>        </td>
            </tr>
            <tr>
              <td>
<a class="xref" href="stldb_mapend.html" title="end">end</a>
</td>
              <td>
   <p>Create an open boundary iterator. </p>        </td>
            </tr>
            <tr>
              <td>
<a class="xref" href="stldb_maprbegin.html" title="rbegin">rbegin</a>
</td>
              <td>
   <p>Begin a read-write or readonly reverse iterator which sits on the first key/data pair of the database. </p>        </td>
            </tr>
            <tr>
              <td>
<a class="xref" href="stldb_maprend.html" title="rend">rend</a>
</td>
              <td>
   <p>Create an open boundary iterator. </p>        </td>
            </tr>
            <tr>
              <td>
<a class="xref" href="stldb_mapis_hash.html" title="is_hash">is_hash</a>
</td>
              <td>
   <p>Get container category. </p>        </td>
            </tr>
            <tr>
              <td>
<a class="xref" href="stldb_mapbucket_count.html" title="bucket_count">bucket_count</a>
</td>
              <td>
   <p>Only for std::hash_map, return number of hash bucket in use. </p>        </td>
            </tr>
            <tr>
              <td>
<a class="xref" href="stldb_mapsize.html" title="size">size</a>
</td>
              <td>
   <p>This function supports auto-commit. </p>        </td>
            </tr>
            <tr>
              <td>
<a class="xref" href="stldb_mapmax_size.html" title="max_size">max_size</a>
</td>
              <td>
   <p>Get max size. </p>        </td>
            </tr>
            <tr>
              <td>
<a class="xref" href="stldb_mapempty.html" title="empty">empty</a>
</td>
              <td>
   <p>Returns whether this container is empty. </p>        </td>
            </tr>
            <tr>
              <td>
<a class="xref" href="stldb_maperase.html" title="erase">erase</a>
</td>
              <td>
   <p>Erase a key/data pair at specified position. </p>        </td>
            </tr>
            <tr>
              <td>
<a class="xref" href="stldb_mapfind.html" title="find">find</a>
</td>
              <td>
   <p>Find the key/data pair with specified key x. </p>        </td>
            </tr>
            <tr>
              <td>
<a class="xref" href="stldb_maplower_bound.html" title="lower_bound">lower_bound</a>
</td>
              <td>
   <p>Find the greatest key less than or equal to x. </p>        </td>
            </tr>
            <tr>
              <td>
<a class="xref" href="stldb_mapequal_range.html" title="equal_range">equal_range</a>
</td>
              <td>
   <p>Find the range within which all keys equal to specified key x. </p>        </td>
            </tr>
            <tr>
              <td>
<a class="xref" href="stldb_mapcount.html" title="count">count</a>
</td>
              <td>
   <p>Count the number of key/data pairs having specified key x. </p>        </td>
            </tr>
            <tr>
              <td>
<a class="xref" href="stldb_mapupper_bound.html" title="upper_bound">upper_bound</a>
</td>
              <td>
   <p>Find the least key greater than x. </p>        </td>
            </tr>
            <tr>
              <td>
<a class="xref" href="stldb_mapkey_eq.html" title="key_eq">key_eq</a>
</td>
              <td>
   <p>Function to get key compare functor. </p>        </td>
            </tr>
            <tr>
              <td>
<a class="xref" href="stldb_maphash_funct.html" title="hash_funct">hash_funct</a>
</td>
              <td>
   <p>Function to get hash key generating functor. </p>        </td>
            </tr>
            <tr>
              <td>
<a class="xref" href="stldb_mapvalue_comp.html" title="value_comp">value_comp</a>
</td>
              <td>
   <p>Function to get value compare functor. </p>        </td>
            </tr>
            <tr>
              <td>
<a class="xref" href="stldb_mapkey_comp.html" title="key_comp">key_comp</a>
</td>
              <td>
   <p>Function to get key compare functor. </p>        </td>
            </tr>
            <tr>
              <td>
<a class="xref" href="stldb_mapoperator_assign.html" title="operator=">operator=</a>
</td>
              <td>
   <p>Container content assignment operator. </p>        </td>
            </tr>
            <tr>
              <td>
<a class="xref" href="stldb_mapoperator_sqbrk.html" title="operator[]">operator[]</a>
</td>
              <td>
   <p>Retrieve data element by key. </p>        </td>
            </tr>
            <tr>
              <td>
<a class="xref" href="stldb_mapswap.html" title="swap">swap</a>
</td>
              <td>
   <p>Swap content with container mp. </p>        </td>
            </tr>
            <tr>
              <td>
<a class="xref" href="stldb_mapclear.html" title="clear">clear</a>
</td>
              <td>
   <p>Clear contents in this container. </p>        </td>
            </tr>
            <tr>
              <td>
<a class="xref" href="stldb_mapoperator_eq.html" title="operator==">operator==</a>
</td>
              <td>
   <p>Map content equality comparison operator. </p>        </td>
            </tr>
            <tr>
              <td>
<a class="xref" href="stldb_mapoperator_ueq.html" title="operator!=">operator!=</a>
</td>
              <td>
   <p>Container unequality comparison operator. </p>        </td>
            </tr>
          </tbody>
        </table>
      </div>
      <h4><a id="idp50356336"></a>
Group</h4>
      <p>
<a class="xref" href="dbstl_containers.html" title="Chapter 2.  Dbstl Container Classes">
 Dbstl Container Classes  </a>
</p>
      <p>
</p>
      <div class="sect1" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h2 class="title" style="clear: both"><a id="stldb_mapdb_map"></a>db_map</h2>
            </div>
          </div>
        </div>
        <div class="sect2" lang="en" xml:lang="en">
          <div class="titlepage">
            <div>
              <div>
                <h3 class="title"><a id="stldb_mapdb_map_details"></a>Function Details</h3>
              </div>
            </div>
          </div>
          <pre class="programlisting">
db_map(Db *dbp=NULL,
    DbEnv *envp=NULL)
 </pre>
          <p>Create a std::map/hash_map equivalent associative container. </p>
          <p>See the handle requirement in class details to pass correct database/environment handles. </p>
          <div class="sect3" lang="en" xml:lang="en">
            <div class="titlepage">
              <div>
                <div>
                  <h4 class="title"><a id="idp50362848"></a>Parameters</h4>
                </div>
              </div>
            </div>
            <div class="sect4" lang="en" xml:lang="en">
              <div class="titlepage">
                <div>
                  <div>
                    <h5 class="title"><a id="idp50406304"></a>dbp</h5>
                  </div>
                </div>
              </div>
              <p>The database handle. </p>
            </div>
            <div class="sect4" lang="en" xml:lang="en">
              <div class="titlepage">
                <div>
                  <div>
                    <h5 class="title"><a id="idp50408184"></a>envp</h5>
                  </div>
                </div>
              </div>
              <p>The database environment handle. </p>
            </div>
          </div>
          <div class="sect3" lang="en" xml:lang="en">
            <div class="titlepage">
              <div>
                <div>
                  <h4 class="title"><a id="idp50403968"></a>See Also</h4>
                </div>
              </div>
            </div>
            <p>
    </p>
            <p><a class="link" href="stldb_containerdb_container.html" title="db_container">db_container(Db*, DbEnv*)</a>
 </p>
            <p>
   </p>
          </div>
          <pre class="programlisting">
db_map(Db *dbp, DbEnv *envp, InputIterator first,
    InputIterator last)
 </pre>
          <p>Iteration constructor. </p>
          <p>Iterates between first and last, setting a copy of each of the sequence of elements as the content of the container object. Create a std::map/hash_map equivalent associative container. Insert a range of elements into the database. The range is [first, last), which contains elements that can be converted to type ddt automatically. See the handle requirement in class details to pass correct database/environment handles. This function supports auto-commit. </p>
          <div class="sect3" lang="en" xml:lang="en">
            <div class="titlepage">
              <div>
                <div>
                  <h4 class="title"><a id="idp50362168"></a>Parameters</h4>
                </div>
              </div>
            </div>
            <div class="sect4" lang="en" xml:lang="en">
              <div class="titlepage">
                <div>
                  <div>
                    <h5 class="title"><a id="idp50405104"></a>dbp</h5>
                  </div>
                </div>
              </div>
              <p>The database handle. </p>
            </div>
            <div class="sect4" lang="en" xml:lang="en">
              <div class="titlepage">
                <div>
                  <div>
                    <h5 class="title"><a id="idp50365840"></a>envp</h5>
                  </div>
                </div>
              </div>
              <p>The database environment handle. </p>
            </div>
            <div class="sect4" lang="en" xml:lang="en">
              <div class="titlepage">
                <div>
                  <div>
                    <h5 class="title"><a id="idp50411952"></a>last</h5>
                  </div>
                </div>
              </div>
              <p>The open boundary of the range. </p>
            </div>
            <div class="sect4" lang="en" xml:lang="en">
              <div class="titlepage">
                <div>
                  <div>
                    <h5 class="title"><a id="idp50412272"></a>first</h5>
                  </div>
                </div>
              </div>
              <p>The closed boundary of the range. </p>
            </div>
          </div>
          <div class="sect3" lang="en" xml:lang="en">
            <div class="titlepage">
              <div>
                <div>
                  <h4 class="title"><a id="idp50406032"></a>See Also</h4>
                </div>
              </div>
            </div>
            <p>
    </p>
            <p><a class="link" href="stldb_containerdb_container.html" title="db_container">db_container(Db*, DbEnv*)</a>
 </p>
            <p>
   </p>
          </div>
          <pre class="programlisting">
db_map(const db_map&lt; kdt, ddt, value_type_sub,
    iterator &gt; &amp;x)
 </pre>
          <p>Copy constructor. </p>
          <p>Create an database and insert all key/data pairs in x into this container. x's data members are not copied. This function supports auto-commit. </p>
          <div class="sect3" lang="en" xml:lang="en">
            <div class="titlepage">
              <div>
                <div>
                  <h4 class="title"><a id="idp50406584"></a>Parameters</h4>
                </div>
              </div>
            </div>
            <div class="sect4" lang="en" xml:lang="en">
              <div class="titlepage">
                <div>
                  <div>
                    <h5 class="title"><a id="idp50406776"></a>x</h5>
                  </div>
                </div>
              </div>
              <p>The other container to initialize this container. </p>
            </div>
          </div>
          <div class="sect3" lang="en" xml:lang="en">
            <div class="titlepage">
              <div>
                <div>
                  <h4 class="title"><a id="idp50407616"></a>See Also</h4>
                </div>
              </div>
            </div>
            <p>
    </p>
            <p><a class="link" href="stldb_containerdb_container.html" title="db_container">db_container(const db_container&amp;)</a>
 </p>
            <p>
   </p>
          </div>
        </div>
        <div class="sect2" lang="en" xml:lang="en">
          <div class="titlepage">
            <div>
              <div>
                <h3 class="title"><a id="idp50261584"></a>Class</h3>
              </div>
            </div>
          </div>
          <p>
  <a class="link" href="db_map.html" title="Chapter 5.  Db_map">db_map</a>
     </p>
        </div>
      </div>
    </div>
    <div class="navfooter">
      <hr />
      <table width="100%" summary="Navigation footer">
        <tr>
          <td width="40%" align="left"><a accesskey="p" href="stldb_vectorclear.html">Prev</a> </td>
          <td width="20%" align="center"> </td>
          <td width="40%" align="right"> <a accesskey="n" href="stldb_mapdstr_db_map.html">Next</a></td>
        </tr>
        <tr>
          <td width="40%" align="left" valign="top">clear </td>
          <td width="20%" align="center">
            <a accesskey="h" href="index.html">Home</a>
          </td>
          <td width="40%" align="right" valign="top"> ~db_map</td>
        </tr>
      </table>
    </div>
  </body>
</html>