postgresql/doc/src/sgml/ref/abort.sgml

<refentry id="SQL-ABORT">
 <refmeta>
  <refentrytitle>
   ABORT
  </refentrytitle>
  <refmiscinfo>SQL - Language Statements</refmiscinfo>
 </refmeta>
 <refnamediv>
  <refname>
   ABORT
  </refname>
  <refpurpose>
   Aborts the current transaction
  </refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  <refsynopsisdivinfo>
   <date>1998-09-27</date>
  </refsynopsisdivinfo>
  <synopsis>
ABORT [ TRANSACTION | WORK ]
  </synopsis>

  <refsect2 id="R2-SQL-ABORT-1">
   <refsect2info>
    <date>1998-09-27</date>
   </refsect2info>
   <title>
    Inputs
   </title>

   <para>
    None.
   </para>
  </refsect2>

  <refsect2 id="R2-SQL-ABORT-2">
   <refsect2info>
    <date>1998-09-27</date>
   </refsect2info>
   <title>
    Outputs
   </title>

   <para>

    <variablelist>
     <varlistentry>
      <term><computeroutput>
ABORT
       </computeroutput></term>
      <listitem>
       <para>
	Message returned if successful.
       </para>
      </listitem>
     </varlistentry>
     <varlistentry>
      <term><computeroutput>
NOTICE:  UserAbortTransactionBlock and not in in-progress state
ABORT
       </computeroutput></term>
      <listitem>
       <para>
	If there is not any transaction currently in progress.
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </para>
  </refsect2>
 </refsynopsisdiv>

 <refsect1 id="R1-SQL-ABORT-1">
  <refsect1info>
   <date>1998-09-27</date>
  </refsect1info>
  <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 <acronym>SQL92</acronym> command <command>ROLLBACK</command>,
   and is present only for historical reasons.
  </para>
  <refsect2 id="R2-SQL-ABORT-3">
   <refsect2info>
    <date>1998-09-27</date>
   </refsect2info>
   <title>
    Notes
   </title>
   <para>
    Use <command>COMMIT</command> to successfully
    terminate a transaction.
   </para>
  </refsect2>
 </refsect1>

 <refsect1 id="R1-SQL-ABORT-2">
  <title>
   Usage
  </title>
  <para>
   To abort all changes:
   <programlisting>
ABORT WORK;
   </programlisting>
  </para>

 </refsect1>

 <refsect1 id="R1-SQL-ABORT-3">
  <title>
   Compatibility
  </title>

  <refsect2 id="R2-SQL-ABORT-4">
   <refsect2info>
    <date>1998-09-27</date>
   </refsect2info>
   <title>
    SQL92
   </title>
   <para>
    This command is a <productname>Postgres</productname> extension present
    for historical reasons. <command>ROLLBACK</command> is the <acronym>SQL92</acronym>
    equivalent command.
   </para>
  </refsect2>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:nil
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:
-->