summaryrefslogtreecommitdiff
path: root/docs/programmer_reference/stl.html
blob: f4f14488647cf0e6efa7ea09b306b54e9833cfae (plain)
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
<?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 7. Standard Template Library API</title>
    <link rel="stylesheet" href="gettingStarted.css" type="text/css" />
    <meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
    <link rel="start" href="index.html" title="Berkeley DB Programmer's Reference Guide" />
    <link rel="up" href="index.html" title="Berkeley DB Programmer's Reference Guide" />
    <link rel="prev" href="csharp.html" title="Chapter 6. C# API" />
    <link rel="next" href="stl_usecase.html" title="Dbstl typical use cases" />
  </head>
  <body>
    <div xmlns="" class="navheader">
      <div class="libver">
        <p>Library Version 12.1.6.1</p>
      </div>
      <table width="100%" summary="Navigation header">
        <tr>
          <th colspan="3" align="center">Chapter 7. Standard Template Library API</th>
        </tr>
        <tr>
          <td width="20%" align="left"><a accesskey="p" href="csharp.html">Prev</a> </td>
          <th width="60%" align="center"> </th>
          <td width="20%" align="right"> <a accesskey="n" href="stl_usecase.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="stl"></a>Chapter 7. Standard Template Library API</h2>
          </div>
        </div>
      </div>
      <div class="toc">
        <p>
          <b>Table of Contents</b>
        </p>
        <dl>
          <dt>
            <span class="sect1">
              <a href="stl.html#stl_intro">Dbstl introduction</a>
            </span>
          </dt>
          <dd>
            <dl>
              <dt>
                <span class="sect2">
                  <a href="stl.html#stl_intro_stdcompat">Standards compatible</a>
                </span>
              </dt>
              <dt>
                <span class="sect2">
                  <a href="stl.html#stl_intro_performance">Performance
            overhead</a>
                </span>
              </dt>
              <dt>
                <span class="sect2">
                  <a href="stl.html#stl_intro_portability">Portability</a>
                </span>
              </dt>
            </dl>
          </dd>
          <dt>
            <span class="sect1">
              <a href="stl_usecase.html">Dbstl typical use cases</a>
            </span>
          </dt>
          <dt>
            <span class="sect1">
              <a href="stl_examples.html">Dbstl examples</a>
            </span>
          </dt>
          <dt>
            <span class="sect1">
              <a href="stl_db_usage.html">Berkeley DB configuration</a>
            </span>
          </dt>
          <dd>
            <dl>
              <dt>
                <span class="sect2">
                  <a href="stl_db_usage.html#idp756272">Registering database and environment handles</a>
                </span>
              </dt>
              <dt>
                <span class="sect2">
                  <a href="stl_db_usage.html#idp772680">Truncate requirements</a>
                </span>
              </dt>
              <dt>
                <span class="sect2">
                  <a href="stl_db_usage.html#idp773680">Auto commit support</a>
                </span>
              </dt>
              <dt>
                <span class="sect2">
                  <a href="stl_db_usage.html#idp792728">Database and environment identity checks</a>
                </span>
              </dt>
              <dt>
                <span class="sect2">
                  <a href="stl_db_usage.html#idp795408">Products, constructors and configurations</a>
                </span>
              </dt>
            </dl>
          </dd>
          <dt>
            <span class="sect1">
              <a href="stl_db_advanced_usage.html">Using advanced Berkeley DB
        features with dbstl</a>
            </span>
          </dt>
          <dd>
            <dl>
              <dt>
                <span class="sect2">
                  <a href="stl_db_advanced_usage.html#idp672128">Using bulk retrieval iterators</a>
                </span>
              </dt>
              <dt>
                <span class="sect2">
                  <a href="stl_db_advanced_usage.html#idp794736">Using the DB_RMW flag</a>
                </span>
              </dt>
              <dt>
                <span class="sect2">
                  <a href="stl_db_advanced_usage.html#idp773392">Using secondary index database and secondary containers</a>
                </span>
              </dt>
            </dl>
          </dd>
          <dt>
            <span class="sect1">
              <a href="stl_txn_usage.html">Using transactions in dbstl</a>
            </span>
          </dt>
          <dt>
            <span class="sect1">
              <a href="stl_mt_usage.html">Using dbstl in multithreaded
        applications</a>
            </span>
          </dt>
          <dt>
            <span class="sect1">
              <a href="stl_primitive_rw.html">Working with primitive types </a>
            </span>
          </dt>
          <dd>
            <dl>
              <dt>
                <span class="sect2">
                  <a href="stl_primitive_rw.html#idp849056">Storing strings</a>
                </span>
              </dt>
            </dl>
          </dd>
          <dt>
            <span class="sect1">
              <a href="stl_complex_rw.html">Store and Retrieve data or
        objects of complex types </a>
            </span>
          </dt>
          <dd>
            <dl>
              <dt>
                <span class="sect2">
                  <a href="stl_complex_rw.html#idp808056">Storing varying length objects</a>
                </span>
              </dt>
              <dt>
                <span class="sect2">
                  <a href="stl_complex_rw.html#idp859120">Storing arbitrary sequences</a>
                </span>
              </dt>
              <dt>
                <span class="sect2">
                  <a href="stl_complex_rw.html#idp909008">Notes</a>
                </span>
              </dt>
            </dl>
          </dd>
          <dt>
            <span class="sect1">
              <a href="stl_persistence.html">Dbstl persistence</a>
            </span>
          </dt>
          <dd>
            <dl>
              <dt>
                <span class="sect2">
                  <a href="stl_persistence.html#directdbget">Direct database get</a>
                </span>
              </dt>
              <dt>
                <span class="sect2">
                  <a href="stl_persistence.html#chg_persistence">Change persistence</a>
                </span>
              </dt>
              <dt>
                <span class="sect2">
                  <a href="stl_persistence.html#obj_life_persistence">Object life time and persistence </a>
                </span>
              </dt>
            </dl>
          </dd>
          <dt>
            <span class="sect1">
              <a href="stl_container_specific.html">Dbstl container specific
        notes</a>
            </span>
          </dt>
          <dd>
            <dl>
              <dt>
                <span class="sect2">
                  <a href="stl_container_specific.html#idp873704">db_vector specific notes</a>
                </span>
              </dt>
              <dt>
                <span class="sect2">
                  <a href="stl_container_specific.html#idp948648">Associative container specific notes</a>
                </span>
              </dt>
            </dl>
          </dd>
          <dt>
            <span class="sect1">
              <a href="stl_efficienct_use.html">Using dbstl
        efficiently</a>
            </span>
          </dt>
          <dd>
            <dl>
              <dt>
                <span class="sect2">
                  <a href="stl_efficienct_use.html#idp915608">Using iterators efficiently</a>
                </span>
              </dt>
              <dt>
                <span class="sect2">
                  <a href="stl_efficienct_use.html#idp957584">Using containers efficiently</a>
                </span>
              </dt>
            </dl>
          </dd>
          <dt>
            <span class="sect1">
              <a href="stl_memory_mgmt.html">Dbstl memory management</a>
            </span>
          </dt>
          <dd>
            <dl>
              <dt>
                <span class="sect2">
                  <a href="stl_memory_mgmt.html#idp952296">Freeing memory</a>
                </span>
              </dt>
              <dt>
                <span class="sect2">
                  <a href="stl_memory_mgmt.html#idp994336">Type specific notes</a>
                </span>
              </dt>
            </dl>
          </dd>
          <dt>
            <span class="sect1">
              <a href="stl_misc.html">Dbstl miscellaneous notes</a>
            </span>
          </dt>
          <dd>
            <dl>
              <dt>
                <span class="sect2">
                  <a href="stl_misc.html#idp953048">Special notes about trivial methods</a>
                </span>
              </dt>
              <dt>
                <span class="sect2">
                  <a href="stl_misc.html#idp993208">Using correct container and iterator public
            types</a>
                </span>
              </dt>
            </dl>
          </dd>
          <dt>
            <span class="sect1">
              <a href="stl_known_issues.html">Dbstl known issues</a>
            </span>
          </dt>
        </dl>
      </div>
      <div class="sect1" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h2 class="title" style="clear: both"><a id="stl_intro"></a>Dbstl introduction</h2>
            </div>
          </div>
        </div>
        <div class="toc">
          <dl>
            <dt>
              <span class="sect2">
                <a href="stl.html#stl_intro_stdcompat">Standards compatible</a>
              </span>
            </dt>
            <dt>
              <span class="sect2">
                <a href="stl.html#stl_intro_performance">Performance
            overhead</a>
              </span>
            </dt>
            <dt>
              <span class="sect2">
                <a href="stl.html#stl_intro_portability">Portability</a>
              </span>
            </dt>
          </dl>
        </div>
        <p> 
        Dbstl is a C++ STL style API that provides for Berkeley DB
        usage. It allows for the storage and retrieval of data/objects
        of any type using Berkeley DB databases, but with an interface
        that mimics that of C++ STL containers. Dbstl provides access
        to all of the functionality of Berkeley DB available via this
        STL-style API. 
    </p>
        <p>
        With proper configuration, dbstl is able to store/retrieve
        any complex data types. There is no need to perform repetitive
        marshalling and unmarshalling of data. Dbstl also properly
        manages the life-cycle of all Berkeley DB structures and
        objects. All example methods referred to in this chapter can
        be found in the StlAdvancedFeaturesExample class in the
        $DbSrc/examples/stl/StlAdvancedFeatures.cpp file, and you can
        build the example in $DbSrc/build_unix directory like this:
        make exstl_advancedfeatures, where DbSrc is the source
        directory for Berkeley DB. 
    </p>
        <div class="sect2" lang="en" xml:lang="en">
          <div class="titlepage">
            <div>
              <div>
                <h3 class="title"><a id="stl_intro_stdcompat"></a>Standards compatible</h3>
              </div>
            </div>
          </div>
          <p>
            Dbstl is composed of many container and iterator class
            templates. These containers and iterators correspond
            exactly to each container and iterator available in the
            C++ STL API, including identical sets of methods. This
            allows existing algorithms, functions and
            container-adapters for C++ STL to use dbstl containers
            through its standard iterators. This means that existing
            STL code can manipulate Berkeley DB databases. As a
            result, existing C++ STL code can very easily use dbstl to
            gain persistence and transaction guarantees. 
        </p>
        </div>
        <div class="sect2" lang="en" xml:lang="en">
          <div class="titlepage">
            <div>
              <div>
                <h3 class="title"><a id="stl_intro_performance"></a>Performance
            overhead</h3>
              </div>
            </div>
          </div>
          <p>
            Because dbstl uses C++ template technologies, its
            performance overhead is minimal.
        </p>
          <p>
            The dbstl API performs almost equally to the C API, as
            measured by two different implementations of the TPC-B
            benchmark: <code class="literal">ex_tpcb</code> and
            <code class="literal">exstl_tpcb</code>. 
        </p>
        </div>
        <div class="sect2" lang="en" xml:lang="en">
          <div class="titlepage">
            <div>
              <div>
                <h3 class="title"><a id="stl_intro_portability"></a>Portability</h3>
              </div>
            </div>
          </div>
          <p>
            The degree to which dbstl is portable to a new platform
            is determined by whether Berkeley DB is available on the
            platform, as well as whether an appropriate C++ compiler
            is available on the platform. 
        </p>
          <p> 
            For information on porting Berkeley DB to new
            platforms, see the <em class="citetitle">Berkeley DB Porting Guide</em>. 
        </p>
          <p> 
            Almost all the advanced C++ template features are used
            in dbstl, including:
        </p>
          <div class="itemizedlist">
            <ul type="disc">
              <li>
                <p>
                    member function templates 
                </p>
              </li>
              <li>
                <p> 
                    member function template overloads
                </p>
              </li>
              <li>
                <p> 
                    partial specialization
                </p>
              </li>
              <li>
                <p>
                    default template parameters. 
                </p>
              </li>
            </ul>
          </div>
          <p> 
            For this reason, you need a standards-compatible C++
            compiler to build dbstl. As of this writing, the following
            compilers are known to build dbstl successfully: 
        </p>
          <div class="itemizedlist">
            <ul type="disc">
              <li>
                <p> 
                    MSVC8 
                </p>
              </li>
              <li>
                <p> 
                    gcc3.4.4 and above 
                </p>
              </li>
              <li>
                <p> 
                    Intel C++ 9 and above 
                </p>
              </li>
            </ul>
          </div>
          <p>
            For *nix platforms, if you can successfully configure
            your Berkeley DB build script with
            <code class="literal">--enable-stl</code>, then you should be
            able to successfully build dbstl library and application
            code using it. 
        </p>
          <p>
            Besides its own test suite, dbstl has also been tested
            against, and passes, the following test suites: 
        </p>
          <div class="itemizedlist">
            <ul type="disc">
              <li>
                <p>
                    MS STL test suite 
                </p>
              </li>
              <li>
                <p>
                    SGI STL test suite
                </p>
              </li>
            </ul>
          </div>
        </div>
      </div>
    </div>
    <div class="navfooter">
      <hr />
      <table width="100%" summary="Navigation footer">
        <tr>
          <td width="40%" align="left"><a accesskey="p" href="csharp.html">Prev</a> </td>
          <td width="20%" align="center"> </td>
          <td width="40%" align="right"> <a accesskey="n" href="stl_usecase.html">Next</a></td>
        </tr>
        <tr>
          <td width="40%" align="left" valign="top">Chapter 6. C# API </td>
          <td width="20%" align="center">
            <a accesskey="h" href="index.html">Home</a>
          </td>
          <td width="40%" align="right" valign="top"> Dbstl typical use cases</td>
        </tr>
      </table>
    </div>
  </body>
</html>