Rename enable_incrementalsort for clarity

Author: James Coleman <jtc331@gmail.com>
Discussion: https://www.postgresql.org/message-id/flat/df652910-e985-9547-152c-9d4357dc3979%402ndquadrant.com

diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index 23310132f54aee1676ce11833301a7d2b05d0382..cfd9be2f8e38ee16edf0b434946ed61a3064aef7 100644 (file)
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -4574,10 +4574,10 @@ ANY <replaceable class="parameter">num_sync</replaceable> ( <replaceable class="
       </listitem>
      </varlistentry>
 
-     <varlistentry id="guc-enable-incrementalsort" xreflabel="enable_incrementalsort">
-      <term><varname>enable_incrementalsort</varname> (<type>boolean</type>)
+     <varlistentry id="guc-enable-incremental-sort" xreflabel="enable_incremental_sort">
+      <term><varname>enable_incremental_sort</varname> (<type>boolean</type>)
       <indexterm>
-       <primary><varname>enable_incrementalsort</varname> configuration parameter</primary>
+       <primary><varname>enable_incremental_sort</varname> configuration parameter</primary>
       </indexterm>
       </term>
       <listitem>

diff --git a/doc/src/sgml/release-13.sgml b/doc/src/sgml/release-13.sgml
index 45d8f0bf408e65fc5f0ff90729aa11c6f9481dc9..7395edb5ba5fd4b0c070440a7756b412c6a575e2 100644 (file)
--- a/doc/src/sgml/release-13.sgml
+++ b/doc/src/sgml/release-13.sgml
@@ -588,7 +588,7 @@ Author: Tomas Vondra <tomas.vondra@postgresql.org>
 -->
 
        <para>
-        Implement <link linkend="guc-enable-incrementalsort">incremental
+        Implement <link linkend="guc-enable-incremental-sort">incremental
         sorting</link> (James Coleman, Alexander Korotkov, Tomas Vondra)
        </para>
 
@@ -596,7 +596,7 @@ Author: Tomas Vondra <tomas.vondra@postgresql.org>
         If a result is already sorted by several leading keys, this
         allows for batch sorting of additional trailing keys because the
         previous keys are already equal.  This is controlled by <xref
-        linkend="guc-enable-incrementalsort"/>.
+        linkend="guc-enable-incremental-sort"/>.
        </para>
       </listitem>
 

diff --git a/src/backend/optimizer/path/allpaths.c b/src/backend/optimizer/path/allpaths.c
index 63761d559381606261914babcf90fc038dd7fbdc..c4e1967f1231b4ddf64b73f3a347c705cb80ba4c 100644 (file)
--- a/src/backend/optimizer/path/allpaths.c
+++ b/src/backend/optimizer/path/allpaths.c
@@ -2915,7 +2915,7 @@ generate_useful_gather_paths(PlannerInfo *root, RelOptInfo *rel, bool override_r
             * Consider incremental sort, but only when the subpath is already
             * partially sorted on a pathkey prefix.
             */
-           if (enable_incrementalsort && presorted_keys > 0)
+           if (enable_incremental_sort && presorted_keys > 0)
            {
                Path       *tmp;
 

diff --git a/src/backend/optimizer/path/costsize.c b/src/backend/optimizer/path/costsize.c
index 4ff3c7a2fd38ad3a1744ee434a54f2cdf4290a5e..87c9b49ce147a1fd92b3bbff16bfdd747f1e1acb 100644 (file)
--- a/src/backend/optimizer/path/costsize.c
+++ b/src/backend/optimizer/path/costsize.c
@@ -128,7 +128,7 @@ bool        enable_indexonlyscan = true;
 bool       enable_bitmapscan = true;
 bool       enable_tidscan = true;
 bool       enable_sort = true;
-bool       enable_incrementalsort = true;
+bool       enable_incremental_sort = true;
 bool       enable_hashagg = true;
 bool       hashagg_avoid_disk_plan = true;
 bool       enable_nestloop = true;

diff --git a/src/backend/optimizer/plan/planner.c b/src/backend/optimizer/plan/planner.c
index 4131019fc98536e963667ab5bcba17b49c9b0241..14f3fd44e3615320fbb64c7dfe59cf9f7729541e 100644 (file)
--- a/src/backend/optimizer/plan/planner.c
+++ b/src/backend/optimizer/plan/planner.c
@@ -5014,7 +5014,7 @@ create_ordered_paths(PlannerInfo *root,
             * presorted the path is. Additionally incremental sort may enable
             * a cheaper startup path to win out despite higher total cost.
             */
-           if (!enable_incrementalsort)
+           if (!enable_incremental_sort)
                continue;
 
            /* Likewise, if the path can't be used for incremental sort. */
@@ -5095,7 +5095,7 @@ create_ordered_paths(PlannerInfo *root,
         * sort_pathkeys because then we can't possibly have a presorted
         * prefix of the list without having the list be fully sorted.
         */
-       if (enable_incrementalsort && list_length(root->sort_pathkeys) > 1)
+       if (enable_incremental_sort && list_length(root->sort_pathkeys) > 1)
        {
            ListCell   *lc;
 
@@ -6572,7 +6572,7 @@ add_paths_to_grouping_rel(PlannerInfo *root, RelOptInfo *input_rel,
             * when the path is not already sorted and when incremental sort
             * is enabled.
             */
-           if (is_sorted || !enable_incrementalsort)
+           if (is_sorted || !enable_incremental_sort)
                continue;
 
            /* Restore the input path (we might have added Sort on top). */
@@ -6699,7 +6699,7 @@ add_paths_to_grouping_rel(PlannerInfo *root, RelOptInfo *input_rel,
                 * when the path is not already sorted and when incremental
                 * sort is enabled.
                 */
-               if (is_sorted || !enable_incrementalsort)
+               if (is_sorted || !enable_incremental_sort)
                    continue;
 
                /* Restore the input path (we might have added Sort on top). */
@@ -7022,7 +7022,7 @@ create_partial_grouping_paths(PlannerInfo *root,
         * group_pathkeys because then we can't possibly have a presorted
         * prefix of the list without having the list be fully sorted.
         */
-       if (enable_incrementalsort && list_length(root->group_pathkeys) > 1)
+       if (enable_incremental_sort && list_length(root->group_pathkeys) > 1)
        {
            foreach(lc, input_rel->pathlist)
            {
@@ -7125,7 +7125,7 @@ create_partial_grouping_paths(PlannerInfo *root,
             * when the path is not already sorted and when incremental sort
             * is enabled.
             */
-           if (is_sorted || !enable_incrementalsort)
+           if (is_sorted || !enable_incremental_sort)
                continue;
 
            /* Restore the input path (we might have added Sort on top). */
@@ -7304,7 +7304,7 @@ gather_grouping_paths(PlannerInfo *root, RelOptInfo *rel)
     * group_pathkeys because then we can't possibly have a presorted prefix
     * of the list without having the list be fully sorted.
     */
-   if (!enable_incrementalsort || list_length(root->group_pathkeys) == 1)
+   if (!enable_incremental_sort || list_length(root->group_pathkeys) == 1)
        return;
 
    /* also consider incremental sort on partial paths, if enabled */

diff --git a/src/backend/utils/misc/guc.c b/src/backend/utils/misc/guc.c
index fe7e2f8b913ecb44bc13e425e8de5630ad9d4035..9f5e223920cd989736f3a658cff1b97f26e31e69 100644 (file)
--- a/src/backend/utils/misc/guc.c
+++ b/src/backend/utils/misc/guc.c
@@ -992,11 +992,11 @@ static struct config_bool ConfigureNamesBool[] =
        NULL, NULL, NULL
    },
    {
-       {"enable_incrementalsort", PGC_USERSET, QUERY_TUNING_METHOD,
+       {"enable_incremental_sort", PGC_USERSET, QUERY_TUNING_METHOD,
            gettext_noop("Enables the planner's use of incremental sort steps."),
            NULL
        },
-       &enable_incrementalsort,
+       &enable_incremental_sort,
        true,
        NULL, NULL, NULL
    },

diff --git a/src/backend/utils/misc/postgresql.conf.sample b/src/backend/utils/misc/postgresql.conf.sample
index ac02bd0c00acbfc6554748460c602606ae3e8984..bd4cb8144bee37da1a4c29517341b02598bb7785 100644 (file)
--- a/src/backend/utils/misc/postgresql.conf.sample
+++ b/src/backend/utils/misc/postgresql.conf.sample
@@ -361,7 +361,7 @@
 #enable_parallel_append = on
 #enable_seqscan = on
 #enable_sort = on
-#enable_incrementalsort = on
+#enable_incremental_sort = on
 #enable_tidscan = on
 #enable_partitionwise_join = off
 #enable_partitionwise_aggregate = off

diff --git a/src/include/optimizer/cost.h b/src/include/optimizer/cost.h
index 92e70ec0d9bf231dfd34d73e2642503d65d0bd90..613db8eab6882d2c1398e3134ef34f53ce8baa82 100644 (file)
--- a/src/include/optimizer/cost.h
+++ b/src/include/optimizer/cost.h
@@ -53,7 +53,7 @@ extern PGDLLIMPORT bool enable_indexonlyscan;
 extern PGDLLIMPORT bool enable_bitmapscan;
 extern PGDLLIMPORT bool enable_tidscan;
 extern PGDLLIMPORT bool enable_sort;
-extern PGDLLIMPORT bool enable_incrementalsort;
+extern PGDLLIMPORT bool enable_incremental_sort;
 extern PGDLLIMPORT bool enable_hashagg;
 extern PGDLLIMPORT bool hashagg_avoid_disk_plan;
 extern PGDLLIMPORT bool enable_nestloop;

diff --git a/src/test/regress/expected/incremental_sort.out b/src/test/regress/expected/incremental_sort.out
index 53accd0df97d1d0e493f43f1e92bc8fcf989fddc..e376ea1276171b3f30696d649902443c937cc342 100644 (file)
--- a/src/test/regress/expected/incremental_sort.out
+++ b/src/test/regress/expected/incremental_sort.out
@@ -1414,7 +1414,7 @@ create table t (a int, b int, c int);
 insert into t select mod(i,10),mod(i,10),i from generate_series(1,10000) s(i);
 create index on t (a);
 analyze t;
-set enable_incrementalsort = off;
+set enable_incremental_sort = off;
 explain (costs off) select a,b,sum(c) from t group by 1,2 order by 1,2,3 limit 1;
                       QUERY PLAN                      
 ------------------------------------------------------
@@ -1430,7 +1430,7 @@ explain (costs off) select a,b,sum(c) from t group by 1,2 order by 1,2,3 limit 1
                            ->  Parallel Seq Scan on t
 (10 rows)
 
-set enable_incrementalsort = on;
+set enable_incremental_sort = on;
 explain (costs off) select a,b,sum(c) from t group by 1,2 order by 1,2,3 limit 1;
                               QUERY PLAN                              
 ----------------------------------------------------------------------

diff --git a/src/test/regress/expected/partition_aggregate.out b/src/test/regress/expected/partition_aggregate.out
index c36970575f547a44a8b9bd7e8bd7615844fea6d6..45c698daf4895092ea4c81f02490d8725c769d67 100644 (file)
--- a/src/test/regress/expected/partition_aggregate.out
+++ b/src/test/regress/expected/partition_aggregate.out
@@ -12,7 +12,7 @@ SET enable_partitionwise_join TO true;
 -- Disable parallel plans.
 SET max_parallel_workers_per_gather TO 0;
 -- Disable incremental sort, which can influence selected plans due to fuzz factor.
-SET enable_incrementalsort TO off;
+SET enable_incremental_sort TO off;
 --
 -- Tests for list partitioned tables.
 --

diff --git a/src/test/regress/expected/sysviews.out b/src/test/regress/expected/sysviews.out
index 01b7786f01421bbbcc2c6b39232abbf4fe9eea13..06c4c3e47637823c0c794d1969b2b0ce3175b4a9 100644 (file)
--- a/src/test/regress/expected/sysviews.out
+++ b/src/test/regress/expected/sysviews.out
@@ -76,7 +76,7 @@ select name, setting from pg_settings where name like 'enable%';
  enable_gathermerge             | on
  enable_hashagg                 | on
  enable_hashjoin                | on
- enable_incrementalsort         | on
+ enable_incremental_sort        | on
  enable_indexonlyscan           | on
  enable_indexscan               | on
  enable_material                | on

diff --git a/src/test/regress/sql/incremental_sort.sql b/src/test/regress/sql/incremental_sort.sql
index 373e62ac13a19e60f40a8ecabfd448ab49de59f8..9c040c90e62da5c63e5853d2f44ac6248d33f51f 100644 (file)
--- a/src/test/regress/sql/incremental_sort.sql
+++ b/src/test/regress/sql/incremental_sort.sql
@@ -210,10 +210,10 @@ insert into t select mod(i,10),mod(i,10),i from generate_series(1,10000) s(i);
 create index on t (a);
 analyze t;
 
-set enable_incrementalsort = off;
+set enable_incremental_sort = off;
 explain (costs off) select a,b,sum(c) from t group by 1,2 order by 1,2,3 limit 1;
 
-set enable_incrementalsort = on;
+set enable_incremental_sort = on;
 explain (costs off) select a,b,sum(c) from t group by 1,2 order by 1,2,3 limit 1;
 
 -- Incremental sort vs. set operations with varno 0

diff --git a/src/test/regress/sql/partition_aggregate.sql b/src/test/regress/sql/partition_aggregate.sql
index 178f2079faa552b747c0777dd6eedb003f615e70..117f65ecb4f6a16f3eda1d76c9402485547f4c59 100644 (file)
--- a/src/test/regress/sql/partition_aggregate.sql
+++ b/src/test/regress/sql/partition_aggregate.sql
@@ -13,7 +13,7 @@ SET enable_partitionwise_join TO true;
 -- Disable parallel plans.
 SET max_parallel_workers_per_gather TO 0;
 -- Disable incremental sort, which can influence selected plans due to fuzz factor.
-SET enable_incrementalsort TO off;
+SET enable_incremental_sort TO off;
 
 --
 -- Tests for list partitioned tables.