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_cursor_open_with_paramlist
.\" Author: The PostgreSQL Global Development Group
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 2013-02-04
.\" Manual: PostgreSQL 9.1.8 Documentation
.\" Source: PostgreSQL 9.1.8
.\" Language: English
.\"
.TH "SPI_CURSOR_OPEN_WITH_PARAMLIST" "3" "2013-02-04" "PostgreSQL 9.1.8" "PostgreSQL 9.1.8 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_cursor_open_with_paramlist \- set up a cursor using parameters
.\" SPI_cursor_open_with_paramlist
.SH "SYNOPSIS"
.sp
.nf
Portal SPI_cursor_open_with_paramlist(const char *\fIname\fR,
SPIPlanPtr \fIplan\fR,
ParamListInfo \fIparams\fR,
bool \fIread_only\fR)
.fi
.SH "DESCRIPTION"
.PP
\fBSPI_cursor_open_with_paramlist\fR
sets up a cursor (internally, a portal) that will execute a plan prepared by
\fBSPI_prepare\fR\&. This function is equivalent to
\fBSPI_cursor_open\fR
except that information about the parameter values to be passed to the query is presented differently\&. The
ParamListInfo
representation can be convenient for passing down values that are already available in that format\&. It also supports use of dynamic parameter sets via hook functions specified in
ParamListInfo\&.
.PP
The passed\-in parameter data will be copied into the cursor\*(Aqs portal, so it can be freed while the cursor still exists\&.
.SH "ARGUMENTS"
.PP
const char * \fIname\fR
.RS 4
name for portal, or
NULL
to let the system select a name
.RE
.PP
SPIPlanPtr \fIplan\fR
.RS 4
execution plan (returned by
\fBSPI_prepare\fR)
.RE
.PP
ParamListInfo \fIparams\fR
.RS 4
data structure containing parameter types and values; NULL if none
.RE
.PP
bool \fIread_only\fR
.RS 4
true
for read\-only execution
.RE
.SH "RETURN VALUE"
.PP
Pointer to portal containing the cursor\&. Note there is no error return convention; any error will be reported via
\fBelog\fR\&.
|