blob: a8950388e8c368e491423802031a2ef9ab5e2cb1 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
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\&.
|
