summaryrefslogtreecommitdiff
path: root/doc/src
diff options
context:
space:
mode:
authorFujii Masao <fujii@postgresql.org>2014-11-13 12:14:48 +0900
committerFujii Masao <fujii@postgresql.org>2014-11-13 12:14:48 +0900
commitc291503b1c8250c7ba6ca900b7ba2f85a64b1eb6 (patch)
tree8a9718c756942be40d89af6f28bf57a00bbc615b /doc/src
parent677708032c4a4d37cdb2a4bd45726fc260308db7 (diff)
Rename pending_list_cleanup_size to gin_pending_list_limit.
Since this parameter is only for GIN index, it's better to add "gin" to the parameter name for easier understanding.
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/sgml/config.sgml6
-rw-r--r--doc/src/sgml/gin.sgml10
-rw-r--r--doc/src/sgml/ref/create_index.sgml4
3 files changed, 10 insertions, 10 deletions
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index 6bfb7bbc112..ab8c2637d75 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -5911,10 +5911,10 @@ SET XML OPTION { DOCUMENT | CONTENT };
</listitem>
</varlistentry>
- <varlistentry id="guc-pending-list-cleanup-size" xreflabel="pending_list_cleanup_size">
- <term><varname>pending_list_cleanup_size</varname> (<type>integer</type>)
+ <varlistentry id="guc-gin-pending-list-limit" xreflabel="gin_pending_list_limit">
+ <term><varname>gin_pending_list_limit</varname> (<type>integer</type>)
<indexterm>
- <primary><varname>pending_list_cleanup_size</> configuration parameter</primary>
+ <primary><varname>gin_pending_list_limit</> configuration parameter</primary>
</indexterm>
</term>
<listitem>
diff --git a/doc/src/sgml/gin.sgml b/doc/src/sgml/gin.sgml
index 94d2d5c19d9..262f1e452e5 100644
--- a/doc/src/sgml/gin.sgml
+++ b/doc/src/sgml/gin.sgml
@@ -729,7 +729,7 @@
<acronym>GIN</> is capable of postponing much of this work by inserting
new tuples into a temporary, unsorted list of pending entries.
When the table is vacuumed, or if the pending list becomes larger than
- <xref linkend="guc-pending-list-cleanup-size">, the entries are moved to the
+ <xref linkend="guc-gin-pending-list-limit">, the entries are moved to the
main <acronym>GIN</acronym> data structure using the same bulk insert
techniques used during initial index creation. This greatly improves
<acronym>GIN</acronym> index update speed, even counting the additional
@@ -812,22 +812,22 @@
</varlistentry>
<varlistentry>
- <term><xref linkend="guc-pending-list-cleanup-size"></term>
+ <term><xref linkend="guc-gin-pending-list-limit"></term>
<listitem>
<para>
During a series of insertions into an existing <acronym>GIN</acronym>
index that has <literal>fastupdate</> enabled, the system will clean up
the pending-entry list whenever the list grows larger than
- <varname>pending_list_cleanup_size</>. To avoid fluctuations in observed
+ <varname>gin_pending_list_limit</>. To avoid fluctuations in observed
response time, it's desirable to have pending-list cleanup occur in the
background (i.e., via autovacuum). Foreground cleanup operations
- can be avoided by increasing <varname>pending_list_cleanup_size</>
+ can be avoided by increasing <varname>gin_pending_list_limit</>
or making autovacuum more aggressive.
However, enlarging the threshold of the cleanup operation means that
if a foreground cleanup does occur, it will take even longer.
</para>
<para>
- <varname>pending_list_cleanup_size</> can be overridden for individual
+ <varname>gin_pending_list_limit</> can be overridden for individual
GIN indexes by changing storage parameters, and which allows each
GIN index to have its own cleanup threshold.
For example, it's possible to increase the threshold only for the GIN
diff --git a/doc/src/sgml/ref/create_index.sgml b/doc/src/sgml/ref/create_index.sgml
index 21f7604ac08..1a23e273056 100644
--- a/doc/src/sgml/ref/create_index.sgml
+++ b/doc/src/sgml/ref/create_index.sgml
@@ -371,10 +371,10 @@ CREATE [ UNIQUE ] INDEX [ CONCURRENTLY ] [ [ IF NOT EXISTS ] <replaceable class=
</variablelist>
<variablelist>
<varlistentry>
- <term><literal>pending_list_cleanup_size</></term>
+ <term><literal>gin_pending_list_limit</></term>
<listitem>
<para>
- Custom <xref linkend="guc-pending-list-cleanup-size"> parameter.
+ Custom <xref linkend="guc-gin-pending-list-limit"> parameter.
This value is specified in kilobytes.
</para>
</listitem>