release/man3/dbopen.3

   1 .\" Copyright (c) 1990, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)dbopen.3    8.5 (Berkeley) 1/2/94
  33 .\"
  34 .\"*******************************************************************
  35 .\"
  36 .\" This file was generated with po4a. Translate the source file.
  37 .\"
  38 .\"*******************************************************************
  39 .TH DBOPEN 3 1994\-01\-02 "" "Linux Programmer's Manual"
  40 .UC 7
  41 .SH 名前
  42 dbopen \- データベースアクセスメソッド
  43 .SH 書式
  44 .nf
  45 \fB#include <sys/types.h>\fP
  46 \fB#include <limits.h>\fP
  47 \fB#include <db.h>\fP
  48
  49 \fBDB *dbopen(const char *\fP\fIfile\fP\fB, int \fP\fIflags\fP\fB, int \fP\fImode\fP\fB, DBTYPE \fP\fItype\fP\fB,\fP
  50 \fB           const void *\fP\fIopeninfo\fP\fB);\fP
  51 .fi
  52 .SH 説明
  53 \fBdbopen\fP()  はデータベースファイルに対するライブラリインターフェースである。 サポートされているファイルフォーマットは btree,
  54 hash, UNIX ファイルに指向したフォーマット, の 3 つである。 btree フォーマットは、ソートされたバランスツリー構造である。
  55 hashed フォーマットは、拡張可能な動的 hash スキームである。 フラットファイル (flat\-file) フォーマットは、
  56 固定長/可変長のレコードからなるバイトストリームファイルである。 それぞれのフォーマットと、ファイルフォーマットに特有の情報は
  57 それぞれ対応するマニュアルページ \fBbtree\fP(3), \fBhash\fP(3), \fBrecno\fP(3)  に詳細に記述されている。
  58 .PP
  59 \fBdbopen\fP()  は \fIfile\fP を読み込み (読み書き) するためにオープンする。 \fIfile\fP 引き数を NULL にすれば、
  60 ディスク上に保存したくないファイルを作ることもできる。
  61 .PP
  62 .\"Three additional options may be specified by ORing
  63 .\"them into the
  64 .\".I flags
  65 .\"argument.
  66 .\".TP
  67 .\"DB_LOCK
  68 .\"Do the necessary locking in the database to support concurrent access.
  69 .\"If concurrent access isn't needed or the database is read-only this
  70 .\"flag should not be set, as it tends to have an associated performance
  71 .\"penalty.
  72 .\".TP
  73 .\"DB_SHMEM
  74 .\"Place the underlying memory pool used by the database in shared
  75 .\"memory.
  76 .\"Necessary for concurrent access.
  77 .\".TP
  78 .\"DB_TXN
  79 .\"Support transactions in the database.
  80 .\"The DB_LOCK and DB_SHMEM flags must be set as well.
  81 \fIflags\fP と \fImode\fP 引き数は \fBopen\fP(2)  ルーチンで指定するのと同様である。ただし 意味を持つフラグは
  82 \fBO_CREAT\fP, \fBO_EXCL\fP, \fBO_EXLOCK\fP, \fBO_NONBLOCK\fP, \fBO_RDONLY\fP, \fBO_RDWR\fP,
  83 \fBO_SHLOCK\fP, \fBO_TRUNC\fP だけである。 (注意: \fBO_WRONLY\fP でデータベースファイルを開く事は出来ない)
  84 .PP
  85 \fItype\fP 引き数は \fIDBTYPE\fP 型である (インクルードファイル \fI<db.h>\fP で定義されている)。
  86 \fBDB_BTREE\fP, \fBDB_HASH\fP, \fBDB_RECNO\fP のいずれかをセットできる。
  87 .PP
  88 \fIopeninfo\fP 引き数はアクセスメソッドに固有な構造体へのポインタである。 それぞれの構造体に関しては各アクセスメソッドの
  89 マニュアルページに記述されている。 \fIopeninfo\fP が NULL の場合、それぞれのアクセスメソッドとシステムとに適合した
  90 デフォルトが用いられる。
  91 .PP
  92 \fBdbopen\fP()  は、成功した場合 \fIDB\fP 構造体へのポインタを、エラーの場合 NULL を返す。 \fIDB\fP 構造体は
  93 \fI<db.h>\fP インクルードファイルの中で定義されており、 少なくとも以下のようなフィールドを持っている。
  94 .sp
  95 .in +4n
  96 .nf
  97 typedef struct {
  98     DBTYPE type;
  99     int (*close)(const DB *db);
 100     int (*del)(const DB *db, const DBT *key, unsigned int flags);
 101     int (*fd)(const DB *db);
 102     int (*get)(const DB *db, DBT *key, DBT *data,
 103                unsigned int flags);
 104     int (*put)(const DB *db, DBT *key, const DBT *data,
 105                unsigned int flags);
 106     int (*sync)(const DB *db, unsigned int flags);
 107     int (*seq)(const DB *db, DBT *key, DBT *data,
 108                unsigned int flags);
 109 } DB;
 110 .fi
 111 .in
 112 .PP
 113 各要素には、データベースのタイプと、 様々な動作をする関数のセットが記述されている。 これらの関数は \fBdbopen\fP()
 114 によって返される構造体へのポインタを引き数にとる。 キー/データ構造体へのポインタやフラグ値を取るものもある。
 115 .TP
 116 \fItype\fP
 117 用いられているアクセスメソッド (とファイルフォーマット) の型。
 118 .TP
 119 \fIclose\fP
 120 キャッシュされた情報をディスクに掃きだすためのルーチンへのポインタ。 割り当てられたリソースを解放し、利用したファイル(群)をクローズする。
 121 キー/データ対がメモリにキャッシュされている場合、 \fIclose\fP や \fIsync\fP
 122 関数での同期に失敗すると、情報に矛盾が生じるか情報を失う可能性がある。 \fIclose\fP ルーチンはエラーの場合 \-1 を返し (\fIerrno\fP
 123 をセットする)、成功すると 0 を返す。
 124 .TP
 125 \fIdel\fP
 126 データベースからキー/データ対を削除するルーチンへのポインタ。
 127 .IP
 128 \fIflag\fP 引き数は次の値がセットできる。
 129 .RS
 130 .TP
 131 \fBR_CURSOR\fP
 132 カーソル (cursor) が参照しているレコードを削除する。 カーソルは前もって初期化されていなくてはならない。
 133 .RE
 134 .IP
 135 \fIdelete\fP ルーチンはエラーの場合 \-1 を返し (\fIerrno\fP をセットする)、成功すると 0 を返す。また指定の \fIkey\fP
 136 がファイル中に無い場合 1 を返す。
 137 .TP
 138 \fIfd\fP
 139 用いているデータベースのファイルデスクリプタを返すルーチン へのポインタ。 同じファイル名 \fIfile\fP で \fBdbopen\fP()
 140 を呼び出した全てのプロセスに対して、 そのファイルを示す単一のファイルデスクリプタが返される。 このファイルデスクリプタはロック関数
 141 \fBfcntl\fP(2)  と \fBflock\fP(2)  への引き数として安全に使用できる。 このファイルデスクリプタは、必ずしもアクセスメソッドで
 142 用いられているファイルのいずれかに関連づけられていなくても良い。 メモリ内のデータベースにはファイルデスクリプタは無い。 \fIfd\fP
 143 ルーチンはエラーの場合 \-1 を返し (\fIerrno\fP をセットする)、成功するとファイルデスクリプタを返す。
 144 .TP
 145 \fIget\fP
 146 データベースからキーを用いてデータを取り出すための ルーチンへのポインタ。 指定した \fIkey\fP に関連づけられたデータのアドレスと長さが
 147 \fIdata\fP が参照する構造体に返される。 \fIget\fP ルーチンはエラーの場合 \-1 を返し (\fIerrno\fP をセットする)、成功すると 0
 148 を返す。また \fIkey\fP がファイル中に無い場合 1 を返す。
 149 .TP
 150 \fIput\fP
 151 キー/データ対をデータベースに納めるルーチンへのポインタ。
 152 .IP
 153 \fIflag\fP 引き数には次の値のうちのどれか一つがセットできる。
 154 .RS
 155 .TP
 156 \fBR_CURSOR\fP
 157 カーソルが参照しているキー/データ対を置き換える。 カーソルは前もって初期化されている必要がある。
 158 .TP
 159 \fBR_IAFTER\fP
 160 \fIkey\fP で参照されるデータの直後に、 新しいキー/データ対を作ってデータを追加する。 追加されたキー/データ対のレコード番号は \fIkey\fP
 161 構造体に返される。 (\fBDB_RECNO\fP アクセス方法でのみ使える。)
 162 .TP
 163 \fBR_IBEFORE\fP
 164 \fIkey\fP で参照されるデータの直前に、 新しいキー/データ対を作ってデータを挿入する。 追加されたキー/データ対のレコード番号は \fIkey\fP
 165 構造体に返される。 (\fBDB_RECNO\fP アクセスメソッドでのみ使える。)
 166 .TP
 167 \fBR_NOOVERWRITE\fP
 168 キーがあらかじめ存在しない場合に限り、新しいキー/データ対をいれる。
 169 .TP
 170 \fBR_SETCURSOR\fP
 171 キー/データ対を納め、それを指すようにカーソル位置をセットあるいは初期 化する。 (\fBDB_BTREE\fP と \fBDB_RECNO\fP
 172 アクセスメソッドでのみ使える。)
 173 .RE
 174 .IP
 175 \fBR_SETCURSOR\fP は \fBDB_BTREE\fP と \fBDB_RECNO\fP アクセスメソッドでしか利用できない。 なぜなら
 176 \fBR_SETCURSOR\fP を用いるには、変更される事の無い固有の順序をキー が持っていなければならないからである。
 177 .IP
 178 \fBR_IAFTER\fP と \fBR_IBEFORE\fP は \fBDB_RECNO\fP アクセスメソッドでしか利用できない。
 179 これらを実現するには、アクセスメソッドが 新しいキーを作れなければならないからである。 これが成立するのは、例えば、順序づけらた独立なレコード番号が
 180 キーになっているような場合だけである。
 181 .IP
 182 \fIput\fP ルーチンのデフォルトの動作は、新しいキー/データ対を 既に存在するキーを置き換える事て格納する動作である。
 183 .IP
 184 \fIput\fP ルーチンはエラーの場合 \-1 を返し (\fIerrno\fP をセットする)、成功すると 0 を返す。また \fIflag\fP に
 185 \fBR_NOOVERWRITE\fP がセットされていてキーが既に存在する場合 1 を返す。
 186 .TP
 187 \fIseq\fP
 188 データベースからシーケンシャルにデータを取り出すための ルーチンへのポインタ。 キーのアドレスと長さが \fIkey\fP
 189 が参照する構造体に返される。データのアドレスと長さが \fIdata\fP が参照する構造体に返される。
 190 .IP
 191 シーケンシャルなキー/データ対の取得はいつでも行える。また 「カーソル」の位置は \fIdel\fP, \fIget\fP, \fIput\fP, \fIsync\fP
 192 ルーチンの呼び出しには影響されない。 シーケンシャルなスキャンの途中に行われたデータベースへの変更は
 193 スキャンに反映される。すなわち、カーソルの後ろに挿入されたレコードは 返されないが、カーソルの前に挿入されたレコードは返される。
 194 .IP
 195 フラグ値には\fB必ず\fP以下に示すうちの どれか一つをセットしなければならない。
 196 .RS
 197 .TP
 198 \fBR_CURSOR\fP
 199 指定したキーに関連づけられたデータが返される。 \fIget\fP ルーチンとの違いは、カーソルがキーの位置にセットあるいは 初期化される点である。 (注意:
 200 \fBDB_BTREE\fP アクセス方法では、返されたキーが 必ずしも指定したキーに正しくマッチしないかもしれない。
 201 返されたキーは、指定されたキーに等しいかより大きいもののうち 最小のものになる (部分キーマッチか範囲検索が許可されている場合)。)
 202 .TP
 203 \fBR_FIRST\fP
 204 データベースの最初のキー/データ対が返される。 カーソルはそれを参照するようにセットまたは初期化される。
 205 .TP
 206 \fBR_LAST\fP
 207 データベースの最後のキー/データ対が返される。カーソルはそれを参照する ようにセットまたは初期化される。 (\fBDB_BTREE\fP と
 208 \fBDB_RECNO\fP アクセスメソッドだけで使える。)
 209 .TP
 210 \fBR_NEXT\fP
 211 カーソル直後のキー/データ対を取得する。 カーソルがセットされていない場合は \fBR_FIRST\fP フラグと同じ。
 212 .TP
 213 \fBR_PREV\fP
 214 カーソル直前のキー/データ対を取得する。 カーソルがセットされていない場合は \fBR_LAST\fP フラグと同じ。 (\fBDB_BTREE\fP と
 215 \fBDB_RECNO\fP アクセスメソッドだけで使える。)
 216 .RE
 217 .IP
 218 \fBR_LAST\fP と \fBR_PREV\fP は、 \fBDB_BTREE\fP と \fBDB_RECNO\fP アクセス方法でしか使えない。 なぜなら
 219 \fBR_SETCURSOR\fP を用いるには、変更される事の無い固有の順序をキーが持っていなければならないからである。
 220 .IP
 221 \fIseq\fP ルーチンはエラーの場合 \-1 を返し (\fIerrno\fP をセットする)、 成功の場合 0 を返す。
 222 指定したキーやカレントキーよりも大きい/小さいキー/データ対がない場合は 1 を返す。 \fBDB_RECNO\fP アクセスメソッドを使っていて、
 223 かつデータベースファイルが文字型のスペシャルファイルで、 完成しているキー/データ対が無い場合には、 \fIseq\fP ルーチンは 2 を返す。
 224 .TP
 225 \fIsync\fP
 226 キャッシュされた情報をディスクに掃き出すルーチンへのポインタ。 データベースがメモリの中だけにある場合、 \fIsync\fP
 227 ルーチンは何の効果もなく常に成功する。
 228 .IP
 229 flag には以下の値がセットできる。
 230 .RS
 231 .TP
 232 \fBR_RECNOSYNC\fP
 233 \fBDB_RECNO\fP アクセスメソッドを使っている場合に このフラグをセットすると、 recno ファイルそのものにではなく、 そのベースになっている
 234 btree ファイルに sync が行われる。 (詳細は \fBrecno\fP(3)  マニュアルページで \fIbfname\fP
 235 フィールドを説明している部分を参照のこと。)
 236 .RE
 237 .IP
 238 \fIsync\fP ルーチンはエラーの場合 \-1 を返し (\fIerrno\fP をセットする)、成功すると 0 を返す。
 239 .SS キー/データ対
 240 全てのファイルタイプにおいて、 キー/データ対をベースにしてアクセスが行われる。 キーとデータのいずれも、次のデータ構造で記述される。
 241 .in +4n
 242 .nf
 243
 244 typedef struct {
 245     void  *data;
 246     size_t size;
 247 } DBT;
 248 .fi
 249 .in
 250 .PP
 251 \fIDBT\fP 構造体の各要素は次のように定義されている。
 252 .TP
 253 \fIdata\fP
 254 バイト文字列へのポインタ。
 255 .TP
 256 \fIsize\fP
 257 バイト文字列の長さ。
 258 .PP
 259 キーとデータのバイト文字列は、 基本的には無制限の長さの文字列を参照できるが、 しかしいずれも使用可能なメモリに収まっていなくてはならない。
 260 アクセスメソッドはバイト文字列のアラインメントについては 何も保証していない事に注意すること。
 261 .SH エラー
 262 \fBdbopen\fP()  ルーチンは失敗するとライブラリルーチン \fBopen\fP(2)  と \fBmalloc\fP(3)  で指定されているエラーに応じた
 263 \fIerrno\fP をセットする。あるいは以下をセットする。
 264 .TP
 265 \fB[EFTYPE]\fP
 266 ファイルが正しくフォーマットされていない。
 267 .TP
 268 \fBEINVAL\fP
 269 指定したパラメータ(ハッシュ関数、バイト埋めなど)が現在のファイル仕様に 合っていない、パラメータが関数にとって無意味
 270 (例えばあらかじめ初期化しないでカーソルを使うとか)、 ファイルとソフトウェアのバージョンが合っていない。
 271 .PP
 272 \fIclose\fP ルーチンは失敗するとライブラリルーチン \fBclose\fP(2), \fBread\fP(2), \fBwrite\fP(2),
 273 \fBfree\fP(3), \fBfsync\fP(2)  で指定されているエラーに応じた \fIerrno\fP をセットする。
 274 .PP
 275 \fIdel\fP, \fIget\fP, \fIput\fP と \fIseq\fP ルーチンは失敗するとライブラリルーチン \fBread\fP(2), \fBwrite\fP(2),
 276 \fBfree\fP(3), \fBmalloc\fP(3)  で指定されているエラーに応じた \fIerrno\fP をセットする。
 277 .PP
 278 \fIfd\fP ルーチンはメモリ内データベースに対し失敗すると \fIerrno\fP に \fBENOENT\fP をセットする。
 279 .PP
 280 \fIsync\fP ルーチンは失敗するとライブラリルーチン \fBfsync\fP(2)  で指定されているエラーに応じた \fIerrno\fP をセットする。
 281 .SH バグ
 282 typedef \fIDBT\fP は \*(lqdata base thang\*(rqの略語であるが、これが使われているのは、
 283 まだ使われていない妥当な名前が思い付かなかったためである。
 284 .PP
 285 ファイルデスクリプタを使ったやりとりはひどい代物であり、 将来のバージョンでは削除されるだろう。
 286 .PP
 287 どのアクセスメソッドも、同時アクセス、ロック、トランザクション の仕組みは備えていない。
 288 .SH 関連項目
 289 \fBbtree\fP(3), \fBhash\fP(3), \fBmpool\fP(3), \fBrecno\fP(3)
 290 .sp
 291 \fILIBTP: Portable, Modular Transactions for UNIX\fP, Margo Seltzer, Michael
 292 Olson, USENIX proceedings, Winter 1992.