← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/postgresql-9.1/oneiric-security

« back to all changes in this revision

Viewing changes to doc/src/sgml/html/spi-spi-execute-plan.html

  • Committer: Bazaar Package Importer
  • Author(s): Martin Pitt
  • Date: 2011-05-11 10:41:53 UTC
  • Revision ID: james.westby@ubuntu.com-20110511104153-psbh2o58553fv1m0
Tags: upstream-9.1~beta1
Import upstream version 9.1~beta1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/src/sgml/html/spi-spi-execute-plan.html
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 
2
<HTML
 
3
><HEAD
 
4
><TITLE
 
5
>SPI_execute_plan</TITLE
 
6
><META
 
7
NAME="GENERATOR"
 
8
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
 
9
REV="MADE"
 
10
HREF="mailto:pgsql-docs@postgresql.org"><LINK
 
11
REL="HOME"
 
12
TITLE="PostgreSQL 9.1beta1 Documentation"
 
13
HREF="index.html"><LINK
 
14
REL="UP"
 
15
TITLE="Interface Functions"
 
16
HREF="spi-interface.html"><LINK
 
17
REL="PREVIOUS"
 
18
TITLE="SPI_is_cursor_plan"
 
19
HREF="spi-spi-is-cursor-plan.html"><LINK
 
20
REL="NEXT"
 
21
TITLE="SPI_execute_plan_with_paramlist"
 
22
HREF="spi-spi-execute-plan-with-paramlist.html"><LINK
 
23
REL="STYLESHEET"
 
24
TYPE="text/css"
 
25
HREF="stylesheet.css"><META
 
26
HTTP-EQUIV="Content-Type"
 
27
CONTENT="text/html; charset=ISO-8859-1"><META
 
28
NAME="creation"
 
29
CONTENT="2011-04-27T21:20:33"></HEAD
 
30
><BODY
 
31
CLASS="REFENTRY"
 
32
><DIV
 
33
CLASS="NAVHEADER"
 
34
><TABLE
 
35
SUMMARY="Header navigation table"
 
36
WIDTH="100%"
 
37
BORDER="0"
 
38
CELLPADDING="0"
 
39
CELLSPACING="0"
 
40
><TR
 
41
><TH
 
42
COLSPAN="5"
 
43
ALIGN="center"
 
44
VALIGN="bottom"
 
45
><A
 
46
HREF="index.html"
 
47
>PostgreSQL 9.1beta1 Documentation</A
 
48
></TH
 
49
></TR
 
50
><TR
 
51
><TD
 
52
WIDTH="10%"
 
53
ALIGN="left"
 
54
VALIGN="top"
 
55
><A
 
56
TITLE="SPI_is_cursor_plan"
 
57
HREF="spi-spi-is-cursor-plan.html"
 
58
ACCESSKEY="P"
 
59
>Prev</A
 
60
></TD
 
61
><TD
 
62
WIDTH="10%"
 
63
ALIGN="left"
 
64
VALIGN="top"
 
65
><A
 
66
TITLE="SPI_is_cursor_plan"
 
67
HREF="spi-spi-is-cursor-plan.html"
 
68
>Fast Backward</A
 
69
></TD
 
70
><TD
 
71
WIDTH="60%"
 
72
ALIGN="center"
 
73
VALIGN="bottom"
 
74
></TD
 
75
><TD
 
76
WIDTH="10%"
 
77
ALIGN="right"
 
78
VALIGN="top"
 
79
><A
 
80
TITLE="SPI_execute_plan_with_paramlist"
 
81
HREF="spi-spi-execute-plan-with-paramlist.html"
 
82
>Fast Forward</A
 
83
></TD
 
84
><TD
 
85
WIDTH="10%"
 
86
ALIGN="right"
 
87
VALIGN="top"
 
88
><A
 
89
TITLE="SPI_execute_plan_with_paramlist"
 
90
HREF="spi-spi-execute-plan-with-paramlist.html"
 
91
ACCESSKEY="N"
 
92
>Next</A
 
93
></TD
 
94
></TR
 
95
></TABLE
 
96
><HR
 
97
ALIGN="LEFT"
 
98
WIDTH="100%"></DIV
 
99
><H1
 
100
><A
 
101
NAME="SPI-SPI-EXECUTE-PLAN"
 
102
></A
 
103
>SPI_execute_plan</H1
 
104
><DIV
 
105
CLASS="REFNAMEDIV"
 
106
><A
 
107
NAME="AEN57749"
 
108
></A
 
109
><H2
 
110
>Name</H2
 
111
>SPI_execute_plan&nbsp;--&nbsp;execute a plan prepared by <CODE
 
112
CLASS="FUNCTION"
 
