summaryrefslogtreecommitdiff
path: root/db/docs/gsg/JAVA/index.html
blob: 19c6ddde88b9a552c605b0c25b6e787262ac9f1d (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="ISO-8859-1" 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=ISO-8859-1" />
    <title>Getting Started with Berkeley DB</title>
    <link rel="stylesheet" href="gettingStarted.css" type="text/css" />
    <meta name="generator" content="DocBook XSL Stylesheets V1.62.4" />
    <link rel="home" href="index.html" title="Getting Started with Berkeley DB" />
    <link rel="next" href="preface.html" title="Preface" />
  </head>
  <body>
    <div class="navheader">
      <table width="100%" summary="Navigation header">
        <tr>
          <th colspan="3" align="center">Getting Started with Berkeley DB</th>
        </tr>
        <tr>
          <td width="20%" align="left"> </td>
          <th width="60%" align="center"> </th>
          <td width="20%" align="right"> <a accesskey="n" href="preface.html">Next</a></td>
        </tr>
      </table>
      <hr />
    </div>
    <div class="book" lang="en" xml:lang="en">
      <div class="titlepage">
        <div>
          <div>
            <h1 class="title"><a id="id2766488"></a>Getting Started with Berkeley DB</h1>
          </div>
          <div>
            <div class="legalnotice">
              <p class="legalnotice-title">
                <b>Legal Notice</b>
              </p>
              <p>
        This documentation is distributed under the terms of the Sleepycat
        public license. You may review the terms of this license at:
         <a href="http://www.sleepycat.com/download/oslicense.html" target="_top">http://www.sleepycat.com/download/oslicense.html</a>
    </p>
              <p>
      Sleepycat Software, Berkeley DB, Berkeley DB XML and the Sleepycat logo
      are trademarks or service marks of Sleepycat Software, Inc. All rights to
      these marks are reserved.  No third-party use is permitted without the
      express prior written consent of Sleepycat Software, Inc.
    </p>
              <p>
        <span class="trademark">Java</span>&#8482; and all Java-based marks are a trademark
        or registered trademark of Sun Microsystems,
        Inc, in the United States and other countries.
    </p>
              <p>
        To obtain a copy of this document's original source code, please write
        to <tt class="email">&lt;<a href="mailto:support@sleepycat.com">support@sleepycat.com</a>&gt;</tt>.
    </p>
            </div>
          </div>
          <div>
            <p class="pubdate">9/22/2004</p>
          </div>
        </div>
        <div></div>
        <hr />
      </div>
      <div class="toc">
        <p>
          <b>Table of Contents</b>
        </p>
        <dl>
          <dt>
            <span class="preface">
              <a href="preface.html">Preface</a>
            </span>
          </dt>
          <dd>
            <dl>
              <dt>
                <span class="sect1">
                  <a href="preface.html#conventions">Conventions Used in this Book</a>
                </span>
              </dt>
            </dl>
          </dd>
          <dt>
            <span class="chapter">
              <a href="introduction.html">1. Introduction to Berkeley DB </a>
            </span>
          </dt>
          <dd>
            <dl>
              <dt>
                <span class="sect1">
                  <a href="introduction.html#aboutthismanual">About This Manual</a>
                </span>
              </dt>
              <dt>
                <span class="sect1">
                  <a href="concepts.html">Berkeley DB Concepts</a>
                </span>
              </dt>
              <dt>
                <span class="sect1">
                  <a href="accessmethods.html">Access Methods</a>
                </span>
              </dt>
              <dd>
                <dl>
                  <dt>
                    <span class="sect2">
                      <a href="accessmethods.html#selectAM">Selecting Access Methods</a>
                    </span>
                  </dt>
                  <dt>
                    <span class="sect2">
                      <a href="accessmethods.html#BTreeVSHash">Choosing between BTree and Hash</a>
                    </span>
                  </dt>
                  <dt>
                    <span class="sect2">
                      <a href="accessmethods.html#QueueVSRecno">Choosing between Queue and Recno</a>
                    </span>
                  </dt>
                </dl>
              </dd>
              <dt>
                <span class="sect1">
                  <a href="databaseLimits.html">Database Limits and Portability</a>
                </span>
              </dt>
              <dt>
                <span class="sect1">
                  <a href="environments.html">Environments</a>
                </span>
              </dt>
              <dt>
                <span class="sect1">
                  <a href="coreExceptions.html">Exception Handling</a>
                </span>
              </dt>
              <dt>
                <span class="sect1">
                  <a href="returns.html">Error Returns</a>
                </span>
              </dt>
              <dt>
                <span class="sect1">
                  <a href="gettingit.html">Getting and Using DB </a>
                </span>
              </dt>
            </dl>
          </dd>
          <dt>
            <span class="chapter">
              <a href="DB.html">2. Databases</a>
            </span>
          </dt>
          <dd>
            <dl>
              <dt>
                <span class="sect1">
                  <a href="DB.html#DBOpen">Opening Databases</a>
                </span>
              </dt>
              <dt>
                <span class="sect1">
                  <a href="coredbclose.html">Closing Databases</a>
                </span>
              </dt>
              <dt>
                <span class="sect1">
                  <a href="db_config.html">Database Properties</a>
                </span>
              </dt>
              <dt>
                <span class="sect1">
                  <a href="DBAdmin.html">Administrative Methods</a>
                </span>
              </dt>
              <dt>
                <span class="sect1">
                  <a href="dbErrorReporting.html">Error Reporting Functions</a>
                </span>
              </dt>
              <dt>
                <span class="sect1">
                  <a href="CoreEnvUsage.html">Managing Databases in Environments</a>
                </span>
              </dt>
              <dt>
                <span class="sect1">
                  <a href="CoreJavaUsage.html">Database Example</a>
                </span>
              </dt>
            </dl>
          </dd>
          <dt>
            <span class="chapter">
              <a href="DBEntry.html">3. Database Records</a>
            </span>
          </dt>
          <dd>
            <dl>
              <dt>
                <span class="sect1">
                  <a href="DBEntry.html#usingDbEntry">Using Database Records</a>
                </span>
              </dt>
              <dt>
                <span class="sect1">
                  <a href="usingDbt.html">Reading and Writing Database Records</a>
                </span>
              </dt>
              <dd>
                <dl>
                  <dt>
                    <span class="sect2">
                      <a href="usingDbt.html#databaseWrite">Writing Records to the Database</a>
                    </span>
                  </dt>
                  <dt>
                    <span class="sect2">
                      <a href="usingDbt.html#databaseRead">Getting Records from the Database</a>
                    </span>
                  </dt>
                  <dt>
                    <span class="sect2">
                      <a href="usingDbt.html#recordDelete">Deleting Records</a>
                    </span>
                  </dt>
                  <dt>
                    <span class="sect2">
                      <a href="usingDbt.html#datapersist">Data Persistence</a>
                    </span>
                  </dt>
                </dl>
              </dd>
              <dt>
                <span class="sect1">
                  <a href="bindAPI.html">Using the BIND APIs</a>
                </span>
              </dt>
              <dd>
                <dl>
                  <dt>
                    <span class="sect2">
                      <a href="bindAPI.html#bindPrimitive">Numerical and String Objects</a>
                    </span>
                  </dt>
                  <dt>
                    <span class="sect2">
                      <a href="bindAPI.html#object2dbt">Serializeable Complex Objects</a>
                    </span>
                  </dt>
                  <dt>
                    <span class="sect2">
                      <a href="bindAPI.html#customTuple">Custom Tuple Bindings</a>
                    </span>
                  </dt>
                </dl>
              </dd>
              <dt>
                <span class="sect1">
                  <a href="dbtJavaUsage.html">Database Usage Example</a>
                </span>
              </dt>
            </dl>
          </dd>
          <dt>
            <span class="chapter">
              <a href="Cursors.html">4. Using Cursors</a>
            </span>
          </dt>
          <dd>
            <dl>
              <dt>
                <span class="sect1">
                  <a href="Cursors.html#openCursor">Opening and Closing Cursors</a>
                </span>
              </dt>
              <dt>
                <span class="sect1">
                  <a href="Positioning.html">Getting Records Using the Cursor</a>
                </span>
              </dt>
              <dd>
                <dl>
                  <dt>
                    <span class="sect2">
                      <a href="Positioning.html#cursorsearch">Searching for Records</a>
                    </span>
                  </dt>
                  <dt>
                    <span class="sect2">
                      <a href="Positioning.html#getdups">Working with Duplicate Records</a>
                    </span>
                  </dt>
                </dl>
              </dd>
              <dt>
                <span class="sect1">
                  <a href="PutEntryWCursor.html">Putting Records Using Cursors</a>
                </span>
              </dt>
              <dt>
                <span class="sect1">
                  <a href="DeleteEntryWCursor.html">Deleting Records Using Cursors</a>
                </span>
              </dt>
              <dt>
                <span class="sect1">
                  <a href="ReplacingEntryWCursor.html">Replacing Records Using Cursors</a>
                </span>
              </dt>
              <dt>
                <span class="sect1">
                  <a href="cursorJavaUsage.html">Cursor Example</a>
                </span>
              </dt>
            </dl>
          </dd>
          <dt>
            <span class="chapter">
              <a href="indexes.html">5. Secondary Databases</a>
            </span>
          </dt>
          <dd>
            <dl>
              <dt>
                <span class="sect1">
                  <a href="indexes.html#DbAssociate">Opening and Closing Secondary Databases</a>
                </span>
              </dt>
              <dt>
                <span class="sect1">
                  <a href="keyCreator.html">Implementing Key 
        Creators
        
        </a>
                </span>
              </dt>
              <dt>
                <span class="sect1">
                  <a href="secondaryProps.html">Secondary Database Properties</a>
                </span>
              </dt>
              <dt>
                <span class="sect1">
                  <a href="readSecondary.html">Reading Secondary Databases</a>
                </span>
              </dt>
              <dt>
                <span class="sect1">
                  <a href="secondaryDelete.html">Deleting Secondary Database Records</a>
                </span>
              </dt>
              <dt>
                <span class="sect1">
                  <a href="secondaryCursor.html">
        Using Secondary Cursors
        
    </a>
                </span>
              </dt>
              <dt>
                <span class="sect1">
                  <a href="joins.html">Database Joins</a>
                </span>
              </dt>
              <dd>
                <dl>
                  <dt>
                    <span class="sect2">
                      <a href="joins.html#joinUsage">Using Join Cursors</a>
                    </span>
                  </dt>
                  <dt>
                    <span class="sect2">
                      <a href="joins.html#joinconfig">JoinCursor Properties</a>
                    </span>
                  </dt>
                </dl>
              </dd>
              <dt>
                <span class="sect1">
                  <a href="javaindexusage.html">Secondary Database Example</a>
                </span>
              </dt>
              <dd>
                <dl>
                  <dt>
                    <span class="sect2">
                      <a href="javaindexusage.html#secondaryMyDbs">Opening Secondary Databases with MyDbs</a>
                    </span>
                  </dt>
                  <dt>
                    <span class="sect2">
                      <a href="javaindexusage.html#exampleReadJavaSecondaries">Using Secondary Databases with ExampleDatabaseRead</a>
                    </span>
                  </dt>
                </dl>
              </dd>
            </dl>
          </dd>
          <dt>
            <span class="chapter">
              <a href="dbconfig.html">6. Database Configuration</a>
            </span>
          </dt>
          <dd>
            <dl>
              <dt>
                <span class="sect1">
                  <a href="dbconfig.html#pagesize">Setting the Page Size</a>
                </span>
              </dt>
              <dd>
                <dl>
                  <dt>
                    <span class="sect2">
                      <a href="dbconfig.html#overflowpages">Overflow Pages</a>
                    </span>
                  </dt>
                  <dt>
                    <span class="sect2">
                      <a href="dbconfig.html#Locking">Locking</a>
                    </span>
                  </dt>
                  <dt>
                    <span class="sect2">
                      <a href="dbconfig.html#IOEfficiency">IO Efficiency</a>
                    </span>
                  </dt>
                  <dt>
                    <span class="sect2">
                      <a href="dbconfig.html#pagesizeAdvice">Page Sizing Advice</a>
                    </span>
                  </dt>
                </dl>
              </dd>
              <dt>
                <span class="sect1">
                  <a href="cachesize.html">Selecting the Cache Size</a>
                </span>
              </dt>
              <dt>
                <span class="sect1">
                  <a href="btree.html">BTree Configuration</a>
                </span>
              </dt>
              <dd>
                <dl>
                  <dt>
                    <span class="sect2">
                      <a href="btree.html#duplicateRecords">Allowing Duplicate Records</a>
                    </span>
                  </dt>
                  <dt>
                    <span class="sect2">
                      <a href="btree.html#comparators">Setting Comparison Functions</a>
                    </span>
                  </dt>
                </dl>
              </dd>
            </dl>
          </dd>
        </dl>
      </div>
      <div class="list-of-examples">
        <p>
          <b>List of Examples</b>
        </p>
        <dl>
          <dt>2.1. <a href="CoreJavaUsage.html#MyDb">MyDbs Class</a></dt>
          <dt>3.1. <a href="dbtJavaUsage.html#inventoryjava">Inventory.java</a></dt>
          <dt>3.2. <a href="dbtJavaUsage.html#vendorjava">Vendor.java</a></dt>
          <dt>3.3. <a href="dbtJavaUsage.html#InventoryJavaBinding">InventoryBinding.java</a></dt>
          <dt>3.4. <a href="dbtJavaUsage.html#dbsStoredClass">Stored Class Catalog Management with MyDbs</a></dt>
          <dt>3.5. <a href="dbtJavaUsage.html#EDL">ExampleDatabaseLoad.java</a></dt>
          <dt>4.1. <a href="cursorJavaUsage.html#EDR"> ExampleDatabaseRead.java</a></dt>
          <dt>5.1. <a href="javaindexusage.html#ItemNameKeyCreator-Java">ItemNameKeyCreator.java</a></dt>
          <dt>5.2. <a href="javaindexusage.html#mydbsSecondary">SecondaryDatabase Management with MyDbs</a></dt>
          <dt>5.3. <a href="javaindexusage.html#secondaryWithEDR">SecondaryDatabase usage with ExampleDatabaseRead</a></dt>
        </dl>
      </div>
    </div>
    <div class="navfooter">
      <hr />
      <table width="100%" summary="Navigation footer">
        <tr>
          <td width="40%" align="left"> </td>
          <td width="20%" align="center"> </td>
          <td width="40%" align="right"> <a accesskey="n" href="preface.html">Next</a></td>
        </tr>
        <tr>
          <td width="40%" align="left" valign="top"> </td>
          <td width="20%" align="center"> </td>
          <td width="40%" align="right" valign="top"> Preface</td>
        </tr>
      </table>
    </div>
  </body>
</html>