diff options
Diffstat (limited to 'doc/src')
| -rw-r--r-- | doc/src/sgml/ref/truncate.sgml | 133 |
1 files changed, 133 insertions, 0 deletions
diff --git a/doc/src/sgml/ref/truncate.sgml b/doc/src/sgml/ref/truncate.sgml new file mode 100644 index 00000000000..998f826d9cf --- /dev/null +++ b/doc/src/sgml/ref/truncate.sgml @@ -0,0 +1,133 @@ +<!-- +$Header: /cvsroot/pgsql/doc/src/sgml/ref/truncate.sgml,v 1.1 1999/09/23 17:02:28 momjian Exp $ +Postgres documentation +--> + +<refentry id="SQL-TRUNCATE"> + <refmeta> + <refentrytitle id="SQL-TRUNCATE-TITLE"> + TRUNCATE + </refentrytitle> + <refmiscinfo>SQL - Language Statements</refmiscinfo> + </refmeta> + <refnamediv> + <refname> + TRUNCATE + </refname> + <refpurpose> + Close a cursor + </refpurpose> + </refnamediv> + <refsynopsisdiv> + <refsynopsisdivinfo> + <date>1999-07-20</date> + </refsynopsisdivinfo> + <synopsis> +TRUNCATE TABLE <replaceable class="PARAMETER">table</replaceable> + </synopsis> + + <refsect2 id="R2-SQL-TRUNCATE-1"> + <refsect2info> + <date>1998-09-08</date> + </refsect2info> + <title> + Inputs + </title> + <para> + + <variablelist> + <varlistentry> + <term><replaceable class="PARAMETER">table</replaceable></term> + <listitem> + <para> + The table name to truncate. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect2> + + <refsect2 id="R2-SQL-TRUNCATE-2"> + <refsect2info> + <date>1998-09-08</date> + </refsect2info> + <title> + Outputs + </title> + <para> + + <variablelist> + <varlistentry> + <term><computeroutput> +TRUNCATE + </computeroutput></term> + <listitem> + <para> + Message returned if the table is successfully truncated. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect2> + </refsynopsisdiv> + + <refsect1 id="R1-SQL-TRUNCATE-1"> + <refsect1info> + <date>1998-09-08</date> + </refsect1info> + <title> + Description + </title> + <para> + <command>TRUNCATE</command> quickly removes all rows from a table. + </para> + + <refsect1 id="R1-SQL-TRUNCATE-2"> + <title> + Usage + </title> + <para> + Truncate the table bigtable. + </para> + <programlisting> +TRUNCATE TABLE bigtable; + </programlisting> + </refsect1> + + <refsect1 id="R1-SQL-TRUNCATE-3"> + <title> + Compatibility + </title> + + <refsect2 id="R2-SQL-TRUNCATE-4"> + <refsect2info> + <date>1998-09-08</date> + </refsect2info> + <title> + SQL92 + </title> + <para> + There is no <command>TRUNCATE</command> in <acronym>SQL92</acronym>. + </para> + </refsect2> + </refsect1> +</refentry> + +<!-- Keep this comment at the end of the file +Local variables: +mode: sgml +sgml-omittag:t +sgml-shorttag:t +sgml-minimize-attributes:nil +sgml-always-quote-attributes:t +sgml-indent-step:1 +sgml-indent-data:t +sgml-parent-document:nil +sgml-default-dtd-file:"../reference.ced" +sgml-exposed-tags:nil +sgml-local-catalogs:"/usr/lib/sgml/catalog" +sgml-local-ecat-files:nil +End: +--> |
