summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Rowley <drowley@postgresql.org>2024-10-29 16:26:18 +1300
committerDavid Rowley <drowley@postgresql.org>2024-10-29 16:26:18 +1300
commitee8db41a94326e670255ad6c50b887c8c9c897f5 (patch)
tree60ca6f5a6a1727bec253fed526bf83b8d53ac746
parent1e74e31f3c93f01c2ddb1e2b25db23fb0533244c (diff)
Doc: clarify enable_indexscan=off also disabled Index Only Scans
Disabling enable_indexscan has always also disabled Index Only Scans. Here we make that more clear in the documentation in an attempt to prevent future complaints complaining about this expected behavior. Reported-by: Melanie Plageman Author: David G. Johnston, David Rowley Backpatch-through: 12, oldest supported version Discussion: https://postgr.es/m/CAAKRu_atV=kovgpaLREyG68PB5+ncKvJ2UNoeRetEgyC3Yb5Sw@mail.gmail.com
-rw-r--r--doc/src/sgml/config.sgml9
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index c96166794d4..07ef9dcfb00 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -4796,8 +4796,9 @@ ANY <replaceable class="parameter">num_sync</replaceable> ( <replaceable class="
</term>
<listitem>
<para>
- Enables or disables the query planner's use of index-scan plan
- types. The default is <literal>on</literal>.
+ Enables or disables the query planner's use of index-scan and
+ index-only-scan plan types. The default is <literal>on</literal>.
+ Also see <xref linkend="guc-enable-indexonlyscan"/>.
</para>
</listitem>
</varlistentry>
@@ -4812,7 +4813,9 @@ ANY <replaceable class="parameter">num_sync</replaceable> ( <replaceable class="
<para>
Enables or disables the query planner's use of index-only-scan plan
types (see <xref linkend="indexes-index-only-scans"/>).
- The default is <literal>on</literal>.
+ The default is <literal>on</literal>. The
+ <xref linkend="guc-enable-indexscan"/> setting must also be
+ enabled to have the query planner consider index-only-scans.
</para>
</listitem>
</varlistentry>