html/pg_bigm-1-2.html

   1 <html>
   2 <head>
   3 <title>pg_bigm 1.2 ドキュメント</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://osdn.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-2.html">English</a></li>
  18     </ul>
  19   </div>
  20
  21 <h1 id="pg_bigm">ドキュメント (リリース1.2)</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://osdn.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>107,374,180 Bytes (約102MB)</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://osdn.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 $ pg_ctl -D $PGDATA start
 159 $ psql -d &lt;データベース名&gt;
 160 =# CREATE EXTENSION pg_bigm;
 161 =# \dx pg_bigm
 162                     List of installed extensions
 163   Name   | Version | Schema |              Description
 164 ---------+---------+--------+---------------------------------------
 165  pg_bigm | 1.1     | public | text index searching based on bigrams
 166 (1 row)
 167 </pre>
 168
 169 <ul>
 170 <li>$PGDATAは、データベースクラスタのパスを決めて、そのパスで置き換えてください。</li>
 171 <li>pg_bigmは、PostgreSQLで利用できるすべてのエンコーディングとロケールをサポートしています。</li>
 172 <li>PostgreSQL9.1では、postgresql.confで<a href="http://www.postgresql.jp/document/9.1/html/runtime-config-custom.html#GUC-CUSTOM-VARIABLE-CLASSES">custom_variable_classes</a>にpg_bigmを設定する必要があります。</li>
 173 <li>pg_bigmの登録には、<a href="http://www.postgresql.jp/document/current/html/sql-createextension.html">CREATE EXTENSION</a>を使います。 CREATE EXTENSIONはデータベース単位でモジュールを登録するため、pg_bigmを利用したいデータベースすべてにおいて登録が必要です。</li>
 174 </ul>
 175 <p>pg_bigmのインストールは以上で終わりです。</p>
 176
 177
 178 <h2 id="uninstall">アンインストール</h2>
 179
 180 <h3 id="bigm_uninstall">pg_bigmの削除</h3>
 181 <p>pg_bigmについて、データベースからの登録解除とアンインストールを行います。</p>
 182 <pre>
 183 $ psql -d &lt;データベース名&gt;
 184 =# DROP EXTENSION pg_bigm CASCADE;
 185 =# \q
 186
 187 $ pg_ctl -D $PGDATA stop
 188 $ su
 189
 190 # cd &lt;pg_bigmのソースディレクトリ&gt;
 191 # make USE_PGXS=1 PG_CONFIG=/opt/pgsql-X.Y.Z/bin/pg_config uninstall
 192 # exit
 193 </pre>
 194
 195 <ul>
 196 <li>pg_bigmを登録したすべてのデータベースで登録解除する必要があります。</li>
 197 <li>pg_bigmに依存するDBオブジェクト(例えば、pg_bigmを使った全文検索インデックス)を削除する必要があるため、<a href="http://www.postgresql.jp/document/current/html/sql-dropextension.html">DROP EXTENSION</a>にはCASCADEを指定します。</li>
 198 </ul>
 199
 200 <h3 id="delete_conf">postgresql.confの設定削除</h3>
 201 <p>postgresql.confの以下の設定を削除します</p>
 202 <ul>
 203 <li>custom_variable_classes (PostgreSQL9.1のみ)</li>
 204 <li>pg_bigm.* (pg_bigm.から名前が始まるパラメータ)</li>
 205 </ul>
 206
 207 <h2 id="fulltext_search">全文検索機能</h2>
 208
 209 <h3 id="create_index">インデックスの作成</h3>
 210 <p>GINインデックスを利用して全文検索用のインデックスを作成します。</p>
 211 <p>以下の実行例では、PostgreSQL関連ツールの名前と説明を管理するテーブルpg_toolsを作成し、4件データを投入します。その後、ツールの説明に対して全文検索用のインデックスを作成します。</p>
 212
 213 <pre>
 214 =# CREATE TABLE pg_tools (tool text, description text);
 215
 216 =# INSERT INTO pg_tools VALUES ('pg_hint_plan', 'PostgreSQLでHINT句を使えるようにするツール');
 217 =# INSERT INTO pg_tools VALUES ('pg_dbms_stats', 'PostgreSQLの統計情報を固定化するツール');
 218 =# INSERT INTO pg_tools VALUES ('pg_bigm', 'PostgreSQLで2-gramの全文検索を使えるようにするツール');
 219 =# INSERT INTO pg_tools VALUES ('pg_trgm', 'PostgreSQLで3-gramの全文検索を使えるようにするツール');
 220
 221 =# CREATE INDEX pg_tools_idx ON pg_tools USING gin (description gin_bigm_ops);
 222 </pre>
 223
 224 <ul>
 225 <li>インデックスメソッドにはginの指定が必須です。 pg_bigmでは、pg_trgmとは異なりインデックス作成にGiSTを使えません。</li>
 226 <li>演算子クラスにはgin_bigm_opsの指定が必須です。</li>
 227 </ul>
 228
 229 <p>また、以下の実行例のように、全文検索用のマルチカラムインデックスを作成したり、作成時にGINインデックスのパラメータを指定することもできます。</p>
 230
 231 <pre>
 232 =# CREATE INDEX pg_tools_multi_idx ON pg_tools USING gin (tool gin_bigm_ops, description gin_bigm_ops) WITH (FASTUPDATE = off);
 233 </pre>
 234
 235 <h3 id="do_fulltext_search">全文検索の実行</h3>
 236 <p>pg_bigmでは、LIKE演算子の中間一致検索により全文検索を行います。</p>
 237 <pre>
 238 =# SELECT * FROM pg_tools WHERE description LIKE '%全文検索%';
 239   tool   |                     description
 240 ---------+------------------------------------------------------
 241  pg_bigm | PostgreSQLで2-gramの全文検索を使えるようにするツール
 242  pg_trgm | PostgreSQLで3-gramの全文検索を使えるようにするツール
 243 (2 rows)
 244 </pre>
 245 <ul>
 246 <li>検索文字列は<a href="#likequery">likequery</a>に記載されているとおり、全文検索用に変換されなければなりません。</li>
 247 </ul>
 248
 249 <h3 id="similarity_search">類似度検索の実行</h3>
 250 <p>pg_bigmでは、=% 演算子を使って類似度検索を行います。</p>
 251 <p>以下の実行例では、文字列「bigm」に似た文字列のtool列を検索しています。この類似度検索も、全文検索と同様にインデックスにより高速に実行されます。文字列どうしが似ているかどうかは、それら文字列の類似度が<a href="#similarity_limit">pg_bigm.similarity_limit</a>の設定値以上かどうかで判断されます。この実行例では、文字列「bigm」との類似度が0.2以上だった「pg_bigm」と「pg_trgm」のtool列だけが検索結果となります。</p>
 252 <pre>
 253 =# SET pg_bigm.similarity_limit TO 0.2;
 254
 255 =# SELECT tool FROM pg_tools WHERE tool =% 'bigm';
 256   tool
 257 ---------
 258  pg_bigm
 259  pg_trgm
 260 (2 rows)
 261 </pre>
 262 <p>
 263 類似度の計算方法や注意点については、類似度を計算する関数<a href="#bigm_similarity">bigm_similarity</a>を参照してください。
 264 </p>
 265
 266 <h2 id="functions">提供関数</h2>
 267 <h3 id="likequery">likequery</h3>
 268 <p>likequeryは、全文検索できるように、検索文字列(引数1)をLIKE演算子のパターンに変換する関数です。</p>
 269 <ul>
 270 <li>引数1(text) - 検索文字列</li>
 271 <li>戻り値(text) - 全文検索用に、引数1をLIKE演算子のパターンに変換した文字列</li>
 272 </ul>
 273
 274 <p>引数1がNULLの場合、戻り値はNULLです。</p>
 275
 276 <p>変換は、具体的には以下を行います。</p>
 277 <ul>
 278 <li>検索文字列の先頭と末尾に%(半角パーセント)を追加</li>
 279 <li>検索文字列内の%(半角パーセント)、_(半角アンダースコア)、\(半角バックスラッシュ)を\(半角バックスラッシュ)でエスケープ</li>
 280 </ul>
 281
 282 <p>pg_bigmでは、LIKE演算子の中間一致検索により全文検索を行います。このため、上記のとおり検索文字列を変換して、LIKE演算子に渡す必要があります。この変換は、通常、クライアントアプリケーション側で実装しなければなりません。しかし、likequeryを利用することで、その実装の手間を省くことができます。</p>
 283
 284 <pre>
 285 =# SELECT likequery('pg_bigmは検索性能を200%向上させました。');
 286                   likequery
 287 ---------------------------------------------
 288  %pg\_bigmは検索性能を200\%向上させました。%
 289 (1 row)
 290 </pre>
 291
 292 <p>「全文検索の実行」の実行例の検索SQLは、likequeryを使うことで、以下のように書き換えられます。</p>
 293 <pre>
 294 =# SELECT * FROM pg_tools WHERE description LIKE likequery('全文検索');
 295   tool   |                     description
 296 ---------+------------------------------------------------------
 297  pg_bigm | PostgreSQLで2-gramの全文検索を使えるようにするツール
 298  pg_trgm | PostgreSQLで3-gramの全文検索を使えるようにするツール
 299 (2 rows)
 300 </pre>
 301
 302 <h3 id="show_bigm">show_bigm</h3>
 303 <p>show_bigmは、文字列(引数1)のすべての2-gram文字列を配列として表示する関数です。</p>
 304
 305 <ul>
 306 <li>引数1(text) - 文字列</li>
 307 <li>戻り値(text[]) - 引数1のすべての2-gram文字列から構成される配列</li>
 308 </ul>
 309
 310 <p>2-gram文字列とは、文字列の先頭と末尾に空白文字を追加した上で、文字列を1文字ずつずらしながら、2文字単位で抽出した文字列のことです。例えば、文字列「ABC」の2-gram文字列は、「(空白)A」「AB」「BC」「C(空白)」の4つになります。</p>
 311
 312 <pre>
 313 =#  SELECT show_bigm('PostgreSQLの全文検索');
 314                             show_bigm
 315 -----------------------------------------------------------------
 316  {の全,全文,文検,検索,"索 "," P",Lの,Po,QL,SQ,eS,gr,os,re,st,tg}
 317 (1 row)
 318 </pre>
 319
 320 <h3 id="bigm_similarity">bigm_similarity</h3>
 321 <p>bigm_similarityは、文字列(引数1)と文字列(引数2)の類似度(文字列がどの程度似ているかを示す数値)を返却する関数です。</p>
 322
 323 <ul>
 324 <li>引数1(text) - 文字列</li>
 325 <li>引数2(text) - 文字列</li>
 326 <li>戻り値(real) - 引数1と引数2の文字列の類似度</li>
 327 </ul>
 328
 329 <p>
 330 この関数は、各文字列の2-gram文字列から一致するものの個数を数えることで類似度を計算します。
 331 類似度は0(2つの文字列にまったく類似性がないことを示す)から1(2つの文字列が同一であることを示す)までの範囲です。
 332 </p>
 333
 334 <pre>
 335 =# SELECT bigm_similarity('PostgreSQLの全文検索', 'postgresの検索');
 336  bigm_similarity
 337 -----------------
 338           0.4375
 339 (1 row)
 340 </pre>
 341
 342 <p>
 343 類似度計算に使われる2-gram文字列は、文字列の先頭と末尾に空白文字が追加された上で作成されることに注意してください。
 344 このため、例えば、文字列「B」は文字列「ABC」に含まれますが、下記のとおり一致する2-gram文字列がないため類似度は0になります。
 345 一方、文字列「A」は、下記のとおり一致する2-gram文字列があるため類似度は0より大きくなります。
 346 これは、pg_trgmのsimilarity関数と基本的に同じ挙動です。
 347
 348 <ul>
 349 <li>文字列「ABC」の2-gram文字列は「(空白)A」「AB」「BC」「C(空白)」</li>
 350 <li>文字列「A」の2-gram文字列は「(空白)A」「A(空白)」</li>
 351 <li>文字列「B」の2-gram文字列は「(空白)B」「B(空白)」</li>
 352 </ul>
 353 </p>
 354
 355 <pre>
 356 =# SELECT bigm_similarity('ABC', 'A');
 357  bigm_similarity
 358 -----------------
 359             0.25
 360 (1 row)
 361
 362 =# SELECT bigm_similarity('ABC', 'B');
 363  bigm_similarity
 364 -----------------
 365                0
 366 (1 row)
 367 </pre>
 368
 369 <p>
 370 bigm_similarityは、英字の大文字と小文字を区別することに注意してください。
 371 一方、pg_trgmのsimilarity関数は、英字の大文字と小文字を区別しません。
 372 例えば、「ABC」と「abc」の類似度は、pg_trgmのsimilarity関数では1ですが、bigm_similarityでは0です。
 373 </p>
 374
 375 <pre>
 376 =# SELECT similarity('ABC', 'abc');
 377  similarity
 378 ------------
 379           1
 380 (1 row)
 381
 382 =# SELECT bigm_similarity('ABC', 'abc');
 383  bigm_similarity
 384 -----------------
 385                0
 386 (1 row)
 387 </pre>
 388
 389 <h3 id="pg_gin_pending_stats">pg_gin_pending_stats</h3>
 390 <p>pg_gin_pending_statsは、GINインデックス(引数1)の待機リストに含まれているデータのページ数とタプル数を返却する関数です。</p>
 391
 392 <ul>
 393 <li>引数1(regclass) - GINインデックスの名前もしくはOID</li>
 394 <li>戻り値1(integer) - GINインデックス(引数1)の待機リストに含まれているデータのページ数</li>
 395 <li>戻り値2(bigint) - GINインデックス(引数1)の待機リストに含まれているデータのタプル数</li>
 396 </ul>
 397
 398 <p>
 399 FASTUPDATEオプション無効で作成されたGINインデックスが引数1の場合、そのGINインデックスは待機リストを持たないため、戻り値1と2は0となることに注意してください。
 400 GINインデックスの待機リストとFASTUPDATEオプションの詳細は、<a href="http://www.postgresql.jp/document/current/html/gin-implementation.html#GIN-FAST-UPDATE">GIN高速更新手法</a>を参照してください。
 401 </p>
 402
 403 <pre>
 404 =# SELECT * FROM pg_gin_pending_stats('pg_tools_idx');
 405  pages | tuples
 406 -------+--------
 407      1 |      4
 408 (1 row)
 409 </pre>
 410
 411 <h2 id="parametares">パラメータ</h2>
 412 <h3 id="last_update">pg_bigm.last_update</h3>
 413 <p>pg_bigm.last_updateは、pg_bigmモジュールの最終更新日付を報告するパラメータです。このパラメータは読み取り専用です。 postgresql.confやSET文で設定値を変更することはできません。</p>
 414 <pre>
 415 =# SHOW pg_bigm.last_update;
 416  pg_bigm.last_update
 417 ---------------------
 418  2013.11.22
 419 (1 row)
 420 </pre>
 421
 422 <h3 id="enable_recheck">pg_bigm.enable_recheck</h3>
 423 <p>pg_bigm.enable_recheckは、全文検索の内部処理であるRecheckを行うかどうか指定するパラメータです。デフォルト値はonで、Recheckを行います。このパラメータは、postgresql.confとSET文(スーパーユーザに限らずどのユーザからでも)で設定値を変更できます。全文検索において正しい検索結果を得るには、このパラメータは有効化されていなければなりません。</p>
 424
 425 <p>pg_bigmを使った全文検索では、内部的には以下2つの処理で検索結果が取得されます。</p>
 426
 427 <ul>
 428 <li>全文検索インデックスからの検索結果候補の取得</li>
 429 <li>検索結果候補からの正しい検索結果の選択</li>
 430 </ul>
 431
 432 <p>この後者の処理がRecheckと呼ばれます。全文検索インデックスからの検索結果の取得では、必ずしも正しい結果ばかりが得られるとは限りません。誤った結果が含まれる可能性があります。この誤った結果を取り除くのがRecheckになります。</p>
 433
 434 <p>例えば、テーブルに「ここは東京都」「東京と京都に行く」の2つの文字列が格納されている状況を想像してください。検索文字列「東京都」で検索した場合、正しい結果は「ここは東京都」です。しかし、全文検索インデックスからの結果取得では、「東京と京都に行く」も結果候補として取得できてしまいます。これは、検索文字列の2-gram文字列である「東京」と「京都」が「東京と京都に行く」に含まれているためです。 Recheckは、結果候補それぞれについて検索文字列「東京都」が含まれるのか再チェックを行い、正しい結果だけを選択します。</p>
 435
 436 <p>このRecheckによる検索結果の絞り込みの様子は、EXPLAIN ANALYZEの結果から確認できます。</p>
 437
 438 <pre>
 439 =# CREATE TABLE tbl (doc text);
 440 =# INSERT INTO tbl VALUES('ここは東京都');
 441 =# INSERT INTO tbl VALUES('東京と京都に行く');
 442 =# CREATE INDEX tbl_idx ON tbl USING gin (doc gin_bigm_ops);
 443 =# SET enable_seqscan TO off;
 444 =# EXPLAIN ANALYZE SELECT * FROM tbl WHERE doc LIKE likequery('東京都');
 445                                                    QUERY PLAN
 446 -----------------------------------------------------------------------------------------------------------------
 447  Bitmap Heap Scan on tbl  (cost=12.00..16.01 rows=1 width=32) (actual time=0.022..0.023 rows=1 loops=1)
 448    Recheck Cond: (doc ~~ '%東京都%'::text)
 449    -&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)
 450          Index Cond: (doc ~~ '%東京都%'::text)
 451  Total runtime: 0.059 ms
 452 (5 rows)
 453 </pre>
 454
 455 <p>Bitmap Index Scanのrowsは2となっており、全文検索インデックスからは2件結果を取得しています。 Recheck実行後のBitmap Heap Scanのrowsは1となっており、2件の結果候補から1件に絞り込まれた様子を確認できます。</p>
 456
 457 <p>pg_bigm.enable_recheckを無効化することで、Recheckをスキップさせ、全文検索インデックスから取得した結果候補をそのまま最終的な検索結果とすることができます。以下の実行例では、このパラメータの無効化により、誤った検索結果の「東京と京都に行く」を得られています。</p>
 458
 459 <pre>
 460 =# SELECT * FROM tbl WHERE doc LIKE likequery('東京都');
 461      doc
 462 --------------
 463  ここは東京都
 464 (1 row)
 465
 466 =# SET pg_bigm.enable_recheck TO off;
 467 =# SELECT * FROM tbl WHERE doc LIKE likequery('東京都');
 468        doc
 469 ------------------
 470  ここは東京都
 471  東京と京都に行く
 472 (2 rows)
 473 </pre>
 474
 475 <p>このパラメータは、正しい検索結果を得る必要がある運用時には必ずonに設定されていなければなりません。一方、Recheckのオーバーヘッドを評価するなど、デバッグ時にoffに設定しても構いません。</p>
 476
 477 <h3 id="gin_key_limit">pg_bigm.gin_key_limit</h3>
 478 <p>pg_bigm.gin_key_limitは、検索文字列の2-gram文字列のうち最大で何個を全文検索インデックスの検索に使うか指定するパラメータです。設定値が0(デフォルト値)の場合は、検索文字列のすべての2-gram文字列をインデックス検索に使います。このパラメータは、postgresql.confとSET文(スーパーユーザに限らずどのユーザからでも)で設定値を変更できます。</p>
 479
 480 <p>pg_bigmの全文検索では、基本的に、検索文字列のすべての2-gram文字列を使ってGINインデックスを検索します。ただし、現在のGINインデックスの実装では、検索に使う2-gram文字列の個数が多いほどインデックス検索の負荷は高くなります。このため、検索文字列の文字数が多く、2-gram文字列の個数が多くなりやすいシステムでは、検索性能は劣化しやすいです。 pg_bigm.gin_key_limitによりGINインデックスの検索に使う2-gram文字列の最大数を制限することで、この性能問題を解決できます。</p>
 481
 482 <p>ただし、インデックス検索に使う2-gram文字列の個数が減ると、インデックスから取得した検索結果候補にはより多くの誤った結果が含まれることになります。このため、Recheckの負荷が高まり、逆に、より性能劣化する可能性もあるため注意が必要です。</p>
 483
 484 <h3 id="similarity_limit">pg_bigm.similarity_limit</h3>
 485 <p>pg_bigm.similarity_limitは、類似度検索の閾値を指定するパラメータです。類似度検索では、検索条件の文字列との類似度がこの閾値以上の行が検索結果となります。設定値は0以上1以下の小数点数で、デフォルト値は0.3です。このパラメータは、postgresql.confとSET文(スーパーユーザに限らずどのユーザからでも)で設定値を変更できます。</p>
 486
 487 <h2 id="limitations">制約</h2>
 488 <h3 id="indexed_column_size">インデックス作成が可能な列の最大サイズ</h3>
 489
 490 <p>pg_bigmでは、列サイズが107,374,180Byte (約102MB)を越える列へインデックスを作成できません。制限を越える大きさのデータを挿入するとエラーを起こします。</p>
 491
 492 <pre>
 493 =# CREATE TABLE t1 (description text);
 494 =# CREATE INDEX t1_idx ON t1 USING gin (description gin_bigm_ops);
 495 =# INSERT INTO t1 SELECT repeat('A', 107374181);
 496 ERROR:  out of memory
 497 </pre>
 498
 499 <p>この制約はpg_trgmにも存在しますが、pg_trgmでは最大238,609,291Byte (約228MB)までインデックスの作成が可能です。</p>
 500
 501 <h2 id="release_notes">リリースノート</h2>
 502 <ul>
 503 <li><a href="release-1-1-20131122.html">バージョン1.1 (2013-11-22 リリース)</a></li>
 504 <li><a href="release-1-0-20131122.html">バージョン1.0 (2013-11-22 リリース)</a></li>
 505 </ul>
 506
 507 <hr>
 508 <div align="right">Copyright (c) 2012-2015, NTT DATA Corporation</div>
 509
 510 </body>
 511 </html>
 512