1
0
mirror of https://github.com/postgres/postgres.git synced 2025-12-19 17:02:53 +03:00
Files
postgres/doc/src/sgml/ref/abort.sgml
Peter Eisentraut bb4eefe7bf doc: Improve DocBook XML validity
DocBook XML is superficially compatible with DocBook SGML but has a
slightly stricter DTD that we have been violating in a few cases.
Although XSLT doesn't care whether the document is valid, the style
sheets don't necessarily process invalid documents correctly, so we need
to work toward fixing this.

This first commit moves the indexterms in refentry elements to an
allowed position.  It has no impact on the output.
2014-02-23 21:31:08 -05:00

101 lines
2.1 KiB
Plaintext

<!--
doc/src/sgml/ref/abort.sgml
PostgreSQL documentation
-->
<refentry id="SQL-ABORT">
<indexterm zone="sql-abort">
<primary>ABORT</primary>
</indexterm>
<refmeta>
<refentrytitle>ABORT</refentrytitle>
<manvolnum>7</manvolnum>
<refmiscinfo>SQL - Language Statements</refmiscinfo>
</refmeta>
<refnamediv>
<refname>ABORT</refname>
<refpurpose>abort the current transaction</refpurpose>
</refnamediv>
<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">,
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"> to
successfully terminate a transaction.
</para>
<para>
Issuing <command>ABORT</> outside of a transaction block
emits a warning and otherwise has no effect.
</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"></member>
<member><xref linkend="sql-commit"></member>
<member><xref linkend="sql-rollback"></member>
</simplelist>
</refsect1>
</refentry>