File: dbopen.3

package info (click to toggle)
manpages-ja 0.4.0.0.20020315-2
  • links: PTS
  • area: main
  • in suites: woody
  • size: 14,808 kB
  • ctags: 4
  • sloc: sh: 9,595; perl: 157; makefile: 62
file content (475 lines) | stat: -rw-r--r-- 13,412 bytes parent folder | download | duplicates (2)
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
.\" Copyright (c) 1990, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	@(#)dbopen.3	8.5 (Berkeley) 1/2/94
.\"
.\" Japanese Version Copyright (c) 1999 Shouichi Saito
.\"	all rights reserved.
.\" Translated Thu Jul 22 00:00:00 JST 1999
.\"	by Shouichi Saito <ss236rx@ymg.urban.ne.jp>
.\" Proofed Tue Aug 19 1999 by NAKANO Takeo <nakano@apm.seikei.ac.jp>
.\"
.\"WORD:	descriptor	ǥץ
.TH DBOPEN 3 1994-01-02 
.UC 7
.SH ̾
dbopen \- ǡ١᥽å
.SH 
.nf
.ft B
#include <sys/types.h>
#include <limits.h>
#include <db.h>

DB *
dbopen(const char *file, int flags, int mode, DBTYPE type,
.ti +5
const void *openinfo);
.ft R
.fi
.SH 
.IR dbopen
ϥǡ١եФ饤֥ꥤ󥿡եǤ롣
ݡȤƤեեޥåȤ btree, hash,
UNIX ե˻ظեޥå,  3 ĤǤ롣
btree եޥåȤϡȤ줿Х󥹥ĥ꡼¤Ǥ롣
hashed եޥåȤϡĥǽưŪ hash Ǥ롣
եåȥե (flat-file) եޥåȤϡ
Ĺ/ĹΥ쥳ɤʤХȥȥ꡼եǤ롣
줾ΥեޥåȤȡեեޥåȤͭξ
줾бޥ˥奢ڡ
.IR btree (3),
.IR hash (3),
.IR recno (3)
˾ܺ٤˵ҤƤ롣
.PP
dbopen 
.I file
ɤ߹ (ɤ߽) 뤿˥ץ󤹤롣
file ѥ᡼ NULL ˤС
ǥ¸ʤե뤳ȤǤ롣
.PP
.I flags

.I mode

.IR open (2)
롼ǻꤹΤƱͤǤ롣 
O_CREAT, O_EXCL, O_EXLOCK, O_NONBLOCK,
O_RDONLY, O_RDWR, O_SHLOCK  O_TRUNC ե饰̣ġ
(: O_WRONLY ǥǡ١ե򳫤Ͻʤ)
.\"Three additional options may be specified by
.\".IR or 'ing
.\"them into the
.\".I flags
.\"argument.
.\".TP
.\"DB_LOCK
.\"Do the necessary locking in the database to support concurrent access.
.\"If concurrent access isn't needed or the database is read-only this
.\"flag should not be set, as it tends to have an associated performance
.\"penalty.
.\".TP
.\"DB_SHMEM
.\"Place the underlying memory pool used by the database in shared
.\"memory.
.\"Necessary for concurrent access.
.\".TP
.\"DB_TXN
.\"Support transactions in the database.
.\"The DB_LOCK and DB_SHMEM flags must be set as well.
.PP
.I type
 DBTYPE Ǥ (󥯥롼ɥե <db.h> Ƥ)
DB_BTREE, DB_HASH, DB_RECNO Τ줫򥻥åȤǤ롣
.PP
.I openinfo
ϥ᥽åɤ˸ͭʹ¤ΤؤΥݥ󥿤Ǥ롣
줾ι¤Τ˴ؤƤϳƥ᥽åɤ
ޥ˥奢ڡ˵ҤƤ롣
.I openinfo
 NULL ξ硢줾Υ᥽åɤȥƥȤŬ礷
