diff options
| author | David Rowley <drowley@postgresql.org> | 2024-10-29 16:25:51 +1300 |
|---|---|---|
| committer | David Rowley <drowley@postgresql.org> | 2024-10-29 16:25:51 +1300 |
| commit | ca643bcd7a8173dc902f3be748f62893ae0f9cc0 (patch) | |
| tree | 2e27450f08bf72ba45c3f2f1d9a111c76734ee13 | |
| parent | d130a64ee003bd6f272ad63f2721e204b443a582 (diff) | |
| download | postgresql-ca643bcd7a8173dc902f3be748f62893ae0f9cc0.tar.gz postgresql-ca643bcd7a8173dc902f3be748f62893ae0f9cc0.zip | |
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 11bb573842e..c2318844ca8 100644 --- a/doc/src/sgml/config.sgml +++ b/doc/src/sgml/config.sgml @@ -4995,8 +4995,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> @@ -5011,7 +5012,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> |