Update copyright for 2016.

[pgbigm/pg_bigm.git] / html / pg_bigm_en-1-2.html

diff --git a/html/pg_bigm_en-1-2.html b/html/pg_bigm_en-1-2.html
index 08934a2..c33559e 100644 (file)
--- a/html/pg_bigm_en-1-2.html
+++ b/html/pg_bigm_en-1-2.html
@@ -74,6 +74,9 @@ For example, x.y is 1.1 and YYYYMMDD is 20131122 if the file of the version 1.1
 <tr><td>Available index</td>
   <td nowrap>GIN and GiST</td>
   <td>GIN only</td></tr>
+<tr><td>Available text search operators</td>
+  <td nowrap>LIKE (~~), ILIKE (~~*), ~, ~*</td>
+  <td>LIKE only</td></tr>
 <tr><td>Full text search for non-alphabetic language<br>(e.g., Japanese)</td>
   <td nowrap>Not supported (*1)</td>
   <td>Supported</td></tr>
@@ -111,7 +114,7 @@ For example, x.y is 1.1 and YYYYMMDD is 20131122 if the file of the version 1.1
 </tr>
 <tr>
   <td>DBMS</td>
-  <td nowrap>PostgreSQL 9.1, 9.2, 9.3, 9.4</td>
+  <td nowrap>PostgreSQL 9.1, 9.2, 9.3, 9.4, 9.5</td>
 </tr>
 </tbody>
 </table>
@@ -155,6 +158,9 @@ $ su
 <pre>
 $ initdb -D $PGDATA --locale=C --encoding=UTF8
 
+$ vi $PGDATA/postgresql.conf
+shared_preload_libraries = 'pg_bigm'
+
 $ pg_ctl -D $PGDATA start
 $ psql -d &lt;database name&gt;
 =# CREATE EXTENSION pg_bigm;
@@ -169,7 +175,11 @@ $ psql -d &lt;database name&gt;
 <ul>
 <li>Replace $PGDATA with the path to database cluster.</li>
 <li>pg_bigm supports all PostgreSQL encoding and locale.</li>
-<li>In PostgreSQL9.1, <a href="http://www.postgresql.org/docs/current/static/runtime-config-custom.html#GUC-CUSTOM-VARIABLE-CLASSES">custom_variable_classes</a> needs to be set to pg_bigm in postgresql.conf.</li>
+<li>In postgresql.conf, <a href="http://www.postgresql.org/docs/devel/static/runtime-config-client.html#GUC-SHARED-PRELOAD-LIBRARIES">shared_preload_libraries</a> or <a href="http://www.postgresql.org/docs/devel/static/runtime-config-client.html#GUC-SESSION-PRELOAD-LIBRARIES">session_preload_libraries</a> (available in PostgreSQL 9.4 or later) must be set to 'pg_bigm' to preload the pg_bigm shared library into the server.
+  <ul>
+    <li>In PostgreSQL 9.1, <a href="http://www.postgresql.org/docs/9.1/static/runtime-config-custom.html#GUC-CUSTOM-VARIABLE-CLASSES">custom_variable_classes</a> also must be set to 'pg_bigm'.</li>
+  </ul>
+</li>
 <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>
 </ul>
 
@@ -199,7 +209,8 @@ $ su
 <h3 id="delete_conf">Reset postgresql.conf</h3>
 <p>Delete the following pg_bigm related settings from postgresql.conf.</p>
 <ul>
-<li>custom_variable_classes (only PostgreSQL9.1)</li>
+<li>shared_preload_libraries or session_preload_libraries</li>
+<li>custom_variable_classes (only PostgreSQL 9.1)</li>
 <li>pg_bigm.* (parameters which begin with pg_bigm)</li>
 </ul>
 
@@ -405,6 +416,36 @@ Please see <a href="http://www.postgresql.org/docs/current/static/gin-implementa
 (1 row)
 </pre>
 
+<h3 id="pg_gin_pending_cleanup">pg_gin_pending_cleanup</h3>
+<p>pg_gin_pending_cleanup is a function that cleans up the pending list of GIN index (argument #1) by moving tuples in it to the main GIN data structure in bulk.</p>
+
+<ul>
+<li>Argument #1 (regclass) - Name or OID of GIN index</li>
+<li>Argument #2 (boolean) - Use <a href="http://www.postgresql.org/docs/current/static/runtime-config-resource.html#RUNTIME-CONFIG-RESOURCE-VACUUM-COST">cost-based VACUUM delay</a>? (the default value is FALSE)</li>
+<li>Return value #1 (integer) - Number of pages cleaned up in the pending list</li>
+</ul>
+
+<p>
+Note that the cleanup does not happen and the return value #1 is 0 if the argument #1 is the GIN index built with FASTUPDATE option disabled because it doesn't have a pending list.
+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.
+</p>
+<p>
+If the argument #2 is TRUE, this function uses the cost-based VACUUM delay to reduce the performance impact of the pending list cleanup.
+If the argument #2 is FALSE or not supplied, this function cleans up the pending list as quickly as possible.
+</p>
+<p>
+Only superusers and the owner of the GIN index can execute this function.
+This function cannot be executed during recovery.
+</p>
+
+<pre>
+=# SELECT pg_gin_pending_cleanup('pg_tools_idx');
+ pg_gin_pending_cleanup 
+------------------------
+                      1
+(1 row)
+</pre>
+
 <h2 id="parametares">Parameters</h2>
 <h3 id="last_update">pg_bigm.last_update</h3>
 <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>
@@ -499,12 +540,13 @@ ERROR:  out of memory
 
 <h2 id="release_notes">Release Notes</h2>
 <ul>
-<li><a href="release-1-1-20131122_en.html">Version 1.1, released on 2013-11-22</a></li>
-<li><a href="release-1-0-20131122_en.html">Version 1.0, released on 2013-11-22</a></li>
+<li><a href="release-1-2_en.html">Version 1.2</a></li>
+<li><a href="release-1-1_en.html">Version 1.1</a></li>
+<li><a href="release-1-0_en.html">Version 1.0</a></li>
 </ul>
 
 <hr>
-<div align="right">Copyright (c) 2012-2015, NTT DATA Corporation</div>
+<div align="right">Copyright (c) 2012-2016, NTT DATA Corporation</div>
 
 </body>
 </html>