113
>SPI_prepare</CODE
 
114
></DIV
 
115
><DIV
 
116
CLASS="REFSYNOPSISDIV"
 
117
><A
 
118
NAME="AEN57755"
 
119
></A
 
120
><H2
 
121
>Synopsis</H2
 
122
><PRE
 
123
CLASS="SYNOPSIS"
 
124
>int SPI_execute_plan(SPIPlanPtr <TT
 
125
CLASS="PARAMETER"
 
126
>plan</TT
 
127
>, Datum * <TT
 
128
CLASS="PARAMETER"
 
129
>values</TT
 
130
>, const char * <TT
 
131
CLASS="PARAMETER"
 
132
>nulls</TT
 
133
>,
 
134
                     bool <TT
 
135
CLASS="PARAMETER"
 
136
>read_only</TT
 
137
>, long <TT
 
138
CLASS="PARAMETER"
 
139
>count</TT
 
140
>)</PRE
 
141
></DIV
 
142
><DIV
 
143
CLASS="REFSECT1"
 
144
><A
 
145
NAME="AEN57762"
 
146
></A
 
147
><H2
 
148
>Description</H2
 
149
><P
 
150
>   <CODE
 
151
CLASS="FUNCTION"
 
152
>SPI_execute_plan</CODE
 
153
> executes a plan prepared by
 
154
   <CODE
 
155
CLASS="FUNCTION"
 
156
>SPI_prepare</CODE
 
157
>.  <TT
 
158
CLASS="PARAMETER"
 
159
>read_only</TT
 
160
> and
 
161
   <TT
 
162
CLASS="PARAMETER"
 
163
>count</TT
 
164
> have the same interpretation as in
 
165
   <CODE
 
166
CLASS="FUNCTION"
 
167
>SPI_execute</CODE
 
168
>.
 
169
  </P
 
170
></DIV
 
171
><DIV
 
172
CLASS="REFSECT1"
 
173
><A
 
174
NAME="AEN57770"
 
175
></A
 
176
><H2
 
177
>Arguments</H2
 
178
><P
 
179
></P
 
180
><DIV
 
181
CLASS="VARIABLELIST"
 
182
><DL
 
183
><DT
 
184
><TT
 
185
CLASS="LITERAL"
 
186
>SPIPlanPtr <TT
 
187
CLASS="PARAMETER"
 
188
>plan</TT
 
189
></TT
 
190
></DT
 
191
><DD
 
192
><P
 
193
>      execution plan (returned by <CODE
 
194
CLASS="FUNCTION"
 
195
>SPI_prepare</CODE
 
196
>)
 
197
     </P
 
198
></DD
 
199
><DT
 
200
><TT
 
201
CLASS="LITERAL"
 
202
>Datum * <TT
 
203
CLASS="PARAMETER"
 
204
>values</TT
 
205
></TT
 
206
></DT
 
207
><DD
 
208
><P
 
209
>      An array of actual parameter values.  Must have same length as the
 
210
      plan's number of arguments.
 
211
     </P
 
212
></DD
 
213
><DT
 
214
><TT
 
215
CLASS="LITERAL"
 
216
>const char * <TT
 
217
CLASS="PARAMETER"
 
218
>nulls</TT
 
219
></TT
 
220
></DT
 
221
><DD
 
222
><P
 
223
>      An array describing which parameters are null.  Must have same length as
 
224
      the plan's number of arguments.
 
225
      <TT
 
226
CLASS="LITERAL"
 
227
>n</TT
 
228
> indicates a null value (entry in
 
229
      <TT
 
230
CLASS="PARAMETER"
 
231
>values</TT
 
232
> will be ignored); a space indicates a
 
233
      nonnull value (entry in <TT
 
234
CLASS="PARAMETER"
 
235
>values</TT
 
236
> is valid).
 
237
     </P
 
238
><P
 
239
>      If <TT
 
240
CLASS="PARAMETER"
 
241
>nulls</TT
 
242
> is <TT
 
243
CLASS="SYMBOL"
 
244
>NULL</TT
 
245
> then
 
246
      <CODE
 
247
CLASS="FUNCTION"
 
248
>SPI_execute_plan</CODE
 
249
> assumes that no parameters are
 
250
      null.
 
251
     </P
 
252
></DD
 
253
><DT
 
254
><TT
 
255
CLASS="LITERAL"
 
256
>bool <TT
 
257
CLASS="PARAMETER"
 
258
>read_only</TT
 
259
></TT
 
260
></DT
 
261
><DD
 
262
><P
 
263
>      <TT
 
264
CLASS="LITERAL"
 
265
>true</TT
 
266
> for read-only execution
 
267
     </P
 
268
></DD
 
269
><DT
 
