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
|
<?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 10. Secondary Databases</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="Getting Started with Berkeley DB" />
<link rel="up" href="baseapi.html" title="Part II. Programming with the Base API" />
<link rel="prev" href="cursorJavaUsage.html" title="Cursor Example" />
<link rel="next" href="keyCreator.html" title="Implementing Key Creators" />
</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 10. Secondary Databases</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="cursorJavaUsage.html">Prev</a> </td>
<th width="60%" align="center">Part II. Programming with the Base API</th>
<td width="20%" align="right"> <a accesskey="n" href="keyCreator.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="indexes"></a>Chapter 10. Secondary Databases</h2>
</div>
</div>
</div>
<div class="toc">
<p>
<b>Table of Contents</b>
</p>
<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
<span>Creators</span>
</a>
</span>
</dt>
<dd>
<dl>
<dt>
<span class="sect2">
<a href="keyCreator.html#multikeys">Working with Multiple Keys</a>
</span>
</dt>
</dl>
</dd>
<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">
<span>Using Secondary Cursors</span>
</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>
</div>
<p>
Usually you find database records by means of the record's key. However,
the key that you use for your record will not always contain the
information required to provide you with rapid access to the data that you
want to retrieve. For example, suppose your
<code class="classname">Database</code>
contains records related to users. The key might be a string that is some
unique identifier for the person, such as a user ID. Each record's data,
however, would likely contain a complex object containing details about
people such as names, addresses, phone numbers, and so forth.
While your application may frequently want to query a person by user
ID (that is, by the information stored in the key), it may also on occasion
want to locate people by, say, their name.
</p>
<p>
Rather than iterate through all of the records in your database, examining
each in turn for a given person's name, you create indexes based on names
and then just search that index for the name that you want. You can do this
using secondary databases. In DB, the
<code class="classname">Database</code>
that contains your data is called a
<span class="emphasis"><em>primary database</em></span>. A database that provides an
alternative set of keys to access that data is called a <span class="emphasis"><em>secondary
database</em></span> In a secondary database, the keys are your alternative
(or secondary) index, and the data corresponds to a primary record's key.
</p>
<p>
You create a secondary database by using a <code class="classname">SecondaryConfig</code>
class object to identify an implementation of a
<code class="classname">SecondaryKeyCreator</code>
class object that is used to create keys based on data found in the primary
database. You then pass this <code class="classname">SecondaryConfig</code>
object to the <code class="classname">SecondaryDatabase</code> constructor.
</p>
<p>
Once opened, DB manages secondary databases for you. Adding or deleting
records in your primary database causes DB to update the secondary as
necessary. Further, changing a record's data in the primary database may cause
DB to modify a record in the secondary, depending on whether the change
forces a modification of a key in the secondary database.
</p>
<p>
Note that you can not write directly to a secondary database.
To change the data referenced by a
<code class="classname">SecondaryDatabase</code>
record, modify the primary database instead. The exception to this rule is
that delete operations are allowed on the
<span><code class="classname">SecondaryDatabase</code> object.</span>
See <a class="xref" href="secondaryDelete.html" title="Deleting Secondary Database Records">Deleting Secondary Database Records</a> for more
information.
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
Secondary database records are updated/created by DB
only if the
<span><code class="methodname">SecondaryKeyCreator.createSecondaryKey()</code> method</span>
returns
<span><code class="literal">true</code>.</span>
If
<code class="literal">false</code>
is returned, then DB will not add the key to the secondary database, and
in the event of a record update it will remove any existing key.
</p>
<p>
See <a class="xref" href="keyCreator.html" title="Implementing Key Creators">Implementing Key
<span>Creators</span>
</a> for more
<span>information on this interface and method.</span>
</p>
</div>
<p>
When you read a record from a secondary database, DB automatically
returns
<span>the data and optionally the key</span>
from the corresponding record in the primary database.
</p>
<div class="sect1" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a id="DbAssociate"></a>Opening and Closing Secondary Databases</h2>
</div>
</div>
</div>
<p>
You manage secondary database opens and closes using the
<span>
<code class="classname">SecondaryDatabase</code> constructor.
</span>
Just as is the case with primary databases, you must provide
<span>
the <code class="classname">SecondaryDatabase()</code> constructor
</span>
with the database's
name and, optionally, other properties such as whether duplicate
records are allowed, or whether the secondary database can be created on
open. In addition, you must also provide:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p>A handle to the primary database that this secondary database is
indexing. Note that this means that secondary databases are maintained
only for the specified <code class="classname">Database</code> handle. If you
open the same <code class="classname">Database</code> multiple times for write
(such as might occur when opening a database for read-only and read-write in the same application),
then you should open the <code class="classname">SecondaryDatabase</code> for
each such <code class="classname">Database</code> handle.</p>
</li>
<li>
<p>A <code class="classname">SecondaryConfig</code> object that provides
properties specific to a secondary database. The most important of
these is used to identify the key creator for the database. The key
creator is responsible for generating keys for the secondary database.
See <a class="xref" href="secondaryProps.html" title="Secondary Database Properties">Secondary Database Properties</a> for details.</p>
</li>
</ul>
</div>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
Primary databases <span class="emphasis"><em>must not</em></span> support duplicate records.
Secondary records point to primary records using the primary key, so that key must be unique.
</p>
</div>
<p>So to open (create) a secondary database, you:</p>
<div class="orderedlist">
<ol type="1">
<li>
<p>Open your primary database.</p>
</li>
<li>
<p>Instantiate your key creator.</p>
</li>
<li>
<p>Instantiate your <code class="classname">SecondaryConfig</code> object.</p>
</li>
<li>
<p>Set your key creator object on your <code class="classname">SecondaryConfig</code>
object.</p>
</li>
<li>
<p>Open your secondary database, specifying your primary database
and your <code class="classname">SecondaryConfig</code> at that time.</p>
</li>
</ol>
</div>
<p>For example:</p>
<a id="java_index1"></a>
<pre class="programlisting">package db.GettingStarted;
import com.sleepycat.examples.db.GettingStarted.MyTupleBinding;
import com.sleepycat.bind.tuple.TupleBinding;
import com.sleepycat.db.Database;
import com.sleepycat.db.DatabaseType;
import com.sleepycat.db.DatabaseConfig;
import com.sleepycat.db.DatabaseException;
import com.sleepycat.db.SecondaryDatabase;
import com.sleepycat.db.SecondaryConfig;
import java.io.FileNotFoundException;
...
DatabaseConfig myDbConfig = new DatabaseConfig();
myDbConfig.setAllowCreate(true);
myDbConfig.setType(DatabaseType.BTREE);
SecondaryConfig mySecConfig = new SecondaryConfig();
mySecConfig.setAllowCreate(true);
mySecConfig.setType(DatabaseType.BTREE);
// Duplicates are frequently required for secondary databases.
mySecConfig.setSortedDuplicates(true);
// Open the primary
Database myDb = null;
SecondaryDatabase mySecDb = null;
try {
String dbName = "myPrimaryDatabase";
myDb = new Database(dbName, null, myDbConfig);
// A fake tuple binding that is not actually implemented anywhere.
// The tuple binding is dependent on the data in use.
// Tuple bindings are described earlier in this manual.
TupleBinding myTupleBinding = new MyTupleBinding();
// Open the secondary.
// Key creators are described in the next section.
FullNameKeyCreator keyCreator =
new FullNameKeyCreator(myTupleBinding);
// Get a secondary object and set the key creator on it.
mySecConfig.setKeyCreator(keyCreator);
// Perform the actual open
String secDbName = "mySecondaryDatabase";
mySecDb = new SecondaryDatabase(secDbName, null, myDb, mySecConfig);
} catch (DatabaseException de) {
// Exception handling goes here ...
} catch (FileNotFoundException fnfe) {
// Exception handling goes here ...
}</pre>
<p>To close a secondary database, call its close() method. Note that
for best results, you should close all the secondary databases associated
with a primary database before closing the primary.</p>
<p>For example:</p>
<a id="java_index2"></a>
<pre class="programlisting">try {
if (mySecDb != null) {
mySecDb.close();
}
if (myDb != null) {
myDb.close();
}
} catch (DatabaseException dbe) {
// Exception handling goes here
}</pre>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="cursorJavaUsage.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="baseapi.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="keyCreator.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">Cursor Example </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> Implementing Key
<span>Creators</span>
</td>
</tr>
</table>
</div>
</body>
</html>
|
