blob: b2928f0850c218f54dc81dace155b84a73dbd714 (
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
70
71
72
73
74
75
76
77
78
79
80
81
82
|
'\" t
.\" Title: SPI_register_relation
.\" Author: The PostgreSQL Global Development Group
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 2024
.\" Manual: PostgreSQL 15.6 Documentation
.\" Source: PostgreSQL 15.6
.\" Language: English
.\"
.TH "SPI_REGISTER_RELATION" "3" "2024" "PostgreSQL 15.6" "PostgreSQL 15.6 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_register_relation \- make an ephemeral named relation available by name in SPI queries
.SH "SYNOPSIS"
.sp
.nf
int SPI_register_relation(EphemeralNamedRelation \fIenr\fR)
.fi
.SH "DESCRIPTION"
.PP
\fBSPI_register_relation\fR
makes an ephemeral named relation, with associated information, available to queries planned and executed through the current SPI connection\&.
.SH "ARGUMENTS"
.PP
EphemeralNamedRelation \fIenr\fR
.RS 4
the ephemeral named relation registry entry
.RE
.SH "RETURN VALUE"
.PP
If the execution of the command was successful then the following (nonnegative) value will be returned:
.PP
SPI_OK_REL_REGISTER
.RS 4
if the relation has been successfully registered by name
.RE
.PP
On error, one of the following negative values is returned:
.PP
SPI_ERROR_ARGUMENT
.RS 4
if
\fIenr\fR
is
NULL
or its
\fIname\fR
field is
NULL
.RE
.PP
SPI_ERROR_UNCONNECTED
.RS 4
if called from an unconnected C function
.RE
.PP
SPI_ERROR_REL_DUPLICATE
.RS 4
if the name specified in the
\fIname\fR
field of
\fIenr\fR
is already registered for this connection
.RE
|