ǥեȤѤ롣
.PP
.I dbopen
ϡ DB ¤ΤؤΥݥ󥿤򡢥顼ξ NULL ֤
DB ¤Τ <db.h> 󥯥롼ɥեƤꡢ
ʤȤʲΤ褦ʥեɤäƤ롣
.sp
.nf
typedef struct {
.RS
DBTYPE type;
int (*close)(const DB *db);
int (*del)(const DB *db, const DBT *key, u_int flags);
int (*fd)(const DB *db);
int (*get)(const DB *db, DBT *key, DBT *data, u_int flags);
int (*put)(const DB *db, DBT *key, const DBT *data,
.ti +5
u_int flags);
int (*sync)(const DB *db, u_int flags);
int (*seq)(const DB *db, DBT *key, DBT *data, u_int flags);
.RE
} DB;
.fi
.PP
Ǥˤϡǡ١Υפȡ
͡ư򤹤ؿΥåȤҤƤ롣
δؿ
.I dbopen
ˤä֤빽¤ΤؤΥݥ󥿤ˤȤ롣
/ǡ¤ΤؤΥݥ󥿤ե饰ͤΤ⤢롣
.TP
type
ѤƤ륢᥽å (ȥեեޥå) η
.TP
close
å夵줿ǥݤΥ롼ؤΥݥ󥿡
Ƥ줿꥽Ѥե()򥯥롣
/ǡФ˥å夵Ƥ硢
.I close

.I sync
ؿǤƱ˼Ԥȡ̷⤬뤫򼺤ǽ롣
.I close
롼ϥ顼ξ \-1 ֤
.RI ( errno
򥻥åȤ) 0 ֤
.TP
del
ǡ١饭/ǡФ롼ؤΥݥ󥿡
.IP
.I flag
ϼͤåȤǤ롣
.RS
.TP
R_CURSOR
 (cursor) ȤƤ쥳ɤ롣
äƽƤʤƤϤʤʤ
.RE
.IP
.I delete
롼ϥ顼ξ \-1 ֤
.RI ( errno
򥻥åȤ) 0 ֤ޤ
.I key
ե̵ 1 ֤
.TP
fd
ѤƤǡ١Υեǥץ֤롼
ؤΥݥ󥿡
Ʊ
.I file
̾
.I dbopen
ƤӽФƤΥץФơ
Υե򼨤ñΥեǥץ֤롣
Υեǥץϥåؿ
.IR fcntl (2)

