aboutsummaryrefslogtreecommitdiff
path: root/doc/src
diff options
context:
space:
mode:
authorFujii Masao <fujii@postgresql.org>2019-05-23 01:18:16 +0900
committerFujii Masao <fujii@postgresql.org>2019-05-23 01:18:16 +0900
commit03de5187d50af67d154a47cf00899290dca13003 (patch)
tree595efc01eb46ed030a22a9f23dde9711159a37fa /doc/src
parent166f69f769c83ef8759d905bf7f1a9aa1d97a340 (diff)
downloadpostgresql-03de5187d50af67d154a47cf00899290dca13003.tar.gz
postgresql-03de5187d50af67d154a47cf00899290dca13003.zip
Mention ANALYZE boolean options in documentation.
Commit 41b54ba78e allowed not only VACUUM but also ANALYZE options to take a boolean argument. But it forgot to update the documentation for ANALYZE. This commit adds the descriptions about those ANALYZE boolean options into the documentation. This patch also updates tab-completion for ANALYZE boolean options. Reported-by: Kyotaro Horiguchi Author: Fujii Masao Reviewed-by: Masahiko Sawada, Michael Paquier Discussion: https://postgr.es/m/CAHGQGwHTUt-kuwgiwe8f0AvTnB+ySqJWh95jvmh-qcoKW9YA9g@mail.gmail.com
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/sgml/ref/analyze.sgml18
-rw-r--r--doc/src/sgml/release-12.sgml4
2 files changed, 18 insertions, 4 deletions
diff --git a/doc/src/sgml/ref/analyze.sgml b/doc/src/sgml/ref/analyze.sgml
index fea7f465215..4e70b513b5c 100644
--- a/doc/src/sgml/ref/analyze.sgml
+++ b/doc/src/sgml/ref/analyze.sgml
@@ -26,8 +26,8 @@ ANALYZE [ VERBOSE ] [ <replaceable class="parameter">table_and_columns</replacea
<phrase>where <replaceable class="parameter">option</replaceable> can be one of:</phrase>
- VERBOSE
- SKIP_LOCKED
+ VERBOSE [ <replaceable class="parameter">boolean</replaceable> ]
+ SKIP_LOCKED [ <replaceable class="parameter">boolean</replaceable> ]
<phrase>and <replaceable class="parameter">table_and_columns</replaceable> is:</phrase>
@@ -96,6 +96,20 @@ ANALYZE [ VERBOSE ] [ <replaceable class="parameter">table_and_columns</replacea
</varlistentry>
<varlistentry>
+ <term><replaceable class="parameter">boolean</replaceable></term>
+ <listitem>
+ <para>
+ Specifies whether the selected option should be turned on or off.
+ You can write <literal>TRUE</literal>, <literal>ON</literal>, or
+ <literal>1</literal> to enable the option, and <literal>FALSE</literal>,
+ <literal>OFF</literal>, or <literal>0</literal> to disable it. The
+ <replaceable class="parameter">boolean</replaceable> value can also
+ be omitted, in which case <literal>TRUE</literal> is assumed.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><replaceable class="parameter">table_name</replaceable></term>
<listitem>
<para>
diff --git a/doc/src/sgml/release-12.sgml b/doc/src/sgml/release-12.sgml
index d80d89e6a28..90999410db8 100644
--- a/doc/src/sgml/release-12.sgml
+++ b/doc/src/sgml/release-12.sgml
@@ -1983,8 +1983,8 @@ Author: Robert Haas <rhaas@postgresql.org>
-->
<para>
- Allow <command>VACUUM</command> to take optional boolean argument
- specifications (Masahiko Sawada)
+ Allow <command>VACUUM</command> and <command>ANALYZE</command>
+ to take optional boolean argument specifications (Masahiko Sawada)
</para>
</listitem>