diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-04 12:17:33 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-04 12:17:33 +0000 |
commit | 5e45211a64149b3c659b90ff2de6fa982a5a93ed (patch) | |
tree | 739caf8c461053357daa9f162bef34516c7bf452 /doc/src/sgml/ref/abort.sgml | |
parent | Initial commit. (diff) | |
download | postgresql-15-5e45211a64149b3c659b90ff2de6fa982a5a93ed.tar.xz postgresql-15-5e45211a64149b3c659b90ff2de6fa982a5a93ed.zip |
Adding upstream version 15.5.upstream/15.5
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/src/sgml/ref/abort.sgml')
-rw-r--r-- | doc/src/sgml/ref/abort.sgml | 112 |
1 files changed, 112 insertions, 0 deletions
diff --git a/doc/src/sgml/ref/abort.sgml b/doc/src/sgml/ref/abort.sgml new file mode 100644 index 0000000..16b5602 --- /dev/null +++ b/doc/src/sgml/ref/abort.sgml @@ -0,0 +1,112 @@ +<!-- +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> |