.IR flock (2)
ؤΰȤư˻ѤǤ롣
Υեǥץϡɬ⥢᥽åɤ
ѤƤեΤ줫˴ϢŤƤʤƤɤ
Υǡ١ˤϥեǥץ̵
.I fd
롼ϥ顼ξ \-1 ֤
.RI ( errno
򥻥åȤ)ȥեǥץ֤
.TP
get
ǡ١饭ѤƥǡФ
롼ؤΥݥ󥿡
.I key
˴ϢŤ줿ǡΥɥ쥹Ĺ
.I data
Ȥ빽¤Τ֤롣
.I get
롼ϥ顼ξ \-1 ֤
.RI ( errno
򥻥åȤ) 0 ֤ޤ
.I key
ե̵ 1 ֤
.TP
put
/ǡФǡ١Ǽ롼ؤΥݥ󥿡
.IP
.I flag
ˤϼͤΤΤɤ줫ĤåȤǤ롣
.RS
.TP
R_CURSOR
뤬ȤƤ륭/ǡФ֤롣
äƽƤɬפ롣
.TP
R_IAFTER
.I key
ǻȤǡľˡ
/ǡФäƥǡɲä롣
ɲä줿/ǡФΥ쥳ֹ
.I key
¤Τ֤롣
(DB_RECNO ˡǤΤ߻Ȥ롣)
.TP
R_IBEFORE
.I key
ǻȤǡľˡ
/ǡФäƥǡ롣
ɲä줿/ǡФΥ쥳ֹ
.I key
¤Τ֤롣
(DB_RECNO ᥽åɤǤΤ߻Ȥ롣)
.TP
R_NOOVERWRITE
餫¸ߤʤ˸¤ꡢ/ǡФ򤤤롣
.TP
R_SETCURSOR
/ǡФǼᡢؤ褦˥֤򥻥åȤ뤤Ͻ
롣(DB_BTREE  DB_RECNO ᥽åɤǤΤ߻Ȥ롣)
.RE
.IP
R_SETCURSOR  DB_BTREE  DB_RECNO ᥽åɤǤѤǤʤ
ʤʤ R_SETCURSOR Ѥˤϡѹ̵ͭν򥭡
äƤʤФʤʤǤ롣
.IP
R_IAFTER  R_IBEFORE  DB_RECNO ᥽åɤǤѤǤʤ
¸ˤϡ᥽åɤ
ʤФʤʤǤ롣
줬ΩΤϡ㤨СŤ餿Ωʥ쥳ֹ椬
ˤʤäƤ褦ʾǤ롣
.IP
.I put
롼ΥǥեȤưϡ/ǡФ
¸ߤ륭֤ƳǼưǤ롣
.IP
.I put
롼ϥ顼ξ \-1 ֤
.RI ( errno
򥻥åȤ) 0 ֤ޤ R_NOOVERWRITE
.I ե饰
åȤƤƥ¸ߤ 1 ֤
.TP
seq
ǡ١饷󥷥˥ǡФ
롼ؤΥݥ󥿡
Υɥ쥹Ĺ
.I key
Ȥ빽¤Τ֤롣ǡΥɥ쥹Ĺ
.I data
Ȥ빽¤Τ֤롣
.IP
󥷥ʥ/ǡФμϤĤǤԤ롣ޤ
֥פΰ֤
.IR del ,
.IR get ,
.IR put ,
.I sync
롼θƤӽФˤϱƶʤ
󥷥ʥ˹Ԥ줿ǡ١ؤѹ
ȿǤ롣ʤθ줿쥳ɤ
֤ʤ줿쥳ɤ֤롣
.IP
ե饰ͤˤ\fBɬ\fPʲ˼
ɤ줫Ĥ򥻥åȤʤФʤʤ
.RS
.TP
R_CURSOR
ꤷ˴ϢŤ줿ǡ֤롣
.I get
롼Ȥΰ㤤ϡ뤬ΰ֤˥åȤ뤤
Ǥ롣
(: DB_BTREE ˡǤϡ֤줿
ɬꤷޥåʤ⤷ʤ
֤줿ϡꤵ줿礭ΤΤ
ǾΤΤˤʤ
(ʬޥåϰϸĤƤ))
.TP
R_FIRST
ǡ١κǽΥ/ǡФ֤롣
Ϥ򻲾Ȥ褦˥åȤޤϽ롣
.TP
R_LAST
ǡ١κǸΥ/ǡФ֤롣Ϥ򻲾Ȥ
褦˥åȤޤϽ롣
(DB_BTREE  DB_RECNO ᥽åɤǻȤ롣)
.TP
R_NEXT
ľΥ/ǡФ롣
뤬åȤƤʤ R_FIRST ե饰Ʊ
.TP
R_PREV
ľΥ/ǡФ롣
뤬åȤƤʤ R_LAST ե饰Ʊ
(DB_BTREE  DB_RECNO ᥽åɤǻȤ롣)
.RE
.IP
R_LAST  R_PREV ϡDB_BTREE  DB_RECNO ˡǤȤʤ
ʤʤ R_SETCURSOR Ѥˤϡѹ̵ͭν򥭡
äƤʤФʤʤǤ롣
.IP
.I seq
롼ϥ顼ξ \-1 ֤
.RI ( errno
򥻥åȤ)
ξ 0 ֤
ꤷ䥫ȥ礭//ǡФʤ
1 ֤
DB_RECNO ᥽åɤȤäƤơ
ĥǡ١ե뤬ʸΥڥեǡ
Ƥ륭/ǡФ̵ˤϡ
.I seq
롼 2 ֤
.TP
sync
å夵줿ǥݤФ롼ؤΥݥ󥿡
ǡ١ˤ硢
.I sync
롼ϲθ̤ʤ롣
.IP
flag ˤϰʲͤåȤǤ롣
.RS
.TP
R_RECNOSYNC
DB_RECNO ᥽åɤȤäƤ
Υե饰򥻥åȤȡ
recno ե뤽ΤΤˤǤϤʤ
Υ١ˤʤäƤ btree ե sync Ԥ롣
(ܺ٤
.IR recno (3)
ޥ˥奢ڡ
.I bfname
եɤƤʬ򻲾ȤΤȡ)
.RE
.IP
.I sync
롼ϥ顼ξ \-1 ֤
.RI ( errno
򥻥åȤ) 0 ֤
.SH /ǡ
ƤΥե륿פˤơ
/ǡФ١ˤƥԤ롣
ȥǡΤ⡢Υǡ¤ǵҤ롣
.PP
typedef struct {
.RS
void *data;
.br
size_t size;
.RE
} DBT;
.PP
DBT ¤ΤγǤϼΤ褦Ƥ롣
.TP
data
ХʸؤΥݥ󥿡
.TP
size
ХʸĹ
.PP
ȥǡΥХʸϡ
Ūˤ̵¤Ĺʸ򻲾ȤǤ뤬
Ѳǽʥ˼ޤäƤʤƤϤʤʤ
᥽åɤϥХʸΥ饤ȤˤĤƤ
ݾڤƤʤդ뤳ȡ
.SH 顼
.I dbopen
롼ϼԤȥ饤֥롼
.IR open (2)

