database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-09-03 15:22:11 +03:00
Code Activity

Doc: move unparenthesized syntaxes for a few commands.

Browse Source 
Move documentation of the unparenthesized syntaxes for VACUUM,
ANALYZE, EXPLAIN, and CLUSTER to the "Compatibility" section of
their documentation to improve readability of the preferred,
parenthesized syntaxes.

Author: Melanie Plageman
Discussion: https://postgr.es/m/CAAKRu_bc5uHieG1976kGqJKxyWtyQt9yvktjsVX%2Bi7NOigDjOA%40mail.gmail.com
This commit is contained in:
Nathan Bossart
2023-07-19 15:26:59 -07:00
parent cdaedfc96d
commit ab29a7a9c6
4 changed files with 38 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
doc/src/sgml/ref/explain.sgml
View File

@@ -32,7 +32,6 @@ PostgreSQL documentation
<refsynopsisdiv>
<synopsis>
EXPLAIN [ ( <replaceable class="parameter">option</replaceable> [, ...] ) ] <replaceable class="parameter">statement</replaceable>
EXPLAIN [ ANALYZE ] [ VERBOSE ] <replaceable class="parameter">statement</replaceable>
<phrase>where <replaceable class="parameter">option</replaceable> can be one of:</phrase>
@@ -106,14 +105,6 @@ ROLLBACK;
</programlisting>
</para>
</important>
<para>
Only the <literal>ANALYZE</literal> and <literal>VERBOSE</literal> options
can be specified, and only in that order, without surrounding the option
list in parentheses. Prior to <productname>PostgreSQL</productname> 9.0,
the unparenthesized syntax was the only one supported. It is expected that
all new options will be supported only in the parenthesized syntax.
</para>
</refsect1>
<refsect1>
@@ -529,6 +520,16 @@ EXPLAIN (GENERIC_PLAN)
<para>
There is no <command>EXPLAIN</command> statement defined in the SQL standard.
</para>
<para>
The following syntax was used before <productname>PostgreSQL</productname>
version 9.0 and is still supported:
<synopsis>
EXPLAIN [ ANALYZE ] [ VERBOSE ] <replaceable class="parameter">statement</replaceable>
</synopsis>
Note that in this syntax, the options must be specified in exactly the order
shown.
</para>
</refsect1>
<refsect1>