OSDN Git Service

d2be46395de1d9493daa5746d89f6dbb691e2e96
[pgbigm/pg_bigm.git] / html / pg_bigm-1-1.html
1 <html>
2 <head>
3 <title>pg_bigm 1.1 ドキュメント</title>
4
5 <link rel="stylesheet" type="text/css" href="style.css">
6 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7 </head>
8
9 <body>
10   <div id="navigation">
11     <ul>
12       <li><a href="index.html">ホーム</a></li>
13       <li><a href="http://sourceforge.jp/projects/pgbigm/releases/?package_id=13634">ダウンロード</a></li>
14       <li><a href="index.html#document">ドキュメント</a></li>
15       <li><a href="index.html#community">コミュニティ</a></li>
16       <li><a href="index.html#development">開発</a></li>
17       <li><a href="pg_bigm_en-1-1.html">English</a></li>
18     </ul>
19   </div>
20
21 <h1 id="pg_bigm">ドキュメント (リリース1.1)</h1>
22
23 <div class="index">
24 <ol>
25 <li><a href="#description">概要</a></li>
26 <li><a href="#pg_trgm">pg_trgmとの違い</a></li>
27 <li><a href="#requirement">動作確認環境</a></li>
28 <li><a href="#install">インストール</a></li>
29 <li><a href="#uninstall">アンインストール</a></li>
30 <li><a href="#fulltext_search">全文検索機能</a></li>
31 <li><a href="#functions">提供関数</a></li>
32 <li><a href="#parametares">パラメータ</a></li>
33 <li><a href="#limitations">制約</a></li>
34 <li><a href="#release_notes">リリースノート</a></li>
35 </ol>
36 </div>
37
38 <h2 id="description">概要</h2>
39 <p>pg_bigm(ピージーバイグラム)は、<a href="http://www.postgresql.org/">PostgreSQL</a>上で全文検索機能を提供するモジュールです。このモジュールを使うことで、ユーザは全文検索用のインデックスを作成でき、高速に文字列検索を行えるようになります。このモジュールは、2-gram(バイグラム)と呼ばれる方法で、文字列から全文検索用のインデックスを作成します。</p>
40 <p><a href="http://sourceforge.jp/projects/pgbigm/">pg_bigmプロジェクト</a>では以下の1つのモジュールを提供します。</p>
41
42 <table>
43 <thead>
44 <tr>
45 <th>モジュール名</th><th>概要</th><th>ソースアーカイブファイル名</th>
46 </tr>
47 </thead>
48 <tbody>
49 <tr><td>pg_bigm</td>
50   <td nowrap>PostgreSQL上で全文検索機能を提供するモジュール</td>
51   <td>pg_bigm-x.y-YYYYMMDD.tar.gz</td></tr>
52 </tbody>
53 </table>
54
55 <p>
56 ソースアーカイブファイル名のx.yとYYYYMMDDの部分は、それぞれ、そのファイルのバージョン番号とリリース年月日です。
57 例えば、2013年11月22日リリースのバージョン1.1のファイルでは、x.yは1.1、YYYYMMDDは20131122です。
58 </p>
59 <p>pg_bigmのライセンスは<a href="http://opensource.org/licenses/postgresql">The PostgreSQL License</a>(BSDに似たライセンス)です。</p>
60
61 <h2 id="pg_trgm">pg_trgmとの違い</h2>
62 <p>PostgreSQLには、<a href="http://www.postgresql.jp/document/current/html/pgtrgm.html">pg_trgm</a>という3-gram(トライグラム)の全文検索モジュールがcontribに付属されています。 pg_bigmは、pg_trgmをベースに開発されています。 pg_trgmとpg_bigmでは、機能や特徴に以下の違いがあります。</p>
63
64 <table>
65 <thead>
66 <tr>
67 <th>機能や特徴</th><th>pg_trgm</th><th>pg_bigm</th>
68 </tr>
69 </thead>
70 <tbody>
71 <tr><td>全文検索インデックスの作成方法</td>
72   <td nowrap>3-gram</td>
73   <td>2-gram</td></tr>
74 <tr><td>利用できるインデックスの種類</td>
75   <td nowrap>GINとGiST</td>
76   <td>GINのみ</td></tr>
77 <tr><td>日本語検索</td>
78   <td nowrap>未対応(*1)</td>
79   <td>対応済</td></tr>
80 <tr><td>検索キーワード1~2文字での検索</td>
81   <td nowrap>低速<br>(検索時に全文検索インデックスを使えない(*2))</td>
82   <td>高速<br>(検索時に全文検索インデックスを使える)</td></tr>
83 <tr><td>類似文字列の検索</td>
84   <td nowrap>対応済</td>
85   <td>対応済(バージョン1.1以降)</td></tr>
86 <tr><td>インデックス作成が可能な列の最大サイズ</td>
87   <td nowrap>238,609,291Byte (約228MB)</td>
88   <td nowrap>71,582,785Byte (約68MB)</td></tr>
89 </tbody>
90 </table>
91
92 <ul>
93 <li>(*1) ソースコード内の<a href="http://lets.postgresql.jp/documents/technical/text-processing/3#contains">マクロ変数を変更することで日本語検索に対応</a>できます。しかし、日本語検索の性能はpg_bigmに比べて低速です。</li>
94 <li>(*2) 全文検索インデックスを使える場合もありますが、その場合はフルインデックススキャンが走るため検索性能は非常に低くなります。</li>
95 </ul>
96
97 <p>pg_bigmのバージョン1.1以降では、pg_trgmとpg_bigmを同じデータベース内で共存させることが可能です。しかし、バージョン1.0では共存できないため、pg_bigmを登録するデータベースには、pg_trgmを同時に登録しないでください。</p>
98
99 <h2 id="requirement">動作確認環境</h2>
100 <p>pg_bigmは、以下の環境で動作確認をしています。</p>
101 <table>
102 <thead>
103 <tr>
104 <th>カテゴリ</th><th>モジュール名</th>
105 </tr>
106 </thead>
107 <tbody>
108 <tr>
109   <td>OS</td>
110   <td nowrap>Linux, Mac OS X</td>
111 </tr>
112 <tr>
113   <td>DBMS</td>
114   <td nowrap>PostgreSQL 9.1, 9.2, 9.3, 9.4</td>
115 </tr>
116 </tbody>
117 </table>
118
119 <p>pg_bigmは、PostgreSQL9.1以降に対応しています。9.0以前には未対応です。</p>
120
121 <h2 id="install">インストール</h2>
122
123 <h3 id="pg_install">PostgreSQLのインストール</h3>
124 <p><a href="http://www.postgresql.org/">PostgreSQLのオフィシャルサイト</a>からPostgreSQLのソースアーカイブファイルpostgresql-X.Y.Z.tar.gz(X.Y.Zは実際のバージョン番号に置き換えてください)をダウンロードし、ビルドとインストールを行います。</p>
125 <pre>
126 $ tar zxf postgresql-X.Y.Z.tar.gz
127 $ cd postgresql-X.Y.Z
128 $ ./configure --prefix=/opt/pgsql-X.Y.Z
129 $ make
130 $ su
131 # make install
132 # exit</pre>
133 <ul>
134 <li>--prefix : インストール先ディレクトリを指定します。このオプション指定は必須ではありません。未指定時のインストール先は/usr/local/pgsqlです。</li>
135 </ul>
136 <p>RPMからPostgreSQLをインストールしてもpg_bigmは利用可能です。 この場合、postgresql-develパッケージをインストールしなければならないことに注意してください。</p>
137
138 <h3 id="bigm_install">pg_bigmのインストール</h3>
139 <p><a href="http://sourceforge.jp/projects/pgbigm/releases/?package_id=13634">ここ</a>からpg_bigmのソースアーカイブファイルをダウンロードし、ビルドとインストールを行います。</p>
140 <pre>
141 $ tar zxf pg_bigm-x.y-YYYYMMDD.tar.gz
142 $ cd pg_bigm-x.y-YYYYMMDD
143 $ make USE_PGXS=1 PG_CONFIG=/opt/pgsql-X.Y.Z/bin/pg_config
144 $ su
145 # make USE_PGXS=1 PG_CONFIG=/opt/pgsql-X.Y.Z/bin/pg_config install
146 # exit
147 </pre>
148 <ul>
149 <li>USE_PGXS : PostgreSQL関連モジュールをコンパイルするときのオマジナイです。USE_PGXS=1の指定が必須です。</li>
150 <li>PG_CONFIG : <a href="http://www.postgresql.jp/document/current/html/app-pgconfig.html">pg_config</a>コマンド(PostgreSQLインストール先のbinディレクトリに存在)のパスを指定します。pg_configにPATHが通っているのであれば、このオプション指定は不要です。</li>
151 </ul>
152
153 <h3 id="bigm_register">pg_bigmの登録</h3>
154 <p>データベースクラスタの作成後、postgresql.confを編集、PostgreSQLを起動し、pg_bigmをデータベースに登録します。</p>
155 <pre>
156 $ initdb -D $PGDATA --locale=C --encoding=UTF8
157
158 $ vi $PGDATA/postgresql.conf
159 shared_preload_libraries = 'pg_bigm'
160 custom_variable_classes = 'pg_bigm'
161
162 $ pg_ctl -D $PGDATA start
163 $ psql -d &lt;データベース名&gt;
164 =# CREATE EXTENSION pg_bigm;
165 =# \dx pg_bigm
166                     List of installed extensions
167   Name   | Version | Schema |              Description
168 ---------+---------+--------+---------------------------------------
169  pg_bigm | 1.1     | public | text index searching based on bigrams
170 (1 row)
171 </pre>
172
173 <ul>
174 <li>$PGDATAは、データベースクラスタのパスを決めて、そのパスで置き換えてください。</li>
175 <li>pg_bigmは、PostgreSQLで利用できるすべてのエンコーディングとロケールをサポートしています。</li>
176 <li>postgresql.confで、<a href="http://www.postgresql.jp/document/current/html/runtime-config-resource.html#GUC-SHARED-PRELOAD-LIBRARIES">shared_preload_libraries</a>と<a href="http://www.postgresql.jp/document/9.1/html/runtime-config-custom.html#GUC-CUSTOM-VARIABLE-CLASSES">custom_variable_classes</a>にpg_bigmを設定するのは必須です。 
177   <ul>
178     <li>PostgreSQL9.2以降ではcustom_variable_classesは存在しません。設定が必要なのはshared_preload_librariesだけです。</li>
179   </ul>
180 </li>
181 <li>pg_bigmの登録には、<a href="http://www.postgresql.jp/document/current/html/sql-createextension.html">CREATE EXTENSION</a>を使います。 CREATE EXTENSIONはデータベース単位でモジュールを登録するため、pg_bigmを利用したいデータベースすべてにおいて登録が必要です。</li>
182 </ul>
183 <p>pg_bigmのインストールは以上で終わりです。</p>
184
185
186 <h2 id="uninstall">アンインストール</h2>
187
188 <h3 id="bigm_uninstall">pg_bigmの削除</h3>
189 <p>pg_bigmについて、データベースからの登録解除とアンインストールを行います。</p>
190 <pre>
191 $ psql -d &lt;データベース名&gt;
192 =# DROP EXTENSION pg_bigm CASCADE;
193 =# \q
194
195 $ pg_ctl -D $PGDATA stop
196 $ su
197
198 # cd &lt;pg_bigmのソースディレクトリ&gt;
199 # make USE_PGXS=1 PG_CONFIG=/opt/pgsql-X.Y.Z/bin/pg_config uninstall
200 # exit
201 </pre>
202
203 <ul>
204 <li>pg_bigmを登録したすべてのデータベースで登録解除する必要があります。</li>
205 <li>pg_bigmに依存するDBオブジェクト(例えば、pg_bigmを使った全文検索インデックス)を削除する必要があるため、<a href="http://www.postgresql.jp/document/current/html/sql-dropextension.html">DROP EXTENSION</a>にはCASCADEを指定します。</li>
206 </ul>
207
208 <h3 id="delete_conf">postgresql.confの設定削除</h3>
209 <p>postgresql.confの以下の設定を削除します</p>
210 <ul>
211 <li>shared_preload_libraries</li>
212 <li>custom_variable_classes</li>
213 <li>pg_bigm.* (pg_bigm.から名前が始まるパラメータ)</li>
214 </ul>
215
216 <h2 id="fulltext_search">全文検索機能</h2>
217
218 <h3 id="create_index">インデックスの作成</h3>
219 <p>GINインデックスを利用して全文検索用のインデックスを作成します。</p>
220 <p>以下の実行例では、PostgreSQL関連ツールの名前と説明を管理するテーブルpg_toolsを作成し、4件データを投入します。その後、ツールの説明に対して全文検索用のインデックスを作成します。</p>
221
222 <pre>
223 =# CREATE TABLE pg_tools (tool text, description text);
224
225 =# INSERT INTO pg_tools VALUES ('pg_hint_plan', 'PostgreSQLでHINT句を使えるようにするツール');
226 =# INSERT INTO pg_tools VALUES ('pg_dbms_stats', 'PostgreSQLの統計情報を固定化するツール');
227 =# INSERT INTO pg_tools VALUES ('pg_bigm', 'PostgreSQLで2-gramの全文検索を使えるようにするツール');
228 =# INSERT INTO pg_tools VALUES ('pg_trgm', 'PostgreSQLで3-gramの全文検索を使えるようにするツール');
229
230 =# CREATE INDEX pg_tools_idx ON pg_tools USING gin (description gin_bigm_ops);
231 </pre>
232
233 <ul>
234 <li>インデックスメソッドにはginの指定が必須です。 pg_bigmでは、pg_trgmとは異なりインデックス作成にGiSTを使えません。</li>
235 <li>演算子クラスにはgin_bigm_opsの指定が必須です。</li>
236 </ul>
237
238 <p>また、以下の実行例のように、全文検索用のマルチカラムインデックスを作成したり、作成時にGINインデックスのパラメータを指定することもできます。</p>
239
240 <pre>
241 =# CREATE INDEX pg_tools_multi_idx ON pg_tools USING gin (tool gin_bigm_ops, description gin_bigm_ops) WITH (FASTUPDATE = off);
242 </pre>
243
244 <h3 id="do_fulltext_search">全文検索の実行</h3>
245 <p>pg_bigmでは、LIKE演算子の中間一致検索により全文検索を行います。</p>
246 <pre>
247 =# SELECT * FROM pg_tools WHERE description LIKE '%全文検索%';
248   tool   |                     description
249 ---------+------------------------------------------------------
250  pg_bigm | PostgreSQLで2-gramの全文検索を使えるようにするツール
251  pg_trgm | PostgreSQLで3-gramの全文検索を使えるようにするツール
252 (2 rows)
253 </pre>
254 <ul>
255 <li>検索文字列は<a href="#likequery">likequery</a>に記載されているとおり、全文検索用に変換されなければなりません。</li>
256 </ul>
257
258 <h3 id="similarity_search">類似度検索の実行</h3>
259 <p>pg_bigmでは、=% 演算子を使って類似度検索を行います。</p>
260 <p>以下の実行例では、文字列「bigm」に似た文字列のtool列を検索しています。この類似度検索も、全文検索と同様にインデックスにより高速に実行されます。文字列どうしが似ているかどうかは、それら文字列の類似度が<a href="#similarity_limit">pg_bigm.similarity_limit</a>の設定値以上かどうかで判断されます。この実行例では、文字列「bigm」との類似度が0.2以上だった「pg_bigm」と「pg_trgm」のtool列だけが検索結果となります。</p>
261 <pre>
262 =# SET pg_bigm.similarity_limit TO 0.2;
263
264 =# SELECT tool FROM pg_tools WHERE tool =% 'bigm';
265   tool   
266 ---------
267  pg_bigm
268  pg_trgm
269 (2 rows)
270 </pre>
271 <p>
272 類似度の計算方法や注意点については、類似度を計算する関数<a href="#bigm_similarity">bigm_similarity</a>を参照してください。
273 </p>
274
275 <h2 id="functions">提供関数</h2>
276 <h3 id="likequery">likequery</h3>
277 <p>likequeryは、全文検索できるように、検索文字列(引数1)をLIKE演算子のパターンに変換する関数です。</p>
278 <ul>
279 <li>引数1(text) - 検索文字列</li>
280 <li>戻り値(text) - 全文検索用に、引数1をLIKE演算子のパターンに変換した文字列</li>
281 </ul>
282
283 <p>引数1がNULLの場合、戻り値はNULLです。</p>
284
285 <p>変換は、具体的には以下を行います。</p>
286 <ul>
287 <li>検索文字列の先頭と末尾に%(半角パーセント)を追加</li>
288 <li>検索文字列内の%(半角パーセント)、_(半角アンダースコア)、\(半角バックスラッシュ)を\(半角バックスラッシュ)でエスケープ</li>
289 </ul>
290
291 <p>pg_bigmでは、LIKE演算子の中間一致検索により全文検索を行います。このため、上記のとおり検索文字列を変換して、LIKE演算子に渡す必要があります。この変換は、通常、クライアントアプリケーション側で実装しなければなりません。しかし、likequeryを利用することで、その実装の手間を省くことができます。</p>
292
293 <pre>
294 =# SELECT likequery('pg_bigmは検索性能を200%向上させました。');
295                   likequery
296 ---------------------------------------------
297  %pg\_bigmは検索性能を200\%向上させました。%
298 (1 row)
299 </pre>
300
301 <p>「全文検索の実行」の実行例の検索SQLは、likequeryを使うことで、以下のように書き換えられます。</p>
302 <pre>
303 =# SELECT * FROM pg_tools WHERE description LIKE likequery('全文検索');
304   tool   |                     description
305 ---------+------------------------------------------------------
306  pg_bigm | PostgreSQLで2-gramの全文検索を使えるようにするツール
307  pg_trgm | PostgreSQLで3-gramの全文検索を使えるようにするツール
308 (2 rows)
309 </pre>
310
311 <h3 id="show_bigm">show_bigm</h3>
312 <p>show_bigmは、文字列(引数1)のすべての2-gram文字列を配列として表示する関数です。</p>
313
314 <ul>
315 <li>引数1(text) - 文字列</li>
316 <li>戻り値(text[]) - 引数1のすべての2-gram文字列から構成される配列</li>
317 </ul>
318
319 <p>2-gram文字列とは、文字列の先頭と末尾に空白文字を追加した上で、文字列を1文字ずつずらしながら、2文字単位で抽出した文字列のことです。例えば、文字列「ABC」の2-gram文字列は、「(空白)A」「AB」「BC」「C(空白)」の4つになります。</p>
320
321 <pre>
322 =#  SELECT show_bigm('PostgreSQLの全文検索');
323                             show_bigm
324 -----------------------------------------------------------------
325  {の全,全文,文検,検索,"索 "," P",Lの,Po,QL,SQ,eS,gr,os,re,st,tg}
326 (1 row)
327 </pre>
328
329 <h3 id="bigm_similarity">bigm_similarity</h3>
330 <p>bigm_similarityは、文字列(引数1)と文字列(引数2)の類似度(文字列がどの程度似ているかを示す数値)を返却する関数です。</p>
331
332 <ul>
333 <li>引数1(text) - 文字列</li>
334 <li>引数2(text) - 文字列</li>
335 <li>戻り値(real) - 引数1と引数2の文字列の類似度</li>
336 </ul>
337
338 <p>
339 この関数は、各文字列の2-gram文字列から一致するものの個数を数えることで類似度を計算します。
340 類似度は0(2つの文字列にまったく類似性がないことを示す)から1(2つの文字列が同一であることを示す)までの範囲です。
341 </p>
342
343 <pre>
344 =# SELECT bigm_similarity('PostgreSQLの全文検索', 'postgresの検索');
345  bigm_similarity 
346 -----------------
347           0.4375
348 (1 row)
349 </pre>
350
351 <p>
352 類似度計算に使われる2-gram文字列は、文字列の先頭と末尾に空白文字が追加された上で作成されることに注意してください。
353 このため、例えば、文字列「B」は文字列「ABC」に含まれますが、下記のとおり一致する2-gram文字列がないため類似度は0になります。
354 一方、文字列「A」は、下記のとおり一致する2-gram文字列があるため類似度は0より大きくなります。
355 これは、pg_trgmのsimilarity関数と基本的に同じ挙動です。
356
357 <ul>
358 <li>文字列「ABC」の2-gram文字列は「(空白)A」「AB」「BC」「C(空白)」</li>
359 <li>文字列「A」の2-gram文字列は「(空白)A」「A(空白)」</li>
360 <li>文字列「B」の2-gram文字列は「(空白)B」「B(空白)」</li>
361 </ul>
362 </p>
363
364 <pre>
365 =# SELECT bigm_similarity('ABC', 'A');
366  bigm_similarity 
367 -----------------
368             0.25
369 (1 row)
370
371 =# SELECT bigm_similarity('ABC', 'B');
372  bigm_similarity 
373 -----------------
374                0
375 (1 row)
376 </pre>
377
378 <p>
379 bigm_similarityは、英字の大文字と小文字を区別することに注意してください。
380 一方、pg_trgmのsimilarity関数は、英字の大文字と小文字を区別しません。
381 例えば、「ABC」と「abc」の類似度は、pg_trgmのsimilarity関数では1ですが、bigm_similarityでは0です。
382 </p>
383
384 <pre>
385 =# SELECT similarity('ABC', 'abc');
386  similarity 
387 ------------
388           1
389 (1 row)
390
391 =# SELECT bigm_similarity('ABC', 'abc');
392  bigm_similarity 
393 -----------------
394                0
395 (1 row)
396 </pre>
397
398 <h3 id="pg_gin_pending_stats">pg_gin_pending_stats</h3>
399 <p>pg_gin_pending_statsは、GINインデックス(引数1)の待機リストに含まれているデータのページ数とタプル数を返却する関数です。</p>
400
401 <ul>
402 <li>引数1(regclass) - GINインデックスの名前もしくはOID</li>
403 <li>戻り値1(integer) - GINインデックス(引数1)の待機リストに含まれているデータのページ数</li>
404 <li>戻り値2(bigint) - GINインデックス(引数1)の待機リストに含まれているデータのタプル数</li>
405 </ul>
406
407 <p>
408 FASTUPDATEオプション無効で作成されたGINインデックスが引数1の場合、そのGINインデックスは待機リストを持たないため、戻り値1と2は0となることに注意してください。
409 GINインデックスの待機リストとFASTUPDATEオプションの詳細は、<a href="http://www.postgresql.jp/document/current/html/gin-implementation.html#GIN-FAST-UPDATE">GIN高速更新手法</a>を参照してください。
410 </p>
411
412 <pre>
413 =# SELECT * FROM pg_gin_pending_stats('pg_tools_idx');
414  pages | tuples
415 -------+--------
416      1 |      4
417 (1 row)
418 </pre>
419
420 <h2 id="parametares">パラメータ</h2>
421 <h3 id="last_update">pg_bigm.last_update</h3>
422 <p>pg_bigm.last_updateは、pg_bigmモジュールの最終更新日付を報告するパラメータです。このパラメータは読み取り専用です。 postgresql.confやSET文で設定値を変更することはできません。</p>
423 <pre>
424 =# SHOW pg_bigm.last_update;
425  pg_bigm.last_update
426 ---------------------
427  2013.11.22
428 (1 row)
429 </pre>
430
431 <h3 id="enable_recheck">pg_bigm.enable_recheck</h3>
432 <p>pg_bigm.enable_recheckは、全文検索の内部処理であるRecheckを行うかどうか指定するパラメータです。デフォルト値はonで、Recheckを行います。このパラメータは、postgresql.confとSET文(スーパーユーザに限らずどのユーザからでも)で設定値を変更できます。全文検索において正しい検索結果を得るには、このパラメータは有効化されていなければなりません。</p>
433
434 <p>pg_bigmを使った全文検索では、内部的には以下2つの処理で検索結果が取得されます。</p>
435
436 <ul>
437 <li>全文検索インデックスからの検索結果候補の取得</li>
438 <li>検索結果候補からの正しい検索結果の選択</li>
439 </ul>
440
441 <p>この後者の処理がRecheckと呼ばれます。全文検索インデックスからの検索結果の取得では、必ずしも正しい結果ばかりが得られるとは限りません。誤った結果が含まれる可能性があります。この誤った結果を取り除くのがRecheckになります。</p>
442
443 <p>例えば、テーブルに「ここは東京都」「東京と京都に行く」の2つの文字列が格納されている状況を想像してください。検索文字列「東京都」で検索した場合、正しい結果は「ここは東京都」です。しかし、全文検索インデックスからの結果取得では、「東京と京都に行く」も結果候補として取得できてしまいます。これは、検索文字列の2-gram文字列である「東京」と「京都」が「東京と京都に行く」に含まれているためです。 Recheckは、結果候補それぞれについて検索文字列「東京都」が含まれるのか再チェックを行い、正しい結果だけを選択します。</p>
444
445 <p>このRecheckによる検索結果の絞り込みの様子は、EXPLAIN ANALYZEの結果から確認できます。</p>
446
447 <pre>
448 =# CREATE TABLE tbl (doc text);
449 =# INSERT INTO tbl VALUES('ここは東京都');
450 =# INSERT INTO tbl VALUES('東京と京都に行く');
451 =# CREATE INDEX tbl_idx ON tbl USING gin (doc gin_bigm_ops);
452 =# SET enable_seqscan TO off;
453 =# EXPLAIN ANALYZE SELECT * FROM tbl WHERE doc LIKE likequery('東京都');
454                                                    QUERY PLAN
455 -----------------------------------------------------------------------------------------------------------------
456  Bitmap Heap Scan on tbl  (cost=12.00..16.01 rows=1 width=32) (actual time=0.022..0.023 rows=1 loops=1)
457    Recheck Cond: (doc ~~ '%東京都%'::text)
458    -&gt;  Bitmap Index Scan on tbl_idx  (cost=0.00..12.00 rows=1 width=0) (actual time=0.015..0.015 rows=2 loops=1)
459          Index Cond: (doc ~~ '%東京都%'::text)
460  Total runtime: 0.059 ms
461 (5 rows)
462 </pre>
463
464 <p>Bitmap Index Scanのrowsは2となっており、全文検索インデックスからは2件結果を取得しています。 Recheck実行後のBitmap Heap Scanのrowsは1となっており、2件の結果候補から1件に絞り込まれた様子を確認できます。</p>
465
466 <p>pg_bigm.enable_recheckを無効化することで、Recheckをスキップさせ、全文検索インデックスから取得した結果候補をそのまま最終的な検索結果とすることができます。以下の実行例では、このパラメータの無効化により、誤った検索結果の「東京と京都に行く」を得られています。</p>
467
468 <pre>
469 =# SELECT * FROM tbl WHERE doc LIKE likequery('東京都');
470      doc
471 --------------
472  ここは東京都
473 (1 row)
474
475 =# SET pg_bigm.enable_recheck TO off;
476 =# SELECT * FROM tbl WHERE doc LIKE likequery('東京都');
477        doc
478 ------------------
479  ここは東京都
480  東京と京都に行く
481 (2 rows)
482 </pre>
483
484 <p>このパラメータは、正しい検索結果を得る必要がある運用時には必ずonに設定されていなければなりません。一方、Recheckのオーバーヘッドを評価するなど、デバッグ時にoffに設定しても構いません。</p>
485
486 <h3 id="gin_key_limit">pg_bigm.gin_key_limit</h3>
487 <p>pg_bigm.gin_key_limitは、検索文字列の2-gram文字列のうち最大で何個を全文検索インデックスの検索に使うか指定するパラメータです。設定値が0(デフォルト値)の場合は、検索文字列のすべての2-gram文字列をインデックス検索に使います。このパラメータは、postgresql.confとSET文(スーパーユーザに限らずどのユーザからでも)で設定値を変更できます。</p>
488
489 <p>pg_bigmの全文検索では、基本的に、検索文字列のすべての2-gram文字列を使ってGINインデックスを検索します。ただし、現在のGINインデックスの実装では、検索に使う2-gram文字列の個数が多いほどインデックス検索の負荷は高くなります。このため、検索文字列の文字数が多く、2-gram文字列の個数が多くなりやすいシステムでは、検索性能は劣化しやすいです。 pg_bigm.gin_key_limitによりGINインデックスの検索に使う2-gram文字列の最大数を制限することで、この性能問題を解決できます。</p>
490
491 <p>ただし、インデックス検索に使う2-gram文字列の個数が減ると、インデックスから取得した検索結果候補にはより多くの誤った結果が含まれることになります。このため、Recheckの負荷が高まり、逆に、より性能劣化する可能性もあるため注意が必要です。</p>
492
493 <h3 id="similarity_limit">pg_bigm.similarity_limit</h3>
494 <p>pg_bigm.similarity_limitは、類似度検索の閾値を指定するパラメータです。類似度検索では、検索条件の文字列との類似度がこの閾値以上の行が検索結果となります。設定値は0以上1以下の小数点数で、デフォルト値は0.3です。このパラメータは、postgresql.confとSET文(スーパーユーザに限らずどのユーザからでも)で設定値を変更できます。</p>
495
496 <h2 id="limitations">制約</h2>
497 <h3 id="indexed_column_size">インデックス作成が可能な列の最大サイズ</h3>
498
499 <p>pg_bigmでは、列サイズが71,582,785Byte (約68MB)を越える列へインデックスを作成できません。制限を越える大きさのデータを挿入するとエラーを起こします。</p>
500
501 <pre>
502 =# CREATE TABLE t1 (description text);
503 =# CREATE INDEX t1_idx ON t1 USING gin (description gin_bigm_ops);
504 =# INSERT INTO t1 SELECT repeat('A', 71582786);
505 ERROR:  invalid memory alloc request size 1073741824
506 </pre>
507
508 この制約はpg_trgmにも存在しますが、pg_trgmでは最大238,609,291Byte (約228MB)までインデックスの作成が可能です。
509
510 <h2 id="release_notes">リリースノート</h2>
511 <ul>
512 <li><a href="release-1-1-20131122.html">バージョン1.1 (2013-11-22 リリース)</a></li>
513 <li><a href="release-1-0-20131122.html">バージョン1.0 (2013-11-22 リリース)</a></li>
514 </ul>
515
516 <hr>
517 <div align="right">Copyright (c) 2012-2015, NTT DATA Corporation</div>
518
519 </body>
520 </html>
521