.IR malloc (3)
ǻꤵƤ륨顼˱
.I errno
򥻥åȤ롣뤤ϰʲ򥻥åȤ롣
.TP
[EFTYPE]
ե뤬եޥåȤƤʤ
.TP
[EINVAL]
ꤷѥ᡼(ϥåؿХʤ)ߤΥեͤ
äƤʤѥ᡼ؿˤȤạ̵̈
(㤨Ф餫ʤǥȤȤ)
եȥեȥΥС󤬹äƤʤ
.PP
.I close
롼ϼԤȥ饤֥롼
.IR close (2),
.IR read (2),
.IR write (2),
.IR free (3),
.IR fsync (2)
ǻꤵƤ륨顼˱
.I errno
򥻥åȤ롣
.PP
.IR del ,
.IR get ,
.I put

.I seq
롼ϼԤȥ饤֥롼
.IR read (2),
.IR write (2),
.IR free (3),
.IR malloc (3)
ǻꤵƤ륨顼˱
.I errno
򥻥åȤ롣
.PP
.I fd
롼ϥǡ١ФԤ
.I errno
 ENOENT 򥻥åȤ롣
.PP
.I sync
롼ϼԤȥ饤֥롼
.IR fsync (2)
ǻꤵƤ륨顼˱
.I errno
򥻥åȤ롣
.SH Ϣ
.IR btree (3),
.IR hash (3),
.IR mpool (3),
.IR recno (3)
.sp
.IR "LIBTP: Portable, Modular Transactions for UNIX" ,
Margo Seltzer, Michael Olson, USENIX proceedings, Winter 1992.
.SH Х
typedef DBT  ``data base thang''άǤ뤬
줬ȤƤΤϡ
ޤȤƤʤ̾פդʤäǤ롣
.PP
եǥץȤäȤϤҤɤʪǤꡢ
ΥСǤϺ
.PP
ɤΥ᥽åɤ⡢Ʊåȥ󥶥
λȤߤƤʤ