]> granicus.if.org Git - postgresql/commitdiff
Rename pending_list_cleanup_size to gin_pending_list_limit.
authorFujii Masao <fujii@postgresql.org>
Thu, 13 Nov 2014 03:14:48 +0000 (12:14 +0900)
committerFujii Masao <fujii@postgresql.org>
Thu, 13 Nov 2014 03:14:48 +0000 (12:14 +0900)
Since this parameter is only for GIN index, it's better to
add "gin" to the parameter name for easier understanding.

13 files changed:
doc/src/sgml/config.sgml
doc/src/sgml/gin.sgml
doc/src/sgml/ref/create_index.sgml
src/backend/access/common/reloptions.c
src/backend/access/gin/ginfast.c
src/backend/access/gin/ginutil.c
src/backend/utils/misc/guc.c
src/backend/utils/misc/postgresql.conf.sample
src/bin/psql/tab-complete.c
src/include/access/gin.h
src/include/access/gin_private.h
src/test/regress/expected/create_index.out
src/test/regress/sql/create_index.sql

index 6bfb7bbc112b2c6fbe30b867e272492b284e1323..ab8c2637d750dab2f5742aaac6473332523b9740 100644 (file)
@@ -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>
index 94d2d5c19d95b9d8054963d52fe0d37a072e089e..262f1e452e5fd1efcff87a96b51268c99fcbd1a0 100644 (file)
    <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
   </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
