| <!-- |
| $PostgreSQL: pgsql/doc/src/sgml/ref/abort.sgml,v 1.18 2008/11/14 10:22:45 petere Exp $ |
| PostgreSQL documentation |
| --> |
| |
| <refentry id="SQL-ABORT"> |
| <refmeta> |
| <refentrytitle id="sql-abort-title">ABORT</refentrytitle> |
| <manvolnum>7</manvolnum> |
| <refmiscinfo>SQL - Language Statements</refmiscinfo> |
| </refmeta> |
| |
| <refnamediv> |
| <refname>ABORT</refname> |
| <refpurpose>abort the current transaction</refpurpose> |
| </refnamediv> |
| |
| <indexterm zone="sql-abort"> |
| <primary>ABORT</primary> |
| </indexterm> |
| |
| <refsynopsisdiv> |
| <synopsis> |
| ABORT [ WORK | TRANSACTION ] |
| </synopsis> |
| </refsynopsisdiv> |
| |
| <refsect1> |
| <title>Description</title> |
| |
| <para> |
| <command>ABORT</command> rolls back the current transaction and causes |
| all the updates made by the transaction to be discarded. |
| This command is identical |
| in behavior to the standard <acronym>SQL</acronym> command |
| <xref linkend="SQL-ROLLBACK" endterm="SQL-ROLLBACK-TITLE">, |
| and is present only for historical reasons. |
| </para> |
| </refsect1> |
| |
| <refsect1> |
| <title>Parameters</title> |
| |
| <variablelist> |
| <varlistentry> |
| <term><literal>WORK</literal></term> |
| <term><literal>TRANSACTION</literal></term> |
| <listitem> |
| <para> |
| Optional key words. They have no effect. |
| </para> |
| </listitem> |
| </varlistentry> |
| </variablelist> |
| </refsect1> |
| |
| <refsect1> |
| <title>Notes</title> |
| |
| <para> |
| Use <xref linkend="SQL-COMMIT" endterm="SQL-COMMIT-TITLE"> to |
| successfully terminate a transaction. |
| </para> |
| |
| <para> |
| Issuing <command>ABORT</> when not inside a transaction does |
| no harm, but it will provoke a warning message. |
| </para> |
| </refsect1> |
| |
| <refsect1> |
| <title>Examples</title> |
| |
| <para> |
| To abort all changes: |
| <programlisting> |
| ABORT; |
| </programlisting> |
| </para> |
| </refsect1> |
| |
| <refsect1> |
| <title>Compatibility</title> |
| |
| <para> |
| This command is a <productname>PostgreSQL</productname> extension |
| present for historical reasons. <command>ROLLBACK</command> is the |
| equivalent standard SQL command. |
| </para> |
| </refsect1> |
| |
| <refsect1> |
| <title>See Also</title> |
| |
| <simplelist type="inline"> |
| <member><xref linkend="sql-begin" endterm="sql-begin-title"></member> |
| <member><xref linkend="sql-commit" endterm="sql-commit-title"></member> |
| <member><xref linkend="sql-rollback" endterm="sql-rollback-title"></member> |
| </simplelist> |
| </refsect1> |
| </refentry> |