database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-08-28 18:48:04 +03:00
Code Activity

Provide adequate documentation of the "table_name *" notation.

Browse Source 
Somewhere along the line, somebody decided to remove all trace of this
notation from the documentation text.  It was still in the command syntax
synopses, or at least some of them, but with no indication what it meant.
This will not do, as evidenced by the confusion apparent in bug #7543;
even if the notation is now unnecessary, people will find it in legacy
SQL code and need to know what it does.
This commit is contained in:
Tom Lane
2012-09-17 14:59:31 -04:00
parent b2e3bea3af
commit 3c64342c86
9 changed files with 104 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
doc/src/sgml/ref/truncate.sgml
View File

@@ -21,7 +21,7 @@ PostgreSQL documentation
<refsynopsisdiv>
<synopsis>
TRUNCATE [ TABLE ] [ ONLY ] <replaceable class="PARAMETER">name</replaceable> [, ... ]
TRUNCATE [ TABLE ] [ ONLY ] <replaceable class="PARAMETER">name</replaceable> [ * ] [, ... ]
[ RESTART IDENTITY | CONTINUE IDENTITY ] [ CASCADE | RESTRICT ]
</synopsis>
</refsynopsisdiv>
@@ -47,10 +47,12 @@ TRUNCATE [ TABLE ] [ ONLY ] <replaceable class="PARAMETER">name</replaceable> [,
<term><replaceable class="PARAMETER">name</replaceable></term>
<listitem>
<para>
The name (optionally schema-qualified) of a table to be
truncated. If <literal>ONLY</> is specified, only that table is
truncated. If <literal>ONLY</> is not specified, the table and
all its descendant tables (if any) are truncated.
The name (optionally schema-qualified) of a table to truncate.
If <literal>ONLY</> is specified before the table name, only that table
is truncated. If <literal>ONLY</> is not specified, the table and all
its descendant tables (if any) are truncated. Optionally, <literal>*</>
can be specified after the table name to explicitly indicate that
descendant tables are included.
</para>
</listitem>
</varlistentry>