Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit ab29a7a

Browse files
Doc: move unparenthesized syntaxes for a few commands.
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
1 parent cdaedfc commit ab29a7a

File tree

4 files changed

+38
-31
lines changed

4 files changed

+38
-31
lines changed

doc/src/sgml/ref/analyze.sgml

+8-8
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ PostgreSQL documentation
2222
<refsynopsisdiv>
2323
<synopsis>
2424
ANALYZE [ ( <replaceable class="parameter">option</replaceable> [, ...] ) ] [ <replaceable class="parameter">table_and_columns</replaceable> [, ...] ]
25-
ANALYZE [ VERBOSE ] [ <replaceable class="parameter">table_and_columns</replaceable> [, ...] ]
2625

2726
<phrase>where <replaceable class="parameter">option</replaceable> can be one of:</phrase>
2827

@@ -56,13 +55,6 @@ ANALYZE [ VERBOSE ] [ <replaceable class="parameter">table_and_columns</replacea
5655
It is further possible to give a list of column names for a table,
5756
in which case only the statistics for those columns are collected.
5857
</para>
59-
60-
<para>
61-
When the option list is surrounded by parentheses, the options can be
62-
written in any order. The parenthesized syntax was added in
63-
<productname>PostgreSQL</productname> 11; the unparenthesized syntax
64-
is deprecated.
65-
</para>
6658
</refsect1>
6759

6860
<refsect1>
@@ -339,6 +331,14 @@ ANALYZE [ VERBOSE ] [ <replaceable class="parameter">table_and_columns</replacea
339331
<para>
340332
There is no <command>ANALYZE</command> statement in the SQL standard.
341333
</para>
334+
335+
<para>
336+
The following syntax was used before <productname>PostgreSQL</productname>
337+
version 11 and is still supported:
338+
<synopsis>
339+
ANALYZE [ VERBOSE ] [ <replaceable class="parameter">table_and_columns</replaceable> [, ...] ]
340+
</synopsis>
341+
</para>
342342
</refsect1>
343343

344344
<refsect1>

doc/src/sgml/ref/cluster.sgml

+10-4
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ PostgreSQL documentation
2222
<refsynopsisdiv>
2323
<synopsis>
2424
CLUSTER [ ( <replaceable class="parameter">option</replaceable> [, ...] ) ] [ <replaceable class="parameter">table_name</replaceable> [ USING <replaceable class="parameter">index_name</replaceable> ] ]
25-
CLUSTER [ VERBOSE ] [ <replaceable class="parameter">table_name</replaceable> [ USING <replaceable class="parameter">index_name</replaceable> ] ]
2625

2726
<phrase>where <replaceable class="parameter">option</replaceable> can be one of:</phrase>
2827

@@ -240,12 +239,19 @@ CLUSTER;
240239
</para>
241240

242241
<para>
243-
The syntax
242+
The following syntax was used before <productname>PostgreSQL</productname>
243+
17 and is still supported:
244+
<synopsis>
245+
CLUSTER [ VERBOSE ] [ <replaceable class="parameter">table_name</replaceable> [ USING <replaceable class="parameter">index_name</replaceable> ] ]
246+
</synopsis>
247+
</para>
248+
249+
<para>
250+
The following syntax was used before <productname>PostgreSQL</productname>
251+
8.3 and is still supported:
244252
<synopsis>
245253
CLUSTER <replaceable class="parameter">index_name</replaceable> ON <replaceable class="parameter">table_name</replaceable>
246254
</synopsis>
247-
is also supported for compatibility with pre-8.3 <productname>PostgreSQL</productname>
248-
versions.
249255
</para>
250256
</refsect1>
251257

doc/src/sgml/ref/explain.sgml

+10-9
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ PostgreSQL documentation
3232
<refsynopsisdiv>
3333
<synopsis>
3434
EXPLAIN [ ( <replaceable class="parameter">option</replaceable> [, ...] ) ] <replaceable class="parameter">statement</replaceable>
35-
EXPLAIN [ ANALYZE ] [ VERBOSE ] <replaceable class="parameter">statement</replaceable>
3635

3736
<phrase>where <replaceable class="parameter">option</replaceable> can be one of:</phrase>
3837

@@ -106,14 +105,6 @@ ROLLBACK;
106105
</programlisting>
107106
</para>
108107
</important>
109-
110-
<para>
111-
Only the <literal>ANALYZE</literal> and <literal>VERBOSE</literal> options
112-
can be specified, and only in that order, without surrounding the option
113-
list in parentheses. Prior to <productname>PostgreSQL</productname> 9.0,
114-
the unparenthesized syntax was the only one supported. It is expected that
115-
all new options will be supported only in the parenthesized syntax.
116-
</para>
117108
</refsect1>
118109

119110
<refsect1>
@@ -529,6 +520,16 @@ EXPLAIN (GENERIC_PLAN)
529520
<para>
530521
There is no <command>EXPLAIN</command> statement defined in the SQL standard.
531522
</para>
523+
524+
<para>
525+
The following syntax was used before <productname>PostgreSQL</productname>
526+
version 9.0 and is still supported:
527+
<synopsis>
528+
EXPLAIN [ ANALYZE ] [ VERBOSE ] <replaceable class="parameter">statement</replaceable>
529+
</synopsis>
530+
Note that in this syntax, the options must be specified in exactly the order
531+
shown.
532+
</para>
532533
</refsect1>
533534

534535
<refsect1>

doc/src/sgml/ref/vacuum.sgml

+10-10
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ PostgreSQL documentation
2222
<refsynopsisdiv>
2323
<synopsis>
2424
VACUUM [ ( <replaceable class="parameter">option</replaceable> [, ...] ) ] [ <replaceable class="parameter">table_and_columns</replaceable> [, ...] ]
25-
VACUUM [ FULL ] [ FREEZE ] [ VERBOSE ] [ ANALYZE ] [ <replaceable class="parameter">table_and_columns</replaceable> [, ...] ]
2625

2726
<phrase>where <replaceable class="parameter">option</replaceable> can be one of:</phrase>
2827

@@ -90,15 +89,6 @@ VACUUM [ FULL ] [ FREEZE ] [ VERBOSE ] [ ANALYZE ] [ <replaceable class="paramet
9089
much slower and requires an <literal>ACCESS EXCLUSIVE</literal> lock on
9190
each table while it is being processed.
9291
</para>
93-
94-
<para>
95-
When the option list is surrounded by parentheses, the options can be
96-
written in any order. Without parentheses, options must be specified
97-
in exactly the order shown above.
98-
The parenthesized syntax was added in
99-
<productname>PostgreSQL</productname> 9.0; the unparenthesized
100-
syntax is deprecated.
101-
</para>
10292
</refsect1>
10393

10494
<refsect1>
@@ -525,6 +515,16 @@ VACUUM (VERBOSE, ANALYZE) onek;
525515
<para>
526516
There is no <command>VACUUM</command> statement in the SQL standard.
527517
</para>
518+
519+
<para>
520+
The following syntax was used before <productname>PostgreSQL</productname>
521+
version 9.0 and is still supported:
522+
<synopsis>
523+
VACUUM [ FULL ] [ FREEZE ] [ VERBOSE ] [ ANALYZE ] [ <replaceable class="parameter">table_and_columns</replaceable> [, ...] ]
524+
</synopsis>
525+
Note that in this syntax, the options must be specified in exactly the order
526+
shown.
527+
</para>
528528
</refsect1>
529529

530530
<refsect1>

0 commit comments

Comments
 (0)