postgres.git / summary / log / commit / refs

commit    4f47ee03d5f8adad0da40f650a165393b49cbcf1
Author:   David Rowley <drowley@postgresql.org>
Date:     Tue Oct 29 03:25:08 2024 +0000
First released in: 18.0, 12.21, 13.17, 14.14, 15.9, 16.5, 17.1

    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 18c104f079f..386dab08e92 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -5226,8 +5226,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>
@@ -5242,7 +5243,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>


[parent: 16ebf4f9714a]