html/pg_bigm_en-1-1.html

   1 <html>
   2 <head>
   3 <title>pg_bigm 1.1 Document</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_en.html">Home</a></li>
  13       <li><a href="http://en.sourceforge.jp/projects/pgbigm/releases/?package_id=13634">Download</a></li>
  14       <li><a href="index_en.html#document">Document</a></li>
  15       <li><a href="index_en.html#community">Community</a></li>
  16       <li><a href="index_en.html#development">Development</a></li>
  17       <li><a href="pg_bigm-1-1.html">日本語</a></li>
  18     </ul>
  19   </div>
  20
  21 <h1 id="pg_bigm">Document (Release 1.1)</h1>
  22
  23 <div class="index">
  24 <ol>
  25 <li><a href="#description">Overview</a></li>
  26 <li><a href="#pg_trgm">Comparison with pg_trgm</a></li>
  27 <li><a href="#requirement">Tested platforms</a></li>
  28 <li><a href="#install">Install</a></li>
  29 <li><a href="#uninstall">Uninstall</a></li>
  30 <li><a href="#fulltext_search">Full text search</a></li>
  31 <li><a href="#functions">Functions</a></li>
  32 <li><a href="#parametares">Parameters</a></li>
  33 <li><a href="#limitations">Limitations</a></li>
  34 <li><a href="#release_notes">Release Notes</a></li>
  35 </ol>
  36 </div>
  37
  38 <h2 id="description">Overview</h2>
  39 <p>The pg_bigm module provides full text search capability in <a href="http://www.postgresql.org/">PostgreSQL</a>. This module allows a user to create <b>2-gram</b> (bigram) index for faster full text search.</p>
  40 <p>The <a href="http://en.sourceforge.jp/projects/pgbigm/">pg_bigm project</a> provides the following one module.</p>
  41
  42 <table>
  43 <thead>
  44 <tr>
  45 <th>Module</th><th>Description</th><th>Source Archive File Name</th>
  46 </tr>
  47 </thead>
  48 <tbody>
  49 <tr><td>pg_bigm</td>
  50   <td nowrap>Module that provides full text search capability in PostgreSQL</td>
  51   <td>pg_bigm-x.y-YYYYMMDD.tar.gz</td></tr>
  52 </tbody>
  53 </table>
  54
  55 <p>
  56 The x.y and YYYYMMDD parts of the source archive file name are replaced with its release version number and date, respectively.
  57 For example, x.y is 1.1 and YYYYMMDD is 20131122 if the file of the version 1.1 was released on November 22, 2013.
  58 </p>
  59 <p>The license of pg_bigm is <a href="http://opensource.org/licenses/postgresql">The PostgreSQL License</a> (same as BSD license).</p>
  60
  61 <h2 id="pg_trgm">Comparison with pg_trgm</h2>
  62 <p>The <a href="http://www.postgresql.jp/document/current/html/pgtrgm.html">pg_trgm</a> contrib module which provides full text search capability using 3-gram (trigram) model is included in PostgreSQL. The pg_bigm was developed based on the pg_trgm. They have the following differences:</p>
  63
  64 <table>
  65 <thead>
  66 <tr>
  67 <th>Functionalities and Features</th><th>pg_trgm</th><th>pg_bigm</th>
  68 </tr>
  69 </thead>
  70 <tbody>
  71 <tr><td>Phrase matching method for full text search</td>
  72   <td nowrap>3-gram</td>
  73   <td>2-gram</td></tr>
  74 <tr><td>Available index</td>
  75   <td nowrap>GIN and GiST</td>
  76   <td>GIN only</td></tr>
  77 <tr><td>Full text search for non-alphabetic language<br>(e.g., Japanese)</td>
  78   <td nowrap>Not supported (*1)</td>
  79   <td>Supported</td></tr>
  80 <tr><td>Full text search with 1-2 characters keyword</td>
  81   <td nowrap>Slow (*2)</td>
  82   <td>Fast</td></tr>
  83 <tr><td>Similarity search</td>
  84   <td nowrap>Supported</td>
  85   <td>Supported (version 1.1 or later)</td></tr>
  86 <tr><td>Maximum indexed column size</td>
  87   <td nowrap>238,609,291 Bytes (~228MB)</td>
  88   <td nowrap>71,582,785 Bytes (~68MB)</td></tr>
  89 </tbody>
  90 </table>
  91
  92 <ul>
  93 <li>(*1) You can use full text search for non-alphabetic language by commenting out KEEPONLYALNUM macro variable in contrib/pg_trgm/pg_trgm.h and rebuilding pg_trgm module. But pg_bigm provides faster non-alphabetic search than such a modified pg_trgm.</li>
  94 <li>(*2) Because, in this search, only sequential scan or index full scan (not normal index scan) can run.</li>
  95 </ul>
  96
  97 <p>pg_bigm 1.1 or later can coexist with pg_trgm in the same database, but pg_bigm 1.0 cannot.</p>
  98
  99 <h2 id="requirement">Tested platforms</h2>
 100 <p>pg_bigm has been built and tested on the following platforms:</p>
 101 <table>
 102 <thead>
 103 <tr>
 104 <th>Category</th><th>Module Name</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 requires PostgreSQL 9.1 or later.</p>
 120
 121 <h2 id="install">Install</h2>
 122
 123 <h3 id="pg_install">Install PostgreSQL</h3>
 124 <p>From the <a href="http://www.postgresql.org/">official site of PostgreSQL</a> download the source archive file "postgresql-X.Y.Z.tar.gz (please replace X.Y.Z with actual version number)" of PostgreSQL, and then build and install it.</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 : Specify the PostgreSQL installation directory. This is optional. By default, PostgreSQL is installed in /usr/local/pgsql.</li>
 135 </ul>
 136 <p>If PostgreSQL is installed from RPM, the postgresql-devel package must be installed to build pg_bigm.</p>
 137
 138 <h3 id="bigm_install">Install pg_bigm</h3>
 139 <p>Download the source archive file of pg_bigm from <a href="http://en.sourceforge.jp/projects/pgbigm/releases/?package_id=13634">here</a>, and then build and install it.</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 : USE_PGXS=1 must be always specified when building pg_bigm.</li>
 150 <li>PG_CONFIG : Specify the path to <a href="http://www.postgresql.org/docs/current/static/app-pgconfig.html">pg_config</a> (which exists in the bin directory of PostgreSQL installation). If the PATH environment variable contains the path to pg_config, PG_CONFIG doesn't need to be specified.</li>
 151 </ul>
 152
 153 <h3 id="bigm_register">Load pg_bigm</h3>
 154 <p>Create the database cluster, modify postgresql.conf, start PostgreSQL server and then load pg_bigm into the database.</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;database name&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>Replace $PGDATA with the path to database cluster.</li>
 175 <li>pg_bigm supports all PostgreSQL encoding and locale.</li>
 176 <li>In postgresql.conf, pg_bigm must be added into <a href="http://www.postgresql.org/docs/current/static/runtime-config-resource.html#GUC-SHARED-PRELOAD-LIBRARIES">shared_preload_libraries</a> and <a href="http://www.postgresql.org/docs/current/static/runtime-config-custom.html#GUC-CUSTOM-VARIABLE-CLASSES">custom_variable_classes</a>.
 177   <ul>
 178     <li>In PostgreSQL 9.2 or later, you need to set only shared_preload_libraries because custom_variable_classes doesn't exist.</li>
 179   </ul>
 180 </li>
 181 <li><a href="http://www.postgresql.org/docs/current/static/sql-createextension.html">CREATE EXTENSION</a> pg_bigm needs to be executed in all the databases that you want to use pg_bigm in.</li>
 182 </ul>
 183
 184
 185 <h2 id="uninstall">Uninstall</h2>
 186
 187 <h3 id="bigm_uninstall">Delete pg_bigm</h3>
 188 <p>Unload pg_bigm from the database and then uninstall it.</p>
 189 <pre>
 190 $ psql -d &lt;database name&gt;
 191 =# DROP EXTENSION pg_bigm CASCADE;
 192 =# \q
 193
 194 $ pg_ctl -D $PGDATA stop
 195 $ su
 196
 197 # cd &lt;pg_bigm source directory&gt;
 198 # make USE_PGXS=1 PG_CONFIG=/opt/pgsql-X.Y.Z/bin/pg_config uninstall
 199 # exit
 200 </pre>
 201
 202 <ul>
 203 <li>pg_bigm needs to be unloaded from all the databases that it was loaded into.</li>
 204 <li><a href="http://www.postgresql.org/docs/current/static/sql-dropextension.html">DROP EXTENSION</a> pg_bigm needs to be executed with CASCADE option to delete all the database objects which depend on pg_bigm, e.g., pg_bigm full text search index.</li>
 205 </ul>
 206
 207 <h3 id="delete_conf">Reset postgresql.conf</h3>
 208 <p>Delete the following pg_bigm related settings from postgresql.conf.</p>
 209 <ul>
 210 <li>shared_preload_libraries</li>
 211 <li>custom_variable_classes</li>
 212 <li>pg_bigm.* (parameters which begin with pg_bigm)</li>
 213 </ul>
 214
 215 <h2 id="fulltext_search">Full text search</h2>
 216
 217 <h3 id="create_index">Create Index</h3>
 218 <p>You can create an index for full text search by using GIN index.</p>
 219 <p>The following example creates the table <i>pg_tools</i> which stores the name and description of PostgreSQL related tool, inserts four records into the table, and then creates the full text search index on the <i>description</i> column.</p>
 220
 221 <pre>
 222 =# CREATE TABLE pg_tools (tool text, description text);
 223
 224 =# INSERT INTO pg_tools VALUES ('pg_hint_plan', 'Tool that allows a user to specify an optimizer HINT to PostgreSQL');
 225 =# INSERT INTO pg_tools VALUES ('pg_dbms_stats', 'Tool that allows a user to stabilize planner statistics in PostgreSQL');
 226 =# INSERT INTO pg_tools VALUES ('pg_bigm', 'Tool that provides 2-gram full text search capability in PostgreSQL');
 227 =# INSERT INTO pg_tools VALUES ('pg_trgm', 'Tool that provides 3-gram full text search capability in PostgreSQL');
 228
 229 =# CREATE INDEX pg_tools_idx ON pg_tools USING gin (description gin_bigm_ops);
 230 </pre>
 231
 232 <ul>
 233 <li><b>gin</b> must be used as an index method. GiST is not available for pg_bigm.</li>
 234 <li><b>gin_bigm_ops</b> must be used as an operator class.</li>
 235 </ul>
 236
 237 <p>You can also create multicolumn pg_bigm index and specify GIN related parameters then, as follows.</p>
 238
 239 <pre>
 240 =# CREATE INDEX pg_tools_multi_idx ON pg_tools USING gin (tool gin_bigm_ops, description gin_bigm_ops) WITH (FASTUPDATE = off);
 241 </pre>
 242
 243 <h3 id="do_fulltext_search">Execute full text search</h3>
 244 <p>You can execute full text search by using LIKE pattern matching.</p>
 245 <pre>
 246 =# SELECT * FROM pg_tools WHERE description LIKE '%search%';
 247   tool   |                             description
 248 ---------+---------------------------------------------------------------------
 249  pg_bigm | Tool that provides 2-gram full text search capability in PostgreSQL
 250  pg_trgm | Tool that provides 3-gram full text search capability in PostgreSQL
 251 (2 rows)
 252 </pre>
 253 <ul>
 254 <li>The search keyword must be specified as the pattern string that LIKE operator can handle properly, as discussed in <a href="#likequery">likequery</a>.</li>
 255 </ul>
 256
 257 <h3 id="similarity_search">Execute similarity search</h3>
 258 <p>You can execute similarity search by using =% operator.</p>
 259 <p>The following query returns all values in the tool column that are sufficiently similar to the word 'bigm'. This similarity search is basically fast because it can use the full text search index. It measures whether two strings are sufficiently similar to by seeing whether their similarity is higher than or equal to the value of <a href="#similarity_limit">pg_bigm.similarity_limit</a>. This means, in this query, that the values whose similarity with the word 'bigm' is higher than or equal to 0.2 are only 'pg_bigm' and 'pg_trgm' in the tool column.</p>
 260 <pre>
 261 =# SET pg_bigm.similarity_limit TO 0.2;
 262
 263 =# SELECT tool FROM pg_tools WHERE tool =% 'bigm';
 264   tool
 265 ---------
 266  pg_bigm
 267  pg_trgm
 268 (2 rows)
 269 </pre>
 270 <p>
 271 Please see <a href="#bigm_similarity">bigm_similarity</a> function for details of how to calculate the similarity.
 272 </p>
 273
 274 <h2 id="functions">Functions</h2>
 275 <h3 id="likequery">likequery</h3>
 276 <p>likequery is a function that converts the search keyword (argument #1) into the pattern string that LIKE operator can handle properly.</p>
 277 <ul>
 278 <li>Argument #1 (text) - search keyword</li>
 279 <li>Return value (text) - pattern string that was converted from argument #1 so that LIKE operator can handle properly</li>
 280 </ul>
 281
 282 <p>If the argument #1 is NULL, the return value is also NULL.</p>
 283
 284 <p>This function does the conversion as follows:</p>
 285 <ul>
 286 <li>appends % (single-byte percent) into both the beginning and the end of the search keyword.</li>
 287 <li>escapes the characters % (single-byte percent), _ (single-byte underscore) and \ (single-byte backslash) in the search keyword by using \ (single-byte backslash).</li>
 288 </ul>
 289
 290 <p>In pg_bigm, full text search is performed by using LIKE pattern matching. Therefore, the search keyword needs to be converted into the pattern string that LIKE operator can handle properly. Usually a client application should be responsible for this conversion. But, you can save the effort of implementing such a conversion logic in the application by using likequery function.</p>
 291
 292 <pre>
 293 =# SELECT likequery('pg_bigm has improved the full text search performance by 200%');
 294                              likequery
 295 -------------------------------------------------------------------
 296  %pg\_bigm has improved the full text search performance by 200\%%
 297 (1 row)
 298 </pre>
 299
 300 <p>Using likequery, you can rewrite the full text search query which was used in the example in "Execute full text search" into:</p>
 301 <pre>
 302 =# SELECT * FROM pg_tools WHERE description LIKE likequery('search');
 303   tool   |                             description
 304 ---------+---------------------------------------------------------------------
 305  pg_bigm | Tool that provides 2-gram full text search capability in PostgreSQL
 306  pg_trgm | Tool that provides 3-gram full text search capability in PostgreSQL
 307 (2 rows)
 308 </pre>
 309
 310 <h3 id="show_bigm">show_bigm</h3>
 311 <p>show_bigm returns an array of all the 2-grams in the given string (argument #1).</p>
 312
 313 <ul>
 314 <li>Argument #1 (text) - character string</li>
 315 <li>Return value (text[]) - an array of all the 2-grams in argument #1</li>
 316 </ul>
 317
 318 <p>A 2-gram that show_bigm returns is a group of two consecutive characters taken from a string that blank character has been appended into the beginning and the end. For example, the 2-grams of the string "ABC" are "(blank)A" "AB" "BC" "C(blank)".</p>
 319
 320 <pre>
 321 =# SELECT show_bigm('full text search');
 322                             show_bigm
 323 ------------------------------------------------------------------
 324  {" f"," s"," t",ar,ch,ea,ex,fu,"h ","l ",ll,rc,se,"t ",te,ul,xt}
 325 (1 row)
 326 </pre>
 327
 328 <h3 id="bigm_similarity">bigm_similarity</h3>
 329 <p>bigm_similarity returns a number that indicates how similar the two strings (argument #1 and #2) are.</p>
 330
 331 <ul>
 332 <li>Argument #1 (text) - character string</li>
 333 <li>Argument #2 (text) - character string</li>
 334 <li>Return value (real) - the similarity of two arguments</li>
 335 </ul>
 336
 337 <p>
 338 This function measures the similarity of two strings by counting the number of 2-grams they share. The range of the similarity is zero (indicating that the two strings are completely dissimilar) to one (indicating that the two strings are identical).
 339 </p>
 340
 341 <pre>
 342 =# SELECT bigm_similarity('full text search', 'text similarity search');
 343  bigm_similarity
 344 -----------------
 345         0.571429
 346 (1 row)
 347 </pre>
 348
 349 <p>
 350 Note that each argument is considered to have one space prefixed and suffixed when determining the set of 2-grams contained in the string for calculation of similarity.
 351 For example, though the string "ABC" contains the string "B", their similarity is 0 because there are no 2-grams they share as follows.
 352 On the other hand, the string "ABC" and "A" share one 2-gram "(blank)A" as follows, so their similarity is higher than 0.
 353 This is basically the same behavior as pg_trgm's similarity function.
 354
 355 <ul>
 356 <li>The 2-grams of the string "ABC" are "(blank)A" "AB" "BC" "C(blank)".</li>
 357 <li>The 2-grams of the string "A" are "(blank)A" "A(blank)".</li>
 358 <li>The 2-grams of the string "B" are "(blank)B" "B(blank)".</li>
 359 </ul>
 360 </p>
 361
 362 <pre>
 363 =# SELECT bigm_similarity('ABC', 'A');
 364  bigm_similarity
 365 -----------------
 366             0.25
 367 (1 row)
 368
 369 =# SELECT bigm_similarity('ABC', 'B');
 370  bigm_similarity
 371 -----------------
 372                0
 373 (1 row)
 374 </pre>
 375
 376 <p>
 377 Note that bigm_similarity is NOT case-sensitive, but pg_trgm's similarity function is case-sensitive.
 378 For example, the similarity of the strings "ABC" and "abc" is 1 in pg_trgm's similarity function but 0 in bigm_similarity.
 379 </p>
 380
 381 <pre>
 382 =# SELECT similarity('ABC', 'abc');
 383  similarity
 384 ------------
 385           1
 386 (1 row)
 387
 388 =# SELECT bigm_similarity('ABC', 'abc');
 389  bigm_similarity
 390 -----------------
 391                0
 392 (1 row)
 393 </pre>
 394
 395 <h3 id="pg_gin_pending_stats">pg_gin_pending_stats</h3>
 396 <p>pg_gin_pending_stats is a function that returns the number of pages and tuples in the pending list of GIN index.</p>
 397
 398 <ul>
 399 <li>Argument #1 (regclass) - Name or OID of GIN index</li>
 400 <li>Return value #1 (integer) - Number of pages in the pending list</li>
 401 <li>Return value #2 (bigint) - Number of tuples in the pending list</li>
 402 </ul>
 403
 404 <p>
 405 Note that the return value #1 and #2 are 0 if the argument #1 is the GIN index built with FASTUPDATE option disabled because it doesn't have a pending list.
 406 Please see <a href="http://www.postgresql.org/docs/current/static/gin-implementation.html#GIN-FAST-UPDATE">GIN Fast Update Technique</a> for details of the pending list and FASTUPDATE option.
 407 </p>
 408
 409 <pre>
 410 =# SELECT * FROM pg_gin_pending_stats('pg_tools_idx');
 411  pages | tuples
 412 -------+--------
 413      1 |      4
 414 (1 row)
 415 </pre>
 416
 417 <h2 id="parametares">Parameters</h2>
 418 <h3 id="last_update">pg_bigm.last_update</h3>
 419 <p>pg_bigm.last_update is a parameter that reports the last updated date of the pg_bigm module. This parameter is read-only. You cannot change the value of this parameter at all.</p>
 420
 421 <pre>
 422 =# SHOW pg_bigm.last_update;
 423  pg_bigm.last_update
 424 ---------------------
 425  2013.11.22
 426 (1 row)
 427 </pre>
 428
 429 <h3 id="enable_recheck">pg_bigm.enable_recheck</h3>
 430 <p>pg_bigm.enable_recheck is a parameter that specifies whether to perform Recheck which is an internal process of full text search. The default value is on, i.e., Recheck is performed. Not only superuser but also any user can change this parameter value in postgresql.conf or by using SET command. This parameter must be enabled if you want to obtain the correct search result.</p>
 431
 432 <p>PostgreSQL and pg_bigm internally perform the following processes to get the search results:</p>
 433
 434 <ul>
 435 <li>retrieve the result candidates from full text search index.</li>
 436 <li>choose the correct search results from the candidates.</li>
 437 </ul>
 438
 439 <p>The latter process is called Recheck. The result candidates retrieved from full text search index may contain wrong results. Recheck process gets rid of such wrong results.</p>
 440
 441 <p>For example, imagine the case where two character strings "He is awaiting trial" and "It was a trivial mistake" are stored in a table. The correct search result with the keyword "trial" is "He is awaiting trial". However, "It was a trivial mistake" is also retrieved as the result candidate from the full text search index because it contains all the 2-grams ("al", "ia", "ri", "tr") of the search keyword "trial". Recheck process tests whether each candidate contains the search keyword itself, and then chooses only the correct results.</p>
 442
 443 <p>How Recheck narrows down the search result can be observed in the result of EXPLAIN ANALYZE.</p>
 444
 445 <pre>
 446 =# CREATE TABLE tbl (doc text);
 447 =# INSERT INTO tbl VALUES('He is awaiting trial');
 448 =# INSERT INTO tbl VALUES('It was a trivial mistake');
 449 =# CREATE INDEX tbl_idx ON tbl USING gin (doc gin_bigm_ops);
 450 =# SET enable_seqscan TO off;
 451 =# EXPLAIN ANALYZE SELECT * FROM tbl WHERE doc LIKE likequery('trial');
 452                                                    QUERY PLAN
 453 -----------------------------------------------------------------------------------------------------------------
 454  Bitmap Heap Scan on tbl  (cost=12.00..16.01 rows=1 width=32) (actual time=0.041..0.044 rows=1 loops=1)
 455    Recheck Cond: (doc ~~ '%trial%'::text)
 456    Rows Removed by Index Recheck: 1
 457    -&gt;  Bitmap Index Scan on tbl_idx  (cost=0.00..12.00 rows=1 width=0) (actual time=0.028..0.028 rows=2 loops=1)
 458          Index Cond: (doc ~~ '%trial%'::text)
 459  Total runtime: 0.113 ms
 460 (6 rows)
 461 </pre>
 462
 463 <p>In this example, you can see that Bitmap Index Scan retrieved two rows from the full text search index but Bitmap Heap Scan returned only one row after Recheck process.</p>
 464
 465 <p>It is possible to skip Recheck process and get the result candidates retrieved from the full text search index as the final results, by disabling this parameter. In the following example, wrong result "It was a trivial mistake" is also returned because the parameter is disabled.</p>
 466
 467 <pre>
 468 =# SELECT * FROM tbl WHERE doc LIKE likequery('trial');
 469          doc
 470 ----------------------
 471  He is awaiting trial
 472 (1 row)
 473
 474 =# SET pg_bigm.enable_recheck = off;
 475 =# SELECT * FROM tbl WHERE doc LIKE likequery('trial');
 476            doc
 477 --------------------------
 478  He is awaiting trial
 479  It was a trivial mistake
 480 (2 rows)
 481 </pre>
 482
 483 <p>This parameter must be enabled if you want to obtain the correct search result. On the other hand, you may need to set it to off, for example, for evaluation of Recheck performance overhead or debugging, etc.</p>
 484
 485 <h3 id="gin_key_limit">pg_bigm.gin_key_limit</h3>
 486 <p>pg_bigm.gin_key_limit is a parameter that specifies the maximum number of 2-grams of the search keyword to be used for full text search. If it's set to zero (default), all the 2-grams of the search keyword are used for full text search. Not only superuser but also any user can change this parameter value in postgresql.conf or by using SET command.</p>
 487
 488 <p>PostgreSQL and pg_bigm basically use all the 2-grams of search keyword to scan GIN index. However, in current implementation of GIN index, the more 2-grams are used, the more performance overhead of GIN index scan is increased. In the system that large search keyword is often used, full text search is likely to be slow. This performance issue can be solved by using this parameter and limiting the maximum number of 2-grams to be used.</p>
 489
 490 <p>On the other hand, the less 2-grams are used, the more wrong results are included in the result candidates retrieved from full text search index. Please note that this can increase the workload of Recheck and decrease the performance.</p>
 491
 492 <h3 id="similarity_limit">pg_bigm.similarity_limit</h3>
 493 <p>pg_bigm.similarity_limit is a parameter that specifies the threshold used by the similarity search. The similarity search returns all the rows whose similarity with the search keyword is higher than or equal to this threshold. Value must be between 0 and 1 (default is 0.3). Not only superuser but also any user can change this parameter value in postgresql.conf or by using SET command.</p>
 494
 495 <h2 id="limitations">Limitations</h2>
 496 <h3 id="indexed_column_size">Indexed Column Size</h3>
 497
 498 <p>The size of the column indexed by bigm GIN index cannot exceed 71,582,785 Bytes (~68MB). Any attempt to enter larger values will result in an error. </p>
 499
 500 <pre>
 501 =# CREATE TABLE t1 (description text);
 502 =# CREATE INDEX t1_idx ON t1 USING gin (description gin_bigm_ops);
 503 =# INSERT INTO t1 SELECT repeat('A', 71582786);
 504 ERROR:  invalid memory alloc request size 1073741824
 505 </pre>
 506
 507 <p>pg_trgm also has this limitation. However, the maximum size in the case of trgm indexed column is 238,609,291 Bytes (~228MB).</p>
 508
 509 <h2 id="release_notes">Release Notes</h2>
 510 <ul>
 511 <li><a href="release-1-1-20131122_en.html">Version 1.1, released on 2013-11-22</a></li>
 512 <li><a href="release-1-0-20131122_en.html">Version 1.0, released on 2013-11-22</a></li>
 513 </ul>
 514
 515 <hr>
 516 <div align="right">Copyright (c) 2012-2015, NTT DATA Corporation</div>
 517
 518 </body>
 519 </html>