diff options
| author | David Rowley | 2024-10-29 03:24:47 +0000 |
|---|---|---|
| committer | David Rowley | 2024-10-29 03:24:47 +0000 |
| commit | e5086b3ff4413fdd163c85a2ab5bfa26c7668cd3 (patch) | |
| tree | 40cdfc5fb51fe5f81e9ccfd93fd8663fbb4efa50 | |
| parent | bb584e831288042d9aee368a1c5daa3dafbb95c3 (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.sgml | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml index 938ae2c6089..c782fc99a1b 100644 --- a/doc/src/sgml/config.sgml +++ b/doc/src/sgml/config.sgml @@ -5419,8 +5419,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> @@ -5435,7 +5436,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> |