Mention ANALYZE boolean options in documentation.

MasaoFujii · MasaoFujii · commit 03de5187d50a · 2019-05-23T01:18:16.000+09:00
Commit 41b54ba 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
diff --git 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>
 
@@ -95,6 +95,20 @@ ANALYZE [ VERBOSE ] [ <replaceable class="parameter">table_and_columns</replacea
     </listitem>
    </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>
diff --git 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>
 
diff --git a/src/bin/psql/tab-complete.c b/src/bin/psql/tab-complete.c
@@ -2101,6 +2101,8 @@ psql_completion(const char *text, int start, int end)
 		 */
 		if (ends_with(prev_wd, '(') || ends_with(prev_wd, ','))
 			COMPLETE_WITH("VERBOSE", "SKIP_LOCKED");
+		else if (TailMatches("VERBOSE|SKIP_LOCKED"))
+			COMPLETE_WITH("ON", "OFF");
 	}
 	else if (HeadMatches("ANALYZE") && TailMatches("("))
 		/* "ANALYZE (" should be caught above, so assume we want columns */

Original file line number	Diff line number	Diff line change
`@@ -2101,6 +2101,8 @@ psql_completion(const char *text, int start, int end)`
`2101`	`2101`	`*/`
`2102`	`2102`	`if (ends_with(prev_wd, '(') \|\| ends_with(prev_wd, ','))`
`2103`	`2103`	`COMPLETE_WITH("VERBOSE", "SKIP_LOCKED");`
	`2104`	`+ else if (TailMatches("VERBOSE\|SKIP_LOCKED"))`
	`2105`	`+ COMPLETE_WITH("ON", "OFF");`
`2104`	`2106`	`}`
`2105`	`2107`	`else if (HeadMatches("ANALYZE") && TailMatches("("))`
`2106`	`2108`	`/* "ANALYZE (" should be caught above, so assume we want columns */`