index 21f7604ac088a0d757756582773a4420755d5bac..1a23e273056a1859da55573e15ccbfe8e6190dea 100644 (file)
@@ -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>
index 86d918fafb4237c558a8120a066a2ec79243accb..c16b38eed8bcbbce40985636bdb3ae0c478ba47c 100644 (file)
@@ -218,7 +218,7 @@ static relopt_int intRelOpts[] =
        },
        {
                {
-                       "pending_list_cleanup_size",
+                       "gin_pending_list_limit",
                        "Maximum size of the pending list for this GIN index, in kilobytes.",
                        RELOPT_KIND_GIN
                },
index 96255104ac1d442861075e7ee901a43f042b78e5..25746995b5ef6ade36dc6525588de55d067e50df 100644 (file)
@@ -26,7 +26,7 @@
 #include "utils/rel.h"
 
 /* GUC parameter */
-int                    pending_list_cleanup_size = 0;
+int                    gin_pending_list_limit = 0;
 
 #define GIN_PAGE_FREESIZE \
        ( BLCKSZ - MAXALIGN(SizeOfPageHeaderData) - MAXALIGN(sizeof(GinPageOpaqueData)) )
@@ -426,7 +426,7 @@ ginHeapTupleFastInsert(GinState *ginstate, GinTupleCollector *collector)
         * call it when it can do all the work in a single collection cycle. In
         * non-vacuum mode, it shouldn't require maintenance_work_mem, so fire it
         * while pending list is still small enough to fit into
-        * pending_list_cleanup_size.
+        * gin_pending_list_limit.
         *
         * ginInsertCleanup() should not be called inside our CRIT_SECTION.
         */
index ff1dd7ee519750823d9c8eca420dba187e03a634..d0458cfd0cfa939b841e8ccb6f9eb43732d1881e 100644 (file)
@@ -526,7 +526,7 @@ ginoptions(PG_FUNCTION_ARGS)
        int                     numoptions;
        static const relopt_parse_elt tab[] = {
                {"fastupdate", RELOPT_TYPE_BOOL, offsetof(GinOptions, useFastUpdate)},
-               {"pending_list_cleanup_size", RELOPT_TYPE_INT, offsetof(GinOptions,
+               {"gin_pending_list_limit", RELOPT_TYPE_INT, offsetof(GinOptions,
                                                                                                                                pendingListCleanupSize)}
        };
 
index db65c7688dc626339cb9982785f60ee3538caa79..23cbe906a789382e8e7c5ca9fc01165edda37c7a 100644 (file)
@@ -2543,12 +2543,12 @@ static struct config_int ConfigureNamesInt[] =
        },
 
        {
-               {"pending_list_cleanup_size", PGC_USERSET, CLIENT_CONN_STATEMENT,
+               {"gin_pending_list_limit", PGC_USERSET, CLIENT_CONN_STATEMENT,
                        gettext_noop("Sets the maximum size of the pending list for GIN index."),
                         NULL,
                        GUC_UNIT_KB
                },
-               &pending_list_cleanup_size,
+               &gin_pending_list_limit,
                4096, 64, MAX_KILOBYTES,
                NULL, NULL, NULL
        },
index 6e8ea1e481c721cf6701adbba708a8e9b422238e..4a89cb7d9f86a0e7b2b85508e63de991222855af 100644 (file)
 #bytea_output = 'hex'                  # hex, escape
 #xmlbinary = 'base64'
 #xmloption = 'content'
-#pending_list_cleanup_size = 4MB
+#gin_pending_list_limit = 4MB
 
 # - Locale and Formatting -
 
index be6ad7ea6431643c1634df342b6ab8278cc9d34c..8c85425fc5df32812573c1cff33e8cf15f51cdfd 100644 (file)
@@ -1172,7 +1172,7 @@ psql_completion(const char *text, int start, int end)
                         pg_strcasecmp(prev_wd, "(") == 0)
        {
                static const char *const list_INDEXOPTIONS[] =
-               {"fillfactor", "fastupdate", "pending_list_cleanup_size", NULL};
+               {"fillfactor", "fastupdate", "gin_pending_list_limit", NULL};
 
                COMPLETE_WITH_LIST(list_INDEXOPTIONS);
        }
index a0d4da84b084107e06a134ca7b04be1fab8bccd5..433e56f20dfa23b166fe2e6bf88862ed5d7dc005 100644 (file)
@@ -67,7 +67,7 @@ typedef char GinTernaryValue;
 
 /* GUC parameters */
 extern PGDLLIMPORT int GinFuzzySearchLimit;
-extern int pending_list_cleanup_size;
+extern int gin_pending_list_limit;
 
 /* ginutil.c */
 extern void ginGetStats(Relation index, GinStatsData *stats);
index 4a8db5a5003495fe4f938cc2bd23a0516dfc302c..333316d78e2ef70da5acadc65c506a7d89ca8a92 100644 (file)
@@ -326,7 +326,7 @@ typedef struct GinOptions
        ((relation)->rd_options && \
         ((GinOptions *) (relation)->rd_options)->pendingListCleanupSize != -1 ? \
         ((GinOptions *) (relation)->rd_options)->pendingListCleanupSize : \
-        pending_list_cleanup_size)
+        gin_pending_list_limit)
 
 
 /* Macros for buffer lock/unlock operations */
index 45689d9950f0c1dcb248d60276456437ffdee6e4..3ecb23823084cb92fca9760391035a68a9157792 100644 (file)
@@ -2244,14 +2244,14 @@ DROP TABLE array_gin_test;
 -- Test GIN index's reloptions
 --
 CREATE INDEX gin_relopts_test ON array_index_op_test USING gin (i)
-  WITH (FASTUPDATE=on, PENDING_LIST_CLEANUP_SIZE=128);
+  WITH (FASTUPDATE=on, GIN_PENDING_LIST_LIMIT=128);
 \d+ gin_relopts_test
      Index "public.gin_relopts_test"
  Column |  Type   | Definition | Storage 
 --------+---------+------------+---------
  i      | integer | i          | plain
 gin, for table "public.array_index_op_test"
-Options: fastupdate=on, pending_list_cleanup_size=128
+Options: fastupdate=on, gin_pending_list_limit=128
 
 --
 -- HASH
index 619558551e5308c1146c7b7e470083da7feb7bfa..e837676d28e28bff15fa163cdc19130480090e5c 100644 (file)
@@ -658,7 +658,7 @@ DROP TABLE array_gin_test;
 -- Test GIN index's reloptions
 --
 CREATE INDEX gin_relopts_test ON array_index_op_test USING gin (i)
-  WITH (FASTUPDATE=on, PENDING_LIST_CLEANUP_SIZE=128);
+  WITH (FASTUPDATE=on, GIN_PENDING_LIST_LIMIT=128);
 \d+ gin_relopts_test
 
 --