mirror of
https://github.com/postgres/postgres.git
synced 2025-08-28 18:48:04 +03:00
9081bddbd7
SQL commands are generally marked up as <command>, except when a link to a reference page is used using <xref>. But the latter doesn't create monospace markup, so this looks strange especially when a paragraph contains a mix of links and non-links. We considered putting <command> in the <refentrytitle> on the target side, but that creates some formatting side effects elsewhere. Generally, it seems safer to solve this on the link source side. We can't put the <xref> inside the <command>; the DTD doesn't allow this. DocBook 5 would allow the <command> to have the linkend attribute itself, but we are not there yet. So to solve this for now, convert the <xref>s to <link> plus <command>. This gives the correct look and also gives some more flexibility what we can put into the link text (e.g., subcommands or other clauses). In the future, these could then be converted to DocBook 5 style. I haven't converted absolutely all xrefs to SQL command reference pages, only those where we care about the appearance of the link text or where it was otherwise appropriate to make the appearance match a bit better. Also in some cases, the links where repetitive, so in those cases the links where just removed and replaced by a plain <command>. In cases where we just want the link and don't specifically care about the generated link text (typically phrased "for further information see <xref ...>") the xref is kept. Reported-by: Dagfinn Ilmari Mannsåker <ilmari@ilmari.org> Discussion: https://www.postgresql.org/message-id/flat/87o8pco34z.fsf@wibble.ilmari.org
113 lines
2.6 KiB
Plaintext
113 lines
2.6 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 ] [ AND [ NO ] CHAIN ]
|
|
</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
|
|
<link linkend="sql-rollback"><command>ROLLBACK</command></link>,
|
|
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>
|
|
|
|
<varlistentry>
|
|
<term><literal>AND CHAIN</literal></term>
|
|
<listitem>
|
|
<para>
|
|
If <literal>AND CHAIN</literal> is specified, a new transaction is
|
|
immediately started with the same transaction characteristics (see <link
|
|
linkend="sql-set-transaction"><command>SET TRANSACTION</command></link>) as the just finished one. Otherwise,
|
|
no new transaction is started.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Notes</title>
|
|
|
|
<para>
|
|
Use <link linkend="sql-commit"><command>COMMIT</command></link> to
|
|
successfully terminate a transaction.
|
|
</para>
|
|
|
|
<para>
|
|
Issuing <command>ABORT</command> 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>
|