summaryrefslogtreecommitdiffstats
path: root/doc/src/sgml/man7/ABORT.7
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src/sgml/man7/ABORT.7')
-rw-r--r--doc/src/sgml/man7/ABORT.790
1 files changed, 90 insertions, 0 deletions
diff --git a/doc/src/sgml/man7/ABORT.7 b/doc/src/sgml/man7/ABORT.7
new file mode 100644
index 0000000..02b4299
--- /dev/null
+++ b/doc/src/sgml/man7/ABORT.7
@@ -0,0 +1,90 @@
+'\" t
+.\" Title: ABORT
+.\" Author: The PostgreSQL Global Development Group
+.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
+.\" Date: 2023
+.\" Manual: PostgreSQL 15.5 Documentation
+.\" Source: PostgreSQL 15.5
+.\" Language: English
+.\"
+.TH "ABORT" "7" "2023" "PostgreSQL 15.5" "PostgreSQL 15.5 Documentation"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+ABORT \- abort the current transaction
+.SH "SYNOPSIS"
+.sp
+.nf
+ABORT [ WORK | TRANSACTION ] [ AND [ NO ] CHAIN ]
+.fi
+.SH "DESCRIPTION"
+.PP
+\fBABORT\fR
+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
+SQL
+command
+\fBROLLBACK\fR, and is present only for historical reasons\&.
+.SH "PARAMETERS"
+.PP
+WORK
+.br
+TRANSACTION
+.RS 4
+Optional key words\&. They have no effect\&.
+.RE
+.PP
+AND CHAIN
+.RS 4
+If
+AND CHAIN
+is specified, a new transaction is immediately started with the same transaction characteristics (see
+\fBSET TRANSACTION\fR) as the just finished one\&. Otherwise, no new transaction is started\&.
+.RE
+.SH "NOTES"
+.PP
+Use
+\fBCOMMIT\fR
+to successfully terminate a transaction\&.
+.PP
+Issuing
+\fBABORT\fR
+outside of a transaction block emits a warning and otherwise has no effect\&.
+.SH "EXAMPLES"
+.PP
+To abort all changes:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+ABORT;
+.fi
+.if n \{\
+.RE
+.\}
+.SH "COMPATIBILITY"
+.PP
+This command is a
+PostgreSQL
+extension present for historical reasons\&.
+\fBROLLBACK\fR
+is the equivalent standard SQL command\&.
+.SH "SEE ALSO"
+\fBBEGIN\fR(7), \fBCOMMIT\fR(7), \fBROLLBACK\fR(7)