summaryrefslogtreecommitdiff
path: root/doc/src
diff options
context:
space:
mode:
authorDavid Rowley2024-10-29 03:24:10 +0000
committerDavid Rowley2024-10-29 03:24:10 +0000
commitdda781609f977315c9ecdefc1e29f9499393aaa4 (patch)
tree73c877db4e4371c055da81cda08d49cc98306b0f /doc/src
parent49a23441ca7f314c25794a9a547011c0a858cfaa (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
Diffstat (limited to 'doc/src')
-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 dc401087dc6..d54f9049569 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>