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="#release_notes">Release Notes</a></li>
  34 </ol>
  35 </div>
  36
  37 <h2 id="description">Overview</h2>
  38 <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>
  39 <p>The <a href="http://en.sourceforge.jp/projects/pgbigm/">pg_bigm project</a> provides the following one module.</p>
  40
  41 <table>
  42 <thead>
  43 <tr>
  44 <th>Module</th><th>Description</th><th>Source Archive File Name</th>
  45 </tr>
  46 </thead>
  47 <tbody>
  48 <tr><td>pg_bigm</td>
  49   <td nowrap>Module that provides full text search capability in PostgreSQL</td>
  50   <td>pg_bigm-x.y-YYYYMMDD.tar.gz</td></tr>
  51 </tbody>
  52 </table>
  53
  54 <p>
  55 The x.y and YYYYMMDD parts of the source archive file name are replaced with its release version number and date, respectively.
  56 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.
  57 </p>
  58 <p>The license of pg_bigm is <a href="http://opensource.org/licenses/postgresql">The PostgreSQL License</a> (same as BSD license).</p>
  59
  60 <h2 id="pg_trgm">Comparison with pg_trgm</h2>
  61 <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>
  62
  63 <table>
  64 <thead>
  65 <tr>
  66 <th>Functionalities and Features</th><th>pg_trgm</th><th>pg_bigm</th>
  67 </tr>
  68 </thead>
  69 <tbody>
  70 <tr><td>Phrase matching method for full text search</td>
  71   <td nowrap>3-gram</td>
  72   <td>2-gram</td></tr>
  73 <tr><td>Available index</td>
  74   <td nowrap>GIN and GiST</td>
  75   <td>GIN only</td></tr>
  76 <tr><td>Full text search for non-alphabetic language<br>(e.g., Japanese)</td>
  77   <td nowrap>Not supported (*1)</td>
  78   <td>Supported</td></tr>
  79 <tr><td>Full text search with 1-2 characters keyword</td>
  80   <td nowrap>Slow (*2)</td>
  81   <td>Fast</td></tr>
  82 <tr><td>Similarity search</td>
  83   <td nowrap>Supported</td>
  84   <td>Supported (version 1.1 or later)</td></tr>
  85 </tbody>
  86 </table>
  87
  88 <ul>
  89 <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>
  90 <li>(*2) Because, in this search, only sequential scan or index full scan (not normal index scan) can run.</li>
  91 </ul>
  92
  93 <p>pg_bigm 1.1 or later can coexist with pg_trgm in the same database, but pg_bigm 1.0 cannot.</p>
  94
  95 <h2 id="requirement">Tested platforms</h2>
  96 <p>pg_bigm has been built and tested on the following platforms:</p>
  97 <table>
  98 <thead>
  99 <tr>
 100 <th>Category</th><th>Module Name</th>
 101 </tr>
 102 </thead>
 103 <tbody>
 104 <tr>
 105   <td>OS</td>
 106   <td nowrap>Linux, Mac OS X</td>
 107 </tr>
 108 <tr>
 109   <td>DBMS</td>
 110   <td nowrap>PostgreSQL 9.1, 9.2, 9.3, 9.4</td>
 111 </tr>
 112 </tbody>
 113 </table>
 114
 115 <p>pg_bigm requires PostgreSQL 9.1 or later.</p>
 116
 117 <h2 id="install">Install</h2>
 118
 119 <h3 id="pg_install">Install PostgreSQL</h3>
 120 <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>
 121 <pre>
 122 $ tar zxf postgresql-X.Y.Z.tar.gz
 123 $ cd postgresql-X.Y.Z
 124 $ ./configure --prefix=/opt/pgsql-X.Y.Z
 125 $ make
 126 $ su
 127 # make install
 128 # exit</pre>
 129 <ul>
 130 <li>--prefix : Specify the PostgreSQL installation directory. This is optional. By default, PostgreSQL is installed in /usr/local/pgsql.</li>
 131 </ul>
 132 <p>If PostgreSQL is installed from RPM, the postgresql-devel package must be installed to build pg_bigm.</p>
 133
 134 <h3 id="bigm_install">Install pg_bigm</h3>
 135 <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>
 136 <pre>
 137 $ tar zxf pg_bigm-x.y-YYYYMMDD.tar.gz
 138 $ cd pg_bigm-x.y-YYYYMMDD
 139 $ make USE_PGXS=1 PG_CONFIG=/opt/pgsql-X.Y.Z/bin/pg_config
 140 $ su
 141 # make USE_PGXS=1 PG_CONFIG=/opt/pgsql-X.Y.Z/bin/pg_config install
 142 # exit
 143 </pre>
 144 <ul>
 145 <li>USE_PGXS : USE_PGXS=1 must be always specified when building pg_bigm.</li>
 146 <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>
 147 </ul>
 148
 149 <h3 id="bigm_register">Load pg_bigm</h3>
 150 <p>Create the database cluster, modify postgresql.conf, start PostgreSQL server and then load pg_bigm into the database.</p>
 151 <pre>
 152 $ initdb -D $PGDATA --locale=C --encoding=UTF8
 153
 154 $ vi $PGDATA/postgresql.conf
 155 shared_preload_libraries = 'pg_bigm'
 156 custom_variable_classes = 'pg_bigm'
 157
 158 $ pg_ctl -D $PGDATA start
 159 $ psql -d &lt;database name&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>Replace $PGDATA with the path to database cluster.</li>
 171 <li>pg_bigm supports all PostgreSQL encoding and locale.</li>
 172 <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>.
 173   <ul>
 174     <li>In PostgreSQL 9.2 or later, you need to set only shared_preload_libraries because custom_variable_classes doesn't exist.</li>
 175   </ul>
 176 </li>
 177 <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>
 178 </ul>
 179
 180
 181 <h2 id="uninstall">Uninstall</h2>
 182
 183 <h3 id="bigm_uninstall">Delete pg_bigm</h3>
 184 <p>Unload pg_bigm from the database and then uninstall it.</p>
 185 <pre>
 186 $ psql -d &lt;database name&gt;
 187 =# DROP EXTENSION pg_bigm CASCADE;
 188 =# \q
 189
 190 $ pg_ctl -D $PGDATA stop
 191 $ su
 192
 193 # cd &lt;pg_bigm source directory&gt;
 194 # make USE_PGXS=1 PG_CONFIG=/opt/pgsql-X.Y.Z/bin/pg_config uninstall
 195 # exit
 196 </pre>
 197
 198 <ul>
 199 <li>pg_bigm needs to be unloaded from all the databases that it was loaded into.</li>
 200 <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>
 201 </ul>
 202
 203 <h3 id="delete_conf">Reset postgresql.conf</h3>
 204 <p>Delete the following pg_bigm related settings from postgresql.conf.</p>
 205 <ul>
 206 <li>shared_preload_libraries</li>
 207 <li>custom_variable_classes</li>
 208 <li>pg_bigm.* (parameters which begin with pg_bigm)</li>
 209 </ul>
 210
 211 <h2 id="fulltext_search">Full text search</h2>
 212
 213 <h3 id="create_index">Create Index</h3>
 214 <p>You can create an index for full text search by using GIN index.</p>
 215 <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>
 216
 217 <pre>
 218 =# CREATE TABLE pg_tools (tool text, description text);
 219
 220 =# INSERT INTO pg_tools VALUES ('pg_hint_plan', 'Tool that allows a user to specify an optimizer HINT to PostgreSQL');
 221 =# INSERT INTO pg_tools VALUES ('pg_dbms_stats', 'Tool that allows a user to stabilize planner statistics in PostgreSQL');
 222 =# INSERT INTO pg_tools VALUES ('pg_bigm', 'Tool that provides 2-gram full text search capability in PostgreSQL');
 223 =# INSERT INTO pg_tools VALUES ('pg_trgm', 'Tool that provides 3-gram full text search capability in PostgreSQL');
 224
 225 =# CREATE INDEX pg_tools_idx ON pg_tools USING gin (description gin_bigm_ops);
 226 </pre>
 227
 228 <ul>
 229 <li><b>gin</b> must be used as an index method. GiST is not available for pg_bigm.</li>
 230 <li><b>gin_bigm_ops</b> must be used as an operator class.</li>
 231 </ul>
 232
 233 <p>You can also create multicolumn pg_bigm index and specify GIN related parameters then, as follows.</p>
 234
 235 <pre>
 236 =# CREATE INDEX pg_tools_multi_idx ON pg_tools USING gin (tool gin_bigm_ops, description gin_bigm_ops) WITH (FASTUPDATE = off);
 237 </pre>
 238
 239 <h3 id="do_fulltext_search">Execute full text search</h3>
 240 <p>You can execute full text search by using LIKE pattern matching.</p>
 241 <pre>
 242 =# SELECT * FROM pg_tools WHERE description LIKE '%search%';
 243   tool   |                             description
 244 ---------+---------------------------------------------------------------------
 245  pg_bigm | Tool that provides 2-gram full text search capability in PostgreSQL
 246  pg_trgm | Tool that provides 3-gram full text search capability in PostgreSQL
 247 (2 rows)
 248 </pre>
 249 <ul>
 250 <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>
 251 </ul>
 252
 253 <h3 id="similarity_search">Execute similarity search</h3>
 254 <p>You can execute similarity search by using =% operator.</p>
 255 <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>
 256 <pre>
 257 =# SET pg_bigm.similarity_limit TO 0.2;
 258
 259 =# SELECT tool FROM pg_tools WHERE tool =% 'bigm';
 260   tool
 261 ---------
 262  pg_bigm
 263  pg_trgm
 264 (2 rows)
 265 </pre>
 266 <p>
 267 Please see <a href="#bigm_similarity">bigm_similarity</a> function for details of how to calculate the similarity.
 268 </p>
 269
 270 <h2 id="functions">Functions</h2>
 271 <h3 id="likequery">likequery</h3>
 272 <p>likequery is a function that converts the search keyword (argument #1) into the pattern string that LIKE operator can handle properly.</p>
 273 <ul>
 274 <li>Argument #1 (text) - search keyword</li>
 275 <li>Return value (text) - pattern string that was converted from argument #1 so that LIKE operator can handle properly</li>
 276 </ul>
 277
 278 <p>If the argument #1 is NULL, the return value is also NULL.</p>
 279
 280 <p>This function does the conversion as follows:</p>
 281 <ul>
 282 <li>appends % (single-byte percent) into both the beginning and the end of the search keyword.</li>
 283 <li>escapes the characters % (single-byte percent), _ (single-byte underscore) and \ (single-byte backslash) in the search keyword by using \ (single-byte backslash).</li>
 284 </ul>
 285
 286 <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>
 287
 288 <pre>
 289 =# SELECT likequery('pg_bigm has improved the full text search performance by 200%');
 290                              likequery
 291 -------------------------------------------------------------------
 292  %pg\_bigm has improved the full text search performance by 200\%%
 293 (1 row)
 294 </pre>
 295
 296 <p>Using likequery, you can rewrite the full text search query which was used in the example in "Execute full text search" into:</p>
 297 <pre>
 298 =# SELECT * FROM pg_tools WHERE description LIKE likequery('search');
 299   tool   |                             description
 300 ---------+---------------------------------------------------------------------
 301  pg_bigm | Tool that provides 2-gram full text search capability in PostgreSQL
 302  pg_trgm | Tool that provides 3-gram full text search capability in PostgreSQL
 303 (2 rows)
 304 </pre>
 305
 306 <h3 id="show_bigm">show_bigm</h3>
 307 <p>show_bigm returns an array of all the 2-grams in the given string (argument #1).</p>
 308
 309 <ul>
 310 <li>Argument #1 (text) - character string</li>
 311 <li>Return value (text[]) - an array of all the 2-grams in argument #1</li>
 312 </ul>
 313
 314 <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>
 315
 316 <pre>
 317 =# SELECT show_bigm('full text search');
 318                             show_bigm
 319 ------------------------------------------------------------------
 320  {" f"," s"," t",ar,ch,ea,ex,fu,"h ","l ",ll,rc,se,"t ",te,ul,xt}
 321 (1 row)
 322 </pre>
 323
 324 <h3 id="bigm_similarity">bigm_similarity</h3>
 325 <p>bigm_similarity returns a number that indicates how similar the two strings (argument #1 and #2) are.</p>
 326
 327 <ul>
 328 <li>Argument #1 (text) - character string</li>
 329 <li>Argument #2 (text) - character string</li>
 330 <li>Return value (real) - the similarity of two arguments</li>
 331 </ul>
 332
 333 <p>
 334 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).
 335 </p>
 336
 337 <pre>
 338 =# SELECT bigm_similarity('full text search', 'text similarity search');
 339  bigm_similarity
 340 -----------------
 341         0.571429
 342 (1 row)
 343 </pre>
 344
 345 <p>
 346 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.
 347 For example, though the string "ABC" contains the string "B", their similarity is 0 because there are no 2-grams they share as follows.
 348 On the other hand, the string "ABC" and "A" share one 2-gram "(blank)A" as follows, so their similarity is higher than 0.
 349 This is basically the same behavior as pg_trgm's similarity function.
 350
 351 <ul>
 352 <li>The 2-grams of the string "ABC" are "(blank)A" "AB" "BC" "C(blank)".</li>
 353 <li>The 2-grams of the string "A" are "(blank)A" "A(blank)".</li>
 354 <li>The 2-grams of the string "B" are "(blank)B" "B(blank)".</li>
 355 </ul>
 356 </p>
 357
 358 <pre>
 359 =# SELECT bigm_similarity('ABC', 'A');
 360  bigm_similarity
 361 -----------------
 362             0.25
 363 (1 row)
 364
 365 =# SELECT bigm_similarity('ABC', 'B');
 366  bigm_similarity
 367 -----------------
 368                0
 369 (1 row)
 370 </pre>
 371
 372 <p>
 373 Note that bigm_similarity is NOT case-sensitive, but pg_trgm's similarity function is case-sensitive.
 374 For example, the similarity of the strings "ABC" and "abc" is 1 in pg_trgm's similarity function but 0 in bigm_similarity.
 375 </p>
 376
 377 <pre>
 378 =# SELECT similarity('ABC', 'abc');
 379  similarity
 380 ------------
 381           1
 382 (1 row)
 383
 384 =# SELECT bigm_similarity('ABC', 'abc');
 385  bigm_similarity
 386 -----------------
 387                0
 388 (1 row)
 389 </pre>
 390
 391 <h3 id="pg_gin_pending_stats">pg_gin_pending_stats</h3>
 392 <p>pg_gin_pending_stats is a function that returns the number of pages and tuples in the pending list of GIN index.</p>
 393
 394 <ul>
 395 <li>Argument #1 (regclass) - Name or OID of GIN index</li>
 396 <li>Return value #1 (integer) - Number of pages in the pending list</li>
 397 <li>Return value #2 (bigint) - Number of tuples in the pending list</li>
 398 </ul>
 399
 400 <p>
 401 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.
 402 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.
 403 </p>
 404
 405 <pre>
 406 =# SELECT * FROM pg_gin_pending_stats('pg_tools_idx');
 407  pages | tuples
 408 -------+--------
 409      1 |      4
 410 (1 row)
 411 </pre>
 412
 413 <h2 id="parametares">Parameters</h2>
 414 <h3 id="last_update">pg_bigm.last_update</h3>
 415 <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>
 416
 417 <pre>
 418 =# SHOW pg_bigm.last_update;
 419  pg_bigm.last_update
 420 ---------------------
 421  2013.11.22
 422 (1 row)
 423 </pre>
 424
 425 <h3 id="enable_recheck">pg_bigm.enable_recheck</h3>
 426 <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>
 427
 428 <p>PostgreSQL and pg_bigm internally perform the following processes to get the search results:</p>
 429
 430 <ul>
 431 <li>retrieve the result candidates from full text search index.</li>
 432 <li>choose the correct search results from the candidates.</li>
 433 </ul>
 434
 435 <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>
 436
 437 <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>
 438
 439 <p>How Recheck narrows down the search result can be observed in the result of EXPLAIN ANALYZE.</p>
 440
 441 <pre>
 442 =# CREATE TABLE tbl (doc text);
 443 =# INSERT INTO tbl VALUES('He is awaiting trial');
 444 =# INSERT INTO tbl VALUES('It was a trivial mistake');
 445 =# CREATE INDEX tbl_idx ON tbl USING gin (doc gin_bigm_ops);
 446 =# SET enable_seqscan TO off;
 447 =# EXPLAIN ANALYZE SELECT * FROM tbl WHERE doc LIKE likequery('trial');
 448                                                    QUERY PLAN
 449 -----------------------------------------------------------------------------------------------------------------
 450  Bitmap Heap Scan on tbl  (cost=12.00..16.01 rows=1 width=32) (actual time=0.041..0.044 rows=1 loops=1)
 451    Recheck Cond: (doc ~~ '%trial%'::text)
 452    Rows Removed by Index Recheck: 1
 453    -&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)
 454          Index Cond: (doc ~~ '%trial%'::text)
 455  Total runtime: 0.113 ms
 456 (6 rows)
 457 </pre>
 458
 459 <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>
 460
 461 <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>
 462
 463 <pre>
 464 =# SELECT * FROM tbl WHERE doc LIKE likequery('trial');
 465          doc
 466 ----------------------
 467  He is awaiting trial
 468 (1 row)
 469
 470 =# SET pg_bigm.enable_recheck = off;
 471 =# SELECT * FROM tbl WHERE doc LIKE likequery('trial');
 472            doc
 473 --------------------------
 474  He is awaiting trial
 475  It was a trivial mistake
 476 (2 rows)
 477 </pre>
 478
 479 <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>
 480
 481 <h3 id="gin_key_limit">pg_bigm.gin_key_limit</h3>
 482 <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>
 483
 484 <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>
 485
 486 <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>
 487
 488 <h3 id="similarity_limit">pg_bigm.similarity_limit</h3>
 489 <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>
 490
 491 <h2 id="release_notes">Release Notes</h2>
 492 <ul>
 493 <li><a href="release-1-1-20131122_en.html">Version 1.1, released on 2013-11-22</a></li>
 494 <li><a href="release-1-0-20131122_en.html">Version 1.0, released on 2013-11-22</a></li>
 495 </ul>
 496
 497 <hr>
 498 <div align="right">Copyright (c) 2012-2015, NTT DATA Corporation</div>
 499
 500 </body>
 501 </html>