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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>SPI_cursor_open_with_paramlist</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REV="MADE"
HREF="mailto:pgsql-docs@postgresql.org"><LINK
REL="HOME"
TITLE="PostgreSQL 9.1.15 Documentation"
HREF="index.html"><LINK
REL="UP"
TITLE="Interface Functions"
HREF="spi-interface.html"><LINK
REL="PREVIOUS"
TITLE="SPI_cursor_open_with_args"
HREF="spi-spi-cursor-open-with-args.html"><LINK
REL="NEXT"
TITLE="SPI_cursor_find"
HREF="spi-spi-cursor-find.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
HREF="stylesheet.css"><META
HTTP-EQUIV="Content-Type"
CONTENT="text/html; charset=ISO-8859-1"><META
NAME="creation"
CONTENT="2015-02-02T21:03:01"></HEAD
><BODY
CLASS="REFENTRY"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="5"
ALIGN="center"
VALIGN="bottom"
><A
HREF="index.html"
>PostgreSQL 9.1.15 Documentation</A
></TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
TITLE="SPI_cursor_open_with_args"
HREF="spi-spi-cursor-open-with-args.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
HREF="spi-interface.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="60%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="20%"
ALIGN="right"
VALIGN="top"
><A
TITLE="SPI_cursor_find"
HREF="spi-spi-cursor-find.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SPI-SPI-CURSOR-OPEN-WITH-PARAMLIST"
></A
>SPI_cursor_open_with_paramlist</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN58513"
></A
><H2
>Name</H2
>SPI_cursor_open_with_paramlist -- set up a cursor using parameters</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN58518"
></A
><H2
>Synopsis</H2
><PRE
CLASS="SYNOPSIS"
>Portal SPI_cursor_open_with_paramlist(const char *<TT
CLASS="PARAMETER"
>name</TT
>,
SPIPlanPtr <TT
CLASS="PARAMETER"
>plan</TT
>,
ParamListInfo <TT
CLASS="PARAMETER"
>params</TT
>,
bool <TT
CLASS="PARAMETER"
>read_only</TT
>)</PRE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN58524"
></A
><H2
>Description</H2
><P
> <CODE
CLASS="FUNCTION"
>SPI_cursor_open_with_paramlist</CODE
> sets up a cursor
(internally, a portal) that will execute a plan prepared by
<CODE
CLASS="FUNCTION"
>SPI_prepare</CODE
>.
This function is equivalent to <CODE
CLASS="FUNCTION"
>SPI_cursor_open</CODE
>
except that information about the parameter values to be passed to the
query is presented differently. The <TT
CLASS="LITERAL"
>ParamListInfo</TT
>
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 <TT
CLASS="LITERAL"
>ParamListInfo</TT
>.
</P
><P
> The passed-in parameter data will be copied into the cursor's portal, so it
can be freed while the cursor still exists.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN58533"
></A
><H2
>Arguments</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><TT
CLASS="LITERAL"
>const char * <TT
CLASS="PARAMETER"
>name</TT
></TT
></DT
><DD
><P
> name for portal, or <TT
CLASS="SYMBOL"
>NULL</TT
> to let the system
select a name
</P
></DD
><DT
><TT
CLASS="LITERAL"
>SPIPlanPtr <TT
CLASS="PARAMETER"
>plan</TT
></TT
></DT
><DD
><P
> execution plan (returned by <CODE
CLASS="FUNCTION"
>SPI_prepare</CODE
>)
</P
></DD
><DT
><TT
CLASS="LITERAL"
>ParamListInfo <TT
CLASS="PARAMETER"
>params</TT
></TT
></DT
><DD
><P
> data structure containing parameter types and values; NULL if none
</P
></DD
><DT
><TT
CLASS="LITERAL"
>bool <TT
CLASS="PARAMETER"
>read_only</TT
></TT
></DT
><DD
><P
><TT
CLASS="LITERAL"
>true</TT
> for read-only execution</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN58563"
></A
><H2
>Return Value</H2
><P
> Pointer to portal containing the cursor. Note there is no error
return convention; any error will be reported via <CODE
CLASS="FUNCTION"
>elog</CODE
>.
</P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="spi-spi-cursor-open-with-args.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="spi-spi-cursor-find.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SPI_cursor_open_with_args</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="spi-interface.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>SPI_cursor_find</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
|