270
><TT
 
271
CLASS="LITERAL"
 
272
>long <TT
 
273
CLASS="PARAMETER"
 
274
>count</TT
 
275
></TT
 
276
></DT
 
277
><DD
 
278
><P
 
279
>      maximum number of rows to process or return
 
280
     </P
 
281
></DD
 
282
></DL
 
283
></DIV
 
284
></DIV
 
285
><DIV
 
286
CLASS="REFSECT1"
 
287
><A
 
288
NAME="AEN57812"
 
289
></A
 
290
><H2
 
291
>Return Value</H2
 
292
><P
 
293
>   The return value is the same as for <CODE
 
294
CLASS="FUNCTION"
 
295
>SPI_execute</CODE
 
296
>,
 
297
   with the following additional possible error (negative) results:
 
298
 
 
299
   <P
 
300
></P
 
301
></P><DIV
 
302
CLASS="VARIABLELIST"
 
303
><DL
 
304
><DT
 
305
><TT
 
306
CLASS="SYMBOL"
 
307
>SPI_ERROR_ARGUMENT</TT
 
308
></DT
 
309
><DD
 
310
><P
 
311
>       if <TT
 
312
CLASS="PARAMETER"
 
313
>plan</TT
 
314
> is <TT
 
315
CLASS="SYMBOL"
 
316
>NULL</TT
 
317
> or invalid,
 
318
       or <TT
 
319
CLASS="PARAMETER"
 
320
>count</TT
 
321
> is less than 0
 
322
      </P
 
323
></DD
 
324
><DT
 
325
><TT
 
326
CLASS="SYMBOL"
 
327
>SPI_ERROR_PARAM</TT
 
328
></DT
 
329
><DD
 
330
><P
 
331
>       if <TT
 
332
CLASS="PARAMETER"
 
333
>values</TT
 
334
> is <TT
 
335
CLASS="SYMBOL"
 
336
>NULL</TT
 
337
> and
 
338
       <TT
 
339
CLASS="PARAMETER"
 
340
>plan</TT
 
341
> was prepared with some parameters
 
342
      </P
 
343
></DD
 
344
></DL
 
345
></DIV
 
346
><P>
 
347
  </P
 
348
><P
 
349
>   <TT
 
350
CLASS="VARNAME"
 
351
>SPI_processed</TT
 
352
> and
 
353
   <TT
 
354
CLASS="VARNAME"
 
355
>SPI_tuptable</TT
 
356
> are set as in
 
357
   <CODE
 
358
CLASS="FUNCTION"
 
359
>SPI_execute</CODE
 
360
> if successful.
 
361
  </P
 
362
></DIV
 
363
><DIV
 
364
CLASS="NAVFOOTER"
 
365
><HR
 
366
ALIGN="LEFT"
 
367
WIDTH="100%"><TABLE
 
368
SUMMARY="Footer navigation table"
 
369
WIDTH="100%"
 
370
BORDER="0"
 
371
CELLPADDING="0"
 
372
CELLSPACING="0"
 
373
><TR
 
374
><TD
 
375
WIDTH="33%"
 
376
ALIGN="left"
 
377
VALIGN="top"
 
378
><A
 
379
HREF="spi-spi-is-cursor-plan.html"
 
380
ACCESSKEY="P"
 
381
>Prev</A
 
382
></TD
 
383
><TD
 
384
WIDTH="34%"
 
385
ALIGN="center"
 
386
VALIGN="top"
 
387
><A
 
388
HREF="index.html"
 
389
ACCESSKEY="H"
 
390
>Home</A
 
391
></TD
 
392
><TD
 
393
WIDTH="33%"
 
394
ALIGN="right"
 
395
VALIGN="top"
 
396
><A
 
397
HREF="spi-spi-execute-plan-with-paramlist.html"
 
398
ACCESSKEY="N"
 
399
>Next</A
 
400
></TD
 
401
></TR
 
402
><TR
 
403
><TD
 
404
WIDTH="33%"
 
405
ALIGN="left"
 
406
VALIGN="top"
 
407
>SPI_is_cursor_plan</TD
 
408
><TD
 
409
WIDTH="34%"
 
410
ALIGN="center"
 
411
VALIGN="top"
 
412
><A
 
413
HREF="spi-interface.html"
 
414
ACCESSKEY="U"
 
415
>Up</A
 
416
></TD
 
417
><TD
 
418
WIDTH="33%"
 
419
ALIGN="right"
 
420
VALIGN="top"
 
421
>SPI_execute_plan_with_paramlist</TD
 
422
></TR
 
423
></TABLE
 
424
></DIV
 
425
></BODY
 
426
></HTML
 
427
>
 
 
b'\\ No newline at end of file'