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
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="ja" lang="ja">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta name="author" content="Mikio Hirabayashi" />
<meta name="keywords" content="QDBM, Ruby, Depot, Curia, Villa" />
<meta name="description" content="specifications of Ruby API of QDBM" />
<link rel="contents" href="./" />
<link rel="alternate" href="rbspex.html" hreflang="en" title="the English version" />
<link rev="made" href="mailto:mikio@fallabs.com" />
<title>Specifications of QDBM for Ruby (Japanese)</title>
<style type="text/css">html { margin: 0em 0em; padding: 0em 0em; background: #eeeeee none; }
body { margin: 2em 2em; padding: 0em 0em;
background: #eeeeee none; color: #111111;
font-style: normal; font-weight: normal; }
h1 { margin-top: 1.8em; margin-bottom: 1.3em; font-weight: bold; }
h2 { margin-top: 1.8em; margin-bottom: 1.1em; font-weight: bold;
border-left: solid 0.6em #445555; border-bottom: solid 1pt #bbbbbb;
padding: 0.5em 0.5em; width: 60%; }
h3 { margin-top: 1.8em; margin-bottom: 0.8em; font-weight: bold; }
hr { margin-top: 2.5em; margin-bottom: 1.5em; height: 1pt;
color: #999999; background-color: #999999; border: none; }
div.note,div.navi { text-align: right; }
div.logo { text-align: center; margin: 3em 0em; }
div.logo img { border: inset 2pt #ccccdd; }
p { margin: 0.8em 0em; line-height: 140%; }
p,dd { text-indent: 0.8em; }
div,pre { margin-left: 1.7em; margin-right: 1.7em; }
pre { background-color: #ddddee; padding: 0.2em; border: 1pt solid #bbbbcc; font-size: smaller; }
kbd { color: #111111; font-style: normal; font-weight: bold; }
a { color: #0022aa; text-decoration: none; }
a:hover,a:focus { color: #0033ee; text-decoration: underline; }
a.head { color: #111111; text-decoration: none; }
table { padding: 1pt 2pt 1pt 2pt; border: none; margin-left: 1.7em; border-collapse: collapse; }
th { padding: 1pt 4pt 1pt 4pt; border-style: none;
text-align: left; vertical-align: bottom; }
td { padding: 1pt 4pt 1pt 4pt; border: 1pt solid #333333;
text-align: left; vertical-align: top; }
ul,ol,dl { line-height: 140%; }
dt { margin-left: 1.2em; }
dd { margin-left: 2.0em; }
ul.lines { list-style-type: none; }
@media print {
html,body { margin: 0em 0em; background-color: #ffffff; color: #000000; }
h1 { padding: 8em 0em 0.5em 0em; text-align: center; }
h2 { page-break-before: always; }
div.note { text-align: center; }
div.navi,div.logo { display: none }
hr { display: none; }
pre { margin: 0.8em 0.8em; background-color: #ffffff;
border: 1pt solid #aaaaaa; font-size: smaller; }
a,kbd { color: #000000; text-decoration: none; }
h1,h2,h3 { font-family: sans-serif; }
p,div,li,dt,dd { font-family: serif; }
pre,kbd { font-family: monospace; }
dd { font-size: smaller; }
}
</style>
</head>
<body>
<h1>QDBM付属Ruby用API仕様書</h1>
<div class="note">Copyright (C) 2000-2006 Mikio Hirabayashi</div>
<div class="note">Last Update: Thu, 26 Oct 2006 15:00:20 +0900</div>
<div class="navi">[<a href="rbapidoc/index.html">API</a>] [<a href="rbspex.html" hreflang="en">English</a>]</div>
<hr />
<h2>目次</h2>
<ol>
<li><a href="#overview">概要</a></li>
<li><a href="#installation">インストール</a></li>
<li><a href="#examples">サンプルコード</a></li>
<li><a href="#bugs">バグ</a></li>
</ol>
<hr />
<h2><a name="overview" id="overview" class="head">概要</a></h2>
<p>QDBMにはRuby言語用のAPIがある。QDBMの基本APIと拡張APIと上級APIの関数群をRubyのクラス機構を用いてカプセル化したものである。また、Rubyのマルチスレッド機能においてスレッドセーフである。</p>
<p>クラス `Depot' か `Curia' か `Villa' のコンストラクタ `new' を呼び出してデータベースを開き、その戻り値のオブジェクトをハンドルにする。データベースを閉じるにはメソッド `close' を呼ぶ。ファイナライザは利用されないが、`new' のイテレータを用いることでデータベースの閉じ忘れを防ぐことができる。メソッド `put' はレコードを追加するために用いる。メソッド `out' はレコードを削除するために用いる。メソッド `get' はレコードを検索するために用いる。その他にも、C言語のAPIとほぼ同じ操作を利用することができる。各クラスは例外クラス `EANY' およびそのサブクラスを定数として持つ。それらは各メソッドが失敗した際に投げられる。</p>
<p>これらのクラスは `Enumerable' モジュールをMix-inしているので、`find' や `sort' といったメソッドが利用できる。また、`Hash' クラスに似せて '[]=' や '[]' 等のメソッドを定義しているので、普通のハッシュのように利用することができる。</p>
<p>データベースに格納するレコードのキーと値は文字列として扱われるが、バイナリデータをそのまま格納することも可能である。ただし、`Villa' は直列化可能かつ比較可能な任意のオブジェクトを格納することができる。`Depot' はファイルを用いてハッシュデータベースを実現し、`Curia' はディレクトリと複数のファイルを用いてハッシュデータベースを実現し、`Villa' はファイルを用いてB+木データベースを実現する。`Depot' は最も高速である。`Curia' は最もスケーラブルである。`Villa' はカーソルによって順序に基づく参照を可能にする。</p>
<p>`put' で既存のレコードの上書きがキャンセルされた際や `get' で存在しないレコードが検索された際には例外によって操作の失敗が通知されるが、それが鬱陶しい場合は `silent' フラグを真にするとよい。その場合は失敗が戻り値によって通知される。</p>
<p>APIの詳細に関しては、サブディレクトリ `<a href="rbapidoc/">rbapidoc</a>' の文書を参照すること。</p>
<hr />
<h2><a name="installation" id="installation" class="head">インストール</a></h2>
<p>Rubyの1.6.5以降のバージョンがインストールされ、QDBMが `/usr/local' 以下にインストールされていることが必要である。</p>
<p>インストール作業は、サブディレクトリ `ruby' をカレントディレクトリにして行う。</p>
<pre>cd ruby
</pre>
<p>ビルド環境を設定する。</p>
<pre>./configure
</pre>
<p>プログラムをビルドする。</p>
<pre>make
</pre>
<p>プログラムの自己診断テストを行う。</p>
<pre>make check
</pre>
<p>プログラムをインストールする。作業は `root' ユーザで行う。</p>
<pre>make install
</pre>
<p>一連の作業が終ると、Rubyのインストールディレクトリに応じた適当な場所に `depot.rb'、`mod_depot.so' 、`curia.rb' 、`mod_curia.so' 、`villa.rb' 、`mod_villa.so' 等のライブラリがインストールされ、コマンド `rbdptest' と `rbcrtest' と `rbvltest' が `/usr/local/bin' にインストールされる。</p>
<p>アンインストールするには、`./configure' をした後の状態で以下のコマンドを実行する。作業は `root' ユーザで行う。</p>
<pre>make uninstall
</pre>
<hr />
<h2><a name="examples" id="examples" class="head">サンプルコード</a></h2>
<p>名前と対応させて電話番号を格納し、それを検索するアプリケーションのサンプルコードを以下に示す。</p>
<pre>require 'depot'
NAME = "mikio"
NUMBER = "000-1234-5678"
DBNAME = "book"
def main
depot = nil
begin
# データベースを開く
depot = Depot::new(DBNAME, Depot::OWRITER | Depot::OCREAT)
# レコードを格納する
depot.put(NAME, NUMBER)
# レコードを取得する
printf("Name: %s\n", NAME)
printf("Number: %s\n", depot.get(NAME))
rescue Depot::EANY
printf("%s\n", $!)
return 1
ensure
# データベースを閉じる
if(depot)
begin
depot.close()
rescue Depot::EANY
printf("%s\n", $!)
end
end
end
return 0
end
exit(main());
</pre>
<p>上記の例を `Hash' クラスに似せたインタフェースとイテレータを用いて書き直した例を以下に示す。</p>
<pre>require 'depot'
NAME = "mikio"
NUMBER = "000-1234-5678"
DBNAME = "book"
def main
begin
# データベースを開いて自動的に閉じる
Depot::new(DBNAME, Depot::OWRITER | Depot::OCREAT) do |depot|
# レコードを格納する
depot[NAME] = NUMBER
# レコードを取得する
printf("Name: %s\n", NAME)
printf("Number: %s\n", depot[NAME])
end
rescue Depot::EANY
printf("%s\n", $!)
return 1
end
return 0
end
exit(main());
</pre>
<p>`Villa' クラスを用いて文字列の前方一致検索を行う例を以下に示す。</p>
<pre>require 'villa'
DBNAME = "words"
PREFIX = "apple"
def main
begin
# データベースを開いて自動的に閉じる
Villa::new(DBNAME, Villa::OWRITER | Villa::OCREAT) do |villa|
# レコードを格納する
villa.put("applet", "little application", Villa::DDUP)
villa.put("aurora", "polar wonderwork", Villa::DDUP)
villa.put("apple", "delicious fruit", Villa::DDUP)
villa.put("amigo", "good friend", Villa::DDUP)
villa.put("apple", "big city", Villa::DDUP)
begin
# カーソルを候補の先頭に置く
villa.curjump(PREFIX)
# カーソルを走査する
while(true)
key = villa.curkey()
(key.index(PREFIX) == 0) || break
val = villa.curval()
printf("%s: %s\n", key, val)
villa.curnext()
end
rescue Villa::ENOITEM
end
end
rescue Villa::EANY
printf("%s\n", $!)
return 1
end
return 0
end
exit(main());
</pre>
<hr />
<h2><a name="bugs" id="bugs" class="head">バグ</a></h2>
<p>標準添付ライブラリの `DBM' クラスのインタフェースと微妙に違うところがある。</p>
<p>もしもRubyハッカー達の手にかかれば、より効率的な実装がなされるだろう。</p>
<p>インタフェースを簡潔にするため、Ruby用のCuriaにはラージオブジェクトを扱う機能はない。</p>
<hr />
</body>
</html>
<!-- END OF FILE -->
|
