postgresql/doc/src/sgml/ref/commit.sgml

<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/commit.sgml,v 1.16 2003/08/31 17:32:21 petere Exp $
PostgreSQL documentation
-->

<refentry id="SQL-COMMIT">
 <refmeta>
  <refentrytitle id="SQL-COMMIT-TITLE">COMMIT</refentrytitle>
  <refmiscinfo>SQL - Language Statements</refmiscinfo>
 </refmeta>

 <refnamediv>
  <refname>COMMIT</refname>
  <refpurpose>commit the current transaction</refpurpose>
 </refnamediv>  
  
 <indexterm zone="sql-commit">
  <primary>COMMIT</primary>
 </indexterm>

 <refsynopsisdiv>
<synopsis>
COMMIT [ WORK | TRANSACTION ]
</synopsis>
 </refsynopsisdiv>
  
 <refsect1>
  <title>Description</title>

  <para>
   <command>COMMIT</command> commits the current transaction. All
   changes made by the transaction become visible to others
   and are guaranteed to be durable if a crash occurs.
  </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>Diagnostics</title>

  <variablelist>
   <varlistentry>
    <term><computeroutput>COMMIT</computeroutput></term>
    <listitem>
     <para>
      Message returned if the transaction was successfully committed.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term><computeroutput>WARNING:  COMMIT: no transaction in progress</computeroutput></term>
    <listitem>
     <para>
      Message if there is no transaction in progress.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1>
  <title>Notes</title>

  <para>
   Use <xref linkend="SQL-ROLLBACK" endterm="SQL-ROLLBACK-TITLE"> to
   abort a transaction.
  </para>
 </refsect1>

 <refsect1>
  <title>Examples</title>

  <para>
   To commit the current transaction and make all changes permanent:
<programlisting>
COMMIT;
</programlisting>
  </para>
 </refsect1>
 
 <refsect1>
  <title>Compatibility</title>
  
  <para>
   The SQL standard only specifies the two forms
   <literal>COMMIT</literal> and <literal>COMMIT
   WORK</literal>. Otherwise, this command is fully conforming.
  </para>
 </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:
-->