aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlexander Korotkov <akorotkov@postgresql.org>2024-06-21 15:39:13 +0300
committerAlexander Korotkov <akorotkov@postgresql.org>2024-06-21 15:39:13 +0300
commit82e79ee46b1c880cb7376cf4399c9883c1ddfaea (patch)
treeafc2b83fc5b92205c0dd04b5eb6696a9dd813952
parentfd49e8f32325c675d9bb6e26fcdbe9754249932f (diff)
downloadpostgresql-82e79ee46b1c880cb7376cf4399c9883c1ddfaea.tar.gz
postgresql-82e79ee46b1c880cb7376cf4399c9883c1ddfaea.zip
Add doc entry for the new GUC paramenter enable_group_by_reordering
0452b461bc4 adds alternative orderings of group-by keys during the query optimization. This new feature is controlled by the new GUC parameter enable_group_by_reordering, which accidentally came without the documentation. This commit adds the missing documentation for that GUC. Reported-by: Bruce Momjian Discussion: https://postgr.es/m/ZnDx2FYlba_OafQd%40momjian.us Author: Andrei Lepikhov Reviewed-by: Pavel Borisov, Alexander Korotkov
-rw-r--r--doc/src/sgml/config.sgml19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index 698169afdb6..0c7a9082c54 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -5341,6 +5341,25 @@ ANY <replaceable class="parameter">num_sync</replaceable> ( <replaceable class="
</listitem>
</varlistentry>
+ <varlistentry id="guc-enable-groupby-reordering" xreflabel="enable_group_by_reordering">
+ <term><varname>enable_group_by_reordering</varname> (<type>boolean</type>)
+ <indexterm>
+ <primary><varname>enable_group_by_reordering</varname> configuration parameter</primary>
+ </indexterm>
+ </term>
+ <listitem>
+ <para>
+ Controls if the query planner will produce a plan which will provide
+ <literal>GROUP BY</literal> keys sorted in the order of keys of
+ a child node of the plan, such as an index scan. When disabled, the
+ query planner will produce a plan with <literal>GROUP BY</literal>
+ keys only sorted to match the <literal>ORDER BY</literal> clause,
+ if any. When enabled, the planner will try to produce a more
+ efficient plan. The default value is <literal>on</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+
<varlistentry id="guc-enable-hashagg" xreflabel="enable_hashagg">
<term><varname>enable_hashagg</varname> (<type>boolean</type>)
<indexterm>