diff options
| author | Tom Lane <tgl@sss.pgh.pa.us> | 2012-09-17 14:59:46 -0400 |
|---|---|---|
| committer | Tom Lane <tgl@sss.pgh.pa.us> | 2012-09-17 14:59:46 -0400 |
| commit | c842673b86b1ad235e7296b47861e70f556eedab (patch) | |
| tree | 57b2347f0a828eb9576856531e513f307eb7c89e /doc/src/sgml/ref/truncate.sgml | |
| parent | 5010bbc2c5143a7dc894da36732e510f8ceb6b87 (diff) | |
Provide adequate documentation of the "table_name *" notation.
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.
Diffstat (limited to 'doc/src/sgml/ref/truncate.sgml')
| -rw-r--r-- | doc/src/sgml/ref/truncate.sgml | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/doc/src/sgml/ref/truncate.sgml b/doc/src/sgml/ref/truncate.sgml index bec47fdbab0..83b3812fe2d 100644 --- a/doc/src/sgml/ref/truncate.sgml +++ b/doc/src/sgml/ref/truncate.sgml @@ -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> |