blob: 6db577f9bbb3bf9d8ab1ca75d6d66e82f05393aa (
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
|
'\" t
.\" Title: SPI_connect
.\" 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_CONNECT" "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_connect, SPI_connect_ext \- connect a C function to the SPI manager
.SH "SYNOPSIS"
.sp
.nf
int SPI_connect(void)
.fi
.sp
.nf
int SPI_connect_ext(int \fIoptions\fR)
.fi
.SH "DESCRIPTION"
.PP
\fBSPI_connect\fR
opens a connection from a C function invocation to the SPI manager\&. You must call this function if you want to execute commands through SPI\&. Some utility SPI functions can be called from unconnected C functions\&.
.PP
\fBSPI_connect_ext\fR
does the same but has an argument that allows passing option flags\&. Currently, the following option values are available:
.PP
SPI_OPT_NONATOMIC
.RS 4
Sets the SPI connection to be
nonatomic, which means that transaction control calls (\fBSPI_commit\fR,
\fBSPI_rollback\fR) are allowed\&. Otherwise, calling those functions will result in an immediate error\&.
.RE
.PP
SPI_connect()
is equivalent to
SPI_connect_ext(0)\&.
.SH "RETURN VALUE"
.PP
SPI_OK_CONNECT
.RS 4
on success
.RE
.PP
SPI_ERROR_CONNECT
.RS 4
on error
.RE
|
