summaryrefslogtreecommitdiffstats
path: root/doc/src/sgml/man3/SPI_rollback.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src/sgml/man3/SPI_rollback.3')
-rw-r--r--doc/src/sgml/man3/SPI_rollback.352
1 files changed, 52 insertions, 0 deletions
diff --git a/doc/src/sgml/man3/SPI_rollback.3 b/doc/src/sgml/man3/SPI_rollback.3
new file mode 100644
index 0000000..a895038
--- /dev/null
+++ b/doc/src/sgml/man3/SPI_rollback.3
@@ -0,0 +1,52 @@
+'\" t
+.\" Title: SPI_rollback
+.\" Author: The PostgreSQL Global Development Group
+.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
+.\" Date: 2023
+.\" Manual: PostgreSQL 15.4 Documentation
+.\" Source: PostgreSQL 15.4
+.\" Language: English
+.\"
+.TH "SPI_ROLLBACK" "3" "2023" "PostgreSQL 15.4" "PostgreSQL 15.4 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"
+SPI_rollback, SPI_rollback_and_chain \- abort the current transaction
+.SH "SYNOPSIS"
+.sp
+.nf
+void SPI_rollback(void)
+.fi
+.sp
+.nf
+void SPI_rollback_and_chain(void)
+.fi
+.SH "DESCRIPTION"
+.PP
+\fBSPI_rollback\fR
+rolls back the current transaction\&. It is approximately equivalent to running the SQL command
+\fBROLLBACK\fR\&. After the transaction is rolled back, a new transaction is automatically started using default transaction characteristics, so that the caller can continue using SPI facilities\&.
+.PP
+\fBSPI_rollback_and_chain\fR
+is the same, but the new transaction is started with the same transaction characteristics as the just finished one, like with the SQL command
+\fBROLLBACK AND CHAIN\fR\&.
+.PP
+These functions can only be executed if the SPI connection has been set as nonatomic in the call to
+\fBSPI_connect_ext\fR\&.