html/pg_bigm.html

   1 <html>
   2 <head>
   3 <title>pg_bigm 1.0 ドキュメント</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="pg_bigm.html">ドキュメント</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.html">English</a></li>
  18     </ul>
  19   </div>
  20
  21 <h1 id="pg_bigm">ドキュメント (リリース1.0)</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>LIKE (~~)、ILIKE (~~*)、~、~*</td>
  79   <td>LIKEのみ</td></tr>
  80 <tr><td>日本語検索</td>
  81   <td nowrap>未対応(*1)</td>
  82   <td>対応済</td></tr>
  83 <tr><td>検索キーワード1～2文字での検索</td>
  84   <td nowrap>低速<br>(検索時に全文検索インデックスを使えない(*2))</td>
  85   <td>高速<br>(検索時に全文検索インデックスを使える)</td></tr>
  86 <tr><td>類似文字列の検索</td>
  87   <td nowrap>対応済</td>
  88   <td>未対応</td></tr>
  89 <tr><td>インデックス作成が可能な列の最大サイズ</td>
  90   <td nowrap>238,609,291Byte (約228MB)</td>
  91   <td nowrap>107,374,180 Bytes (約102MB)</td></tr>
  92 </tbody>
  93 </table>
  94
  95 <ul>
  96 <li>(*1) ソースコード内の<a href="http://lets.postgresql.jp/documents/technical/text-processing/3#contains">マクロ変数を変更することで日本語検索に対応</a>できます。しかし、日本語検索の性能はpg_bigmに比べて低速です。</li>
  97 <li>(*2) 全文検索インデックスを使える場合もありますが、その場合はフルインデックススキャンが走るため検索性能は非常に低くなります。</li>
  98 </ul>
  99
 100 <p>pg_trgmとpg_bigmを同じデータベース内で共存させることはできません。 pg_bigmを登録するデータベースには、pg_trgmを同時に登録しないでください。</p>
 101
 102 <h2 id="requirement">動作確認環境</h2>
 103 <p>pg_bigmは、以下の環境で動作確認をしています。</p>
 104 <table>
 105 <thead>
 106 <tr>
 107 <th>カテゴリ</th><th>モジュール名</th>
 108 </tr>
 109 </thead>
 110 <tbody>
 111 <tr>
 112   <td>OS</td>
 113   <td nowrap>Red Hat Enterprise Linux 6.1 x86_64</td>
 114 </tr>
 115 <tr>
 116   <td>DBMS</td>
 117   <td nowrap>PostgreSQL 9.1, 9.2</td>
 118 </tr>
 119 </tbody>
 120 </table>
 121
 122 <p>pg_bigmは、PostgreSQL9.1以降に対応しています。9.0以前には未対応です。</p>
 123
 124 <h2 id="install">インストール</h2>
 125
 126 <h3 id="pg_install">PostgreSQLのインストール</h3>
 127 <p><a href="http://www.postgresql.org/">PostgreSQLのオフィシャルサイト</a>からPostgreSQLのソースアーカイブファイルpostgresql-X.Y.Z.tar.gz(X.Y.Zは実際のバージョン番号に置き換えてください)をダウンロードし、ビルドとインストールを行います。</p>
 128 <pre>
 129 $ tar zxf postgresql-X.Y.Z.tar.gz
 130 $ cd postgresql-X.Y.Z
 131 $ ./configure --prefix=/opt/pgsql-X.Y.Z
 132 $ make
 133 $ su
 134 # make install
 135 # exit</pre>
 136 <ul>
 137 <li>--prefix : インストール先ディレクトリを指定します。このオプション指定は必須ではありません。未指定時のインストール先は/usr/local/pgsqlです。</li>
 138 </ul>
 139 <p>RPMからPostgreSQLをインストールしてもpg_bigmは利用可能です。 この場合、postgresql-develパッケージをインストールしなければならないことに注意してください。</p>
 140
 141 <h3 id="bigm_install">pg_bigmのインストール</h3>
 142 <p><a href="http://osdn.jp/projects/pgbigm/releases/?package_id=13634">ここ</a>からpg_bigmのソースアーカイブファイルをダウンロードし、ビルドとインストールを行います。</p>
 143 <pre>
 144 $ tar zxf pg_bigm-x.y-YYYYMMDD.tar.gz
 145 $ cd pg_bigm-x.y-YYYYMMDD
 146 $ make USE_PGXS=1 PG_CONFIG=/opt/pgsql-X.Y.Z/bin/pg_config
 147 $ su
 148 # make USE_PGXS=1 PG_CONFIG=/opt/pgsql-X.Y.Z/bin/pg_config install
 149 # exit
 150 </pre>
 151 <ul>
 152 <li>USE_PGXS : PostgreSQL関連モジュールをコンパイルするときのオマジナイです。USE_PGXS=1の指定が必須です。</li>
 153 <li>PG_CONFIG : <a href="http://www.postgresql.jp/document/current/html/app-pgconfig.html">pg_config</a>コマンド(PostgreSQLインストール先のbinディレクトリに存在)のパスを指定します。pg_configにPATHが通っているのであれば、このオプション指定は不要です。</li>
 154 </ul>
 155
 156 <h3 id="bigm_register">pg_bigmの登録</h3>
 157 <p>データベースクラスタの作成後、postgresql.confを編集、PostgreSQLを起動し、pg_bigmをデータベースに登録します。</p>
 158 <pre>
 159 $ initdb -D $PGDATA --locale=C --encoding=UTF8
 160
 161 $ vi $PGDATA/postgresql.conf
 162 shared_preload_libraries = 'pg_bigm'
 163 custom_variable_classes = 'pg_bigm'
 164
 165 $ pg_ctl -D $PGDATA start
 166 $ psql -d &lt;データベース名&gt;
 167 =# CREATE EXTENSION pg_bigm;
 168 =# \dx pg_bigm
 169                     List of installed extensions
 170   Name   | Version | Schema |              Description
 171 ---------+---------+--------+---------------------------------------
 172  pg_bigm | 1.0     | public | text index searching based on bigrams
 173 (1 row)
 174 </pre>
 175
 176 <ul>
 177 <li>$PGDATAは、データベースクラスタのパスを決めて、そのパスで置き換えてください。</li>
 178 <li>pg_bigmは、PostgreSQLで利用できるすべてのエンコーディングとロケールをサポートしています。</li>
 179 <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を設定するのは必須です。
 180   <ul>
 181     <li>PostgreSQL9.2以降ではcustom_variable_classesは存在しません。設定が必要なのはshared_preload_librariesだけです。</li>
 182   </ul>
 183 </li>
 184 <li>pg_bigmの登録には、<a href="http://www.postgresql.jp/document/current/html/sql-createextension.html">CREATE EXTENSION</a>を使います。 CREATE EXTENSIONはデータベース単位でモジュールを登録するため、pg_bigmを利用したいデータベースすべてにおいて登録が必要です。</li>
 185 <li>pg_bigmとPostgreSQL付属のcontribモジュールpg_trgmを同じデータベース内で共存させることはできません。 pg_bigmを登録するデータベースには、pg_trgmを同時に登録しないでください。</li>
 186 </ul>
 187 <p>pg_bigmのインストールは以上で終わりです。</p>
 188
 189
 190 <h2 id="uninstall">アンインストール</h2>
 191
 192 <h3 id="bigm_uninstall">pg_bigmの削除</h3>
 193 <p>pg_bigmについて、データベースからの登録解除とアンインストールを行います。</p>
 194 <pre>
 195 $ psql -d &lt;データベース名&gt;
 196 =# DROP EXTENSION pg_bigm CASCADE;
 197 =# \q
 198
 199 $ pg_ctl -D $PGDATA stop
 200 $ su
 201
 202 # cd &lt;pg_bigmのソースディレクトリ&gt;
 203 # make USE_PGXS=1 PG_CONFIG=/opt/pgsql-X.Y.Z/bin/pg_config uninstall
 204 # exit
 205 </pre>
 206
 207 <ul>
 208 <li>pg_bigmを登録したすべてのデータベースで登録解除する必要があります。</li>
 209 <li>pg_bigmに依存するDBオブジェクト(例えば、pg_bigmを使った全文検索インデックス)を削除する必要があるため、<a href="http://www.postgresql.jp/document/current/html/sql-dropextension.html">DROP EXTENSION</a>にはCASCADEを指定します。</li>
 210 </ul>
 211
 212 <h3 id="delete_conf">postgresql.confの設定削除</h3>
 213 <p>postgresql.confの以下の設定を削除します</p>
 214 <ul>
 215 <li>shared_preload_libraries</li>
 216 <li>custom_variable_classes</li>
 217 <li>pg_bigm.* (pg_bigm.から名前が始まるパラメータ)</li>
 218 </ul>
 219
 220 <h2 id="fulltext_search">全文検索機能</h2>
 221
 222 <h3 id="create_index">インデックスの作成</h3>
 223 <p>GINインデックスを利用して全文検索用のインデックスを作成します。</p>
 224 <p>以下の実行例では、PostgreSQL関連ツールの名前と説明を管理するテーブルpg_toolsを作成し、4件データを投入します。その後、ツールの説明に対して全文検索用のインデックスを作成します。</p>
 225
 226 <pre>
 227 =# CREATE TABLE pg_tools (tool text, description text);
 228
 229 =# INSERT INTO pg_tools VALUES ('pg_hint_plan', 'PostgreSQLでHINT句を使えるようにするツール');
 230 =# INSERT INTO pg_tools VALUES ('pg_dbms_stats', 'PostgreSQLの統計情報を固定化するツール');
 231 =# INSERT INTO pg_tools VALUES ('pg_bigm', 'PostgreSQLで2-gramの全文検索を使えるようにするツール');
 232 =# INSERT INTO pg_tools VALUES ('pg_trgm', 'PostgreSQLで3-gramの全文検索を使えるようにするツール');
 233
 234 =# CREATE INDEX pg_tools_idx ON pg_tools USING gin (description gin_bigm_ops);
 235 </pre>
 236
 237 <ul>
 238 <li>インデックスメソッドにはginの指定が必須です。 pg_bigmでは、pg_trgmとは異なりインデックス作成にGiSTを使えません。</li>
 239 <li>演算子クラスにはgin_bigm_opsの指定が必須です。</li>
 240 </ul>
 241
 242 <p>また、以下の実行例のように、全文検索用のマルチカラムインデックスを作成したり、作成時にGINインデックスのパラメータを指定することもできます。</p>
 243
 244 <pre>
 245 =# CREATE INDEX pg_tools_multi_idx ON pg_tools USING gin (tool gin_bigm_ops, description gin_bigm_ops) WITH (FASTUPDATE = off);
 246 </pre>
 247
 248 <h3 id="do_fulltext_search">全文検索の実行</h3>
 249 <p>pg_bigmでは、LIKE演算子の中間一致検索により全文検索を行います。</p>
 250 <pre>
 251 =# SELECT * FROM pg_tools WHERE description LIKE '%全文検索%';
 252   tool   |                     description
 253 ---------+------------------------------------------------------
 254  pg_bigm | PostgreSQLで2-gramの全文検索を使えるようにするツール
 255  pg_trgm | PostgreSQLで3-gramの全文検索を使えるようにするツール
 256 (2 rows)
 257 </pre>
 258 <ul>
 259 <li>検索文字列は<a href="#likequery">likequery</a>に記載されているとおり、全文検索用に変換されなければなりません。</li>
 260 </ul>
 261
 262 <h2 id="functions">提供関数</h2>
 263 <h3 id="likequery">likequery</h3>
 264 <p>likequeryは、全文検索できるように、検索文字列(引数1)をLIKE演算子のパターンに変換する関数です。</p>
 265 <ul>
 266 <li>引数1(text) - 検索文字列</li>
 267 <li>戻り値(text) - 全文検索用に、引数1をLIKE演算子のパターンに変換した文字列</li>
 268 </ul>
 269
 270 <p>引数1がNULLの場合、戻り値はNULLです。</p>
 271
 272 <p>変換は、具体的には以下を行います。</p>
 273 <ul>
 274 <li>検索文字列の先頭と末尾に%(半角パーセント)を追加</li>
 275 <li>検索文字列内の%(半角パーセント)、_(半角アンダースコア)、\(半角バックスラッシュ)を\(半角バックスラッシュ)でエスケープ</li>
 276 </ul>
 277
 278 <p>pg_bigmでは、LIKE演算子の中間一致検索により全文検索を行います。このため、上記のとおり検索文字列を変換して、LIKE演算子に渡す必要があります。この変換は、通常、クライアントアプリケーション側で実装しなければなりません。しかし、likequeryを利用することで、その実装の手間を省くことができます。</p>
 279
 280 <pre>
 281 =# SELECT likequery('pg_bigmは検索性能を200%向上させました。');
 282                   likequery
 283 ---------------------------------------------
 284  %pg\_bigmは検索性能を200\%向上させました。%
 285 (1 row)
 286 </pre>
 287
 288 <p>「全文検索の実行」の実行例の検索SQLは、likequeryを使うことで、以下のように書き換えられます。</p>
 289 <pre>
 290 =# SELECT * FROM pg_tools WHERE description LIKE likequery('全文検索');
 291   tool   |                     description
 292 ---------+------------------------------------------------------
 293  pg_bigm | PostgreSQLで2-gramの全文検索を使えるようにするツール
 294  pg_trgm | PostgreSQLで3-gramの全文検索を使えるようにするツール
 295 (2 rows)
 296 </pre>
 297
 298 <h3 id="show_bigm">show_bigm</h3>
 299 <p>show_bigmは、文字列(引数1)のすべての2-gram文字列を配列として表示する関数です。</p>
 300
 301 <ul>
 302 <li>引数1(text) - 文字列</li>
 303 <li>戻り値(text[]) - 引数1のすべての2-gram文字列から構成される配列</li>
 304 </ul>
 305
 306 <p>2-gram文字列とは、文字列の先頭と末尾に空白文字を追加した上で、文字列を1文字ずつずらしながら、2文字単位で抽出した文字列のことです。例えば、文字列「ABC」の2-gram文字列は、「(空白)A」「AB」「BC」「C(空白)」の4つになります。</p>
 307
 308 <pre>
 309 =#  SELECT show_bigm('PostgreSQLの全文検索');
 310                             show_bigm
 311 -----------------------------------------------------------------
 312  {の全,全文,文検,検索,"索 "," P",Lの,Po,QL,SQ,eS,gr,os,re,st,tg}
 313 (1 row)
 314 </pre>
 315
 316 <h3 id="pg_gin_pending_stats">pg_gin_pending_stats</h3>
 317 <p>pg_gin_pending_statsは、GINインデックス(引数1)の待機リストに含まれているデータのページ数とタプル数を返却する関数です。</p>
 318
 319 <ul>
 320 <li>引数1(regclass) - GINインデックスの名前もしくはOID</li>
 321 <li>戻り値1(integer) - GINインデックス(引数1)の待機リストに含まれているデータのページ数</li>
 322 <li>戻り値2(bigint) - GINインデックス(引数1)の待機リストに含まれているデータのタプル数</li>
 323 </ul>
 324
 325 <p>
 326 FASTUPDATEオプション無効で作成されたGINインデックスが引数1の場合、そのGINインデックスは待機リストを持たないため、戻り値1と2は0となることに注意してください。
 327 GINインデックスの待機リストとFASTUPDATEオプションの詳細は、<a href="http://www.postgresql.jp/document/current/html/gin-implementation.html#GIN-FAST-UPDATE">GIN高速更新手法</a>を参照してください。
 328 </p>
 329
 330 <pre>
 331 =# SELECT * FROM pg_gin_pending_stats('pg_tools_idx');
 332  pages | tuples
 333 -------+--------
 334      1 |      4
 335 (1 row)
 336 </pre>
 337
 338 <h2 id="parametares">パラメータ</h2>
 339 <h3 id="last_update">pg_bigm.last_update</h3>
 340 <p>pg_bigm.last_updateは、pg_bigmモジュールの最終更新日付を報告するパラメータです。このパラメータは読み取り専用です。 postgresql.confやSET文で設定値を変更することはできません。</p>
 341 <pre>
 342 =# SHOW pg_bigm.last_update;
 343  pg_bigm.last_update
 344 ---------------------
 345  2013.11.22
 346 (1 row)
 347 </pre>
 348
 349 <h3 id="enable_recheck">pg_bigm.enable_recheck</h3>
 350 <p>pg_bigm.enable_recheckは、全文検索の内部処理であるRecheckを行うかどうか指定するパラメータです。デフォルト値はonで、Recheckを行います。このパラメータは、postgresql.confとSET文(スーパーユーザに限らずどのユーザからでも)で設定値を変更できます。全文検索において正しい検索結果を得るには、このパラメータは有効化されていなければなりません。</p>
 351
 352 <p>pg_bigmを使った全文検索では、内部的には以下2つの処理で検索結果が取得されます。</p>
 353
 354 <ul>
 355 <li>全文検索インデックスからの検索結果候補の取得</li>
 356 <li>検索結果候補からの正しい検索結果の選択</li>
 357 </ul>
 358
 359 <p>この後者の処理がRecheckと呼ばれます。全文検索インデックスからの検索結果の取得では、必ずしも正しい結果ばかりが得られるとは限りません。誤った結果が含まれる可能性があります。この誤った結果を取り除くのがRecheckになります。</p>
 360
 361 <p>例えば、テーブルに「ここは東京都」「東京と京都に行く」の2つの文字列が格納されている状況を想像してください。検索文字列「東京都」で検索した場合、正しい結果は「ここは東京都」です。しかし、全文検索インデックスからの結果取得では、「東京と京都に行く」も結果候補として取得できてしまいます。これは、検索文字列の2-gram文字列である「東京」と「京都」が「東京と京都に行く」に含まれているためです。 Recheckは、結果候補それぞれについて検索文字列「東京都」が含まれるのか再チェックを行い、正しい結果だけを選択します。</p>
 362
 363 <p>このRecheckによる検索結果の絞り込みの様子は、EXPLAIN ANALYZEの結果から確認できます。</p>
 364
 365 <pre>
 366 =# CREATE TABLE tbl (doc text);
 367 =# INSERT INTO tbl VALUES('ここは東京都');
 368 =# INSERT INTO tbl VALUES('東京と京都に行く');
 369 =# CREATE INDEX tbl_idx ON tbl USING gin (doc gin_bigm_ops);
 370 =# SET enable_seqscan TO off;
 371 =# EXPLAIN ANALYZE SELECT * FROM tbl WHERE doc LIKE likequery('東京都');
 372                                                    QUERY PLAN
 373 -----------------------------------------------------------------------------------------------------------------
 374  Bitmap Heap Scan on tbl  (cost=12.00..16.01 rows=1 width=32) (actual time=0.022..0.023 rows=1 loops=1)
 375    Recheck Cond: (doc ~~ '%東京都%'::text)
 376    -&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)
 377          Index Cond: (doc ~~ '%東京都%'::text)
 378  Total runtime: 0.059 ms
 379 (5 rows)
 380 </pre>
 381
 382 <p>Bitmap Index Scanのrowsは2となっており、全文検索インデックスからは2件結果を取得しています。 Recheck実行後のBitmap Heap Scanのrowsは1となっており、2件の結果候補から1件に絞り込まれた様子を確認できます。</p>
 383
 384 <p>pg_bigm.enable_recheckを無効化することで、Recheckをスキップさせ、全文検索インデックスから取得した結果候補をそのまま最終的な検索結果とすることができます。以下の実行例では、このパラメータの無効化により、誤った検索結果の「東京と京都に行く」を得られています。</p>
 385
 386 <pre>
 387 =# SELECT * FROM tbl WHERE doc LIKE likequery('東京都');
 388      doc
 389 --------------
 390  ここは東京都
 391 (1 row)
 392
 393 =# SET pg_bigm.enable_recheck TO off;
 394 =# SELECT * FROM tbl WHERE doc LIKE likequery('東京都');
 395        doc
 396 ------------------
 397  ここは東京都
 398  東京と京都に行く
 399 (2 rows)
 400 </pre>
 401
 402 <p>このパラメータは、正しい検索結果を得る必要がある運用時には必ずonに設定されていなければなりません。一方、Recheckのオーバーヘッドを評価するなど、デバッグ時にoffに設定しても構いません。</p>
 403
 404 <h3 id="gin_key_limit">pg_bigm.gin_key_limit</h3>
 405 <p>pg_bigm.gin_key_limitは、検索文字列の2-gram文字列のうち最大で何個を全文検索インデックスの検索に使うか指定するパラメータです。設定値が0(デフォルト値)の場合は、検索文字列のすべての2-gram文字列をインデックス検索に使います。このパラメータは、postgresql.confとSET文(スーパーユーザに限らずどのユーザからでも)で設定値を変更できます。</p>
 406
 407 <p>pg_bigmの全文検索では、基本的に、検索文字列のすべての2-gram文字列を使ってGINインデックスを検索します。ただし、現在のGINインデックスの実装では、検索に使う2-gram文字列の個数が多いほどインデックス検索の負荷は高くなります。このため、検索文字列の文字数が多く、2-gram文字列の個数が多くなりやすいシステムでは、検索性能は劣化しやすいです。 pg_bigm.gin_key_limitによりGINインデックスの検索に使う2-gram文字列の最大数を制限することで、この性能問題を解決できます。</p>
 408
 409 <p>ただし、インデックス検索に使う2-gram文字列の個数が減ると、インデックスから取得した検索結果候補にはより多くの誤った結果が含まれることになります。このため、Recheckの負荷が高まり、逆に、より性能劣化する可能性もあるため注意が必要です。</p>
 410
 411 <h2 id="limitations">制約</h2>
 412 <h3 id="indexed_column_size">インデックス作成が可能な列の最大サイズ</h3>
 413
 414 <p>pg_bigmでは、列サイズが107,374,180Byte (約102MB)を越える列へインデックスを作成できません。制限を越える大きさのデータを挿入するとエラーを起こします。</p>
 415
 416 <pre>
 417 =# CREATE TABLE t1 (description text);
 418 =# CREATE INDEX t1_idx ON t1 USING gin (description gin_bigm_ops);
 419 =# INSERT INTO t1 SELECT repeat('A', 107374181);
 420 ERROR:  out of memory
 421 </pre>
 422
 423 <p>この制約はpg_trgmにも存在しますが、pg_trgmでは最大238,609,291Byte (約228MB)までインデックスの作成が可能です。</p>
 424
 425
 426 <h2 id="release_notes">リリースノート</h2>
 427 <ul>
 428 <li><a href="release-1-0.html">バージョン1.0</a></li>
 429 </ul>
 430
 431 <hr>
 432 <div align="right">Copyright (c) 2017-2020, pg_bigm Development Group</div>
 433 <div align="right">Copyright (c) 2012-2016, NTT DATA Corporation</div>
 434
 435 </body>
 436 </html>
 437