From dda781609f977315c9ecdefc1e29f9499393aaa4 Mon Sep 17 00:00:00 2001
From: David Rowley <drowley@postgresql.org>
Date: Tue, 29 Oct 2024 16:24:10 +1300
Subject: [PATCH] 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
---
doc/src/sgml/config.sgml | 9 ++++++---
1 file changed, 6 insertions(+), 3 deletions(-)
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index dc401087dc..d54f904956 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -5442,8 +5442,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>
@@ -5458,7 +5459,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>