← 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-prepare-cursor.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-prepare-cursor.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_prepare_cursor</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_prepare"
 
19
HREF="spi-spi-prepare.html"><LINK
 
20
REL="NEXT"
 
21
TITLE="SPI_prepare_params"
 
22
HREF="spi-spi-prepare-params.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_prepare"
 
57
HREF="spi-spi-prepare.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_prepare"
 
67
HREF="spi-spi-prepare.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_prepare_params"
 
81
HREF="spi-spi-prepare-params.html"
 
82
>Fast Forward</A
 
83
></TD
 
84
><TD
 
85
WIDTH="10%"
 
86
ALIGN="right"
 
87
VALIGN="top"
 
88
><A
 
89
TITLE="SPI_prepare_params"
 
90
HREF="spi-spi-prepare-params.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-PREPARE-CURSOR"
 
102
></A
 
103
>SPI_prepare_cursor</H1
 
104
><DIV
 
105
CLASS="REFNAMEDIV"
 
106
><A
 
107
NAME="AEN57497"
 
108
></A
 
109
><H2
 
110
>Name</H2
 
111
>SPI_prepare_cursor&nbsp;--&nbsp;prepare a plan for a command, without executing it yet</DIV
 
112
><DIV
 
113
CLASS="REFSYNOPSISDIV"
 
114
><A
 
115
NAME="AEN57502"
 
116
></A
 
117
><H2
 
118
>Synopsis</H2
 
119
><PRE
 
120
CLASS="SYNOPSIS"
 
121
>SPIPlanPtr SPI_prepare_cursor(const char * <TT
 
122
CLASS="PARAMETER"
 
123
>command</TT
 
124
>, int <TT
 
125
CLASS="PARAMETER"
 
126
>nargs</TT
 
127
>,
 
128
                              Oid * <TT
 
129
CLASS="PARAMETER"
 
130
>argtypes</TT
 
131
>, int <TT
 
132
CLASS="PARAMETER"
 
133
>cursorOptions</TT
 
134
>)</PRE
 
135
></DIV
 
136
><DIV
 
137
CLASS="REFSECT1"
 
138
><A
 
139
NAME="AEN57508"
 
140
></A
 
141
><H2
 
142
>Description</H2
 
143
><P
 
144
>   <CODE
 
145
CLASS="FUNCTION"
 
146
>SPI_prepare_cursor</CODE
 
147
> is identical to
 
148
   <CODE
 
149
CLASS="FUNCTION"
 
150
>SPI_prepare</CODE
 
151
>, except that it also allows specification
 
152
   of the planner's <SPAN
 
153
CLASS="QUOTE"
 
154
>"cursor options"</SPAN
 
155
> parameter.  This is a bit mask
 
156
   having the values shown in <TT
 
157
CLASS="FILENAME"
 
158
>nodes/parsenodes.h</TT
 
159
>
 
160
   for the <TT
 
161
CLASS="STRUCTFIELD"
 
162
>options</TT
 
163
> field of <TT
 
164
CLASS="STRUCTNAME"
 
165
>DeclareCursorStmt</TT
 
166
>.
 
167
   <CODE
 
168
CLASS="FUNCTION"
 
169
>SPI_prepare</CODE
 
170
> always takes the cursor options as zero.
 
171
  </P
 
172
></DIV
 
173
><DIV
 
174
CLASS="REFSECT1"
 
175
><A
 
176
NAME="AEN57518"
 
177
></A
 
178
><H2
 
179
>Arguments</H2
 
180
><P
 
181
></P
 
182
><DIV
 
183
CLASS="VARIABLELIST"
 
184
><DL
 
185
><DT
 
186
><TT
 
187
CLASS="LITERAL"
 
188
>const char * <TT
 
189
CLASS="PARAMETER"
 
190
>command</TT
 
191
></TT
 
192
></DT
 
193
><DD
 
194
><P
 
195
>      command string
 
196
     </P
 
197
></DD
 
198
><DT
 
199
><TT
 
200
CLASS="LITERAL"
 
201
>int <TT
 
202
CLASS="PARAMETER"
 
203
>nargs</TT
 
204
></TT
 
205
></DT
 
206
><DD
 
207
><P
 
208
>      number of input parameters (<TT
 
209
CLASS="LITERAL"
 
210
>$1</TT
 
211
>, <TT
 
212
CLASS="LITERAL"
 
213
>$2</TT
 
214
>, etc.)
 
215
     </P
 
216
></DD
 
217
><DT
 
218
><TT
 
219
CLASS="LITERAL"
 
220
>Oid * <TT
 
221
CLASS="PARAMETER"
 
222
>argtypes</TT
 
223
></TT
 
224
></DT
 
225
><DD
 
226
><P
 
227
>      pointer to an array containing the <ACRONYM
 
228
CLASS="ACRONYM"
 
229
>OID</ACRONYM
 
230
>s of
 
231
      the data types of the parameters
 
232
     </P
 
233
></DD
 
234
><DT
 
235
><TT
 
236
CLASS="LITERAL"
 
237
>int <TT
 
238
CLASS="PARAMETER"
 
239
>cursorOptions</TT
 
240
></TT
 
241
></DT
 
242
><DD
 
243
><P
 
244
>      integer bit mask of cursor options; zero produces default behavior
 
245
     </P
 
246
></DD
 
247
></DL
 
248
></DIV
 
249
></DIV
 
250
><DIV
 
251
CLASS="REFSECT1"
 
252
><A
 
253
NAME="AEN57548"
 
254
></A
 
255
><H2
 
256
>Return Value</H2
 
257
><P
 
258
>   <CODE
 
259
CLASS="FUNCTION"
 
260
>SPI_prepare_cursor</CODE
 
261
> has the same return conventions as
 
262
   <CODE
 
263
CLASS="FUNCTION"
 
264
>SPI_prepare</CODE
 
265
>.
 
266
  </P
 
267
></DIV
 
268
><DIV
 
269
CLASS="REFSECT1"
 
270
><A
 
271
NAME="AEN57553"
 
272
></A
 
273
><H2
 
274
>Notes</H2
 
275
><P
 
276
>   Useful bits to set in <TT
 
277
CLASS="PARAMETER"
 
278
>cursorOptions</TT
 
279
> include
 
280
   <TT
 
281
CLASS="SYMBOL"
 
282
>CURSOR_OPT_SCROLL</TT
 
283
>,
 
284
   <TT
 
285
CLASS="SYMBOL"
 
286
>CURSOR_OPT_NO_SCROLL</TT
 
287
>, and
 
288
   <TT
 
289
CLASS="SYMBOL"
 
290
>CURSOR_OPT_FAST_PLAN</TT
 
291
>.  Note in particular that
 
292
   <TT
 
293
CLASS="SYMBOL"
 
294
>CURSOR_OPT_HOLD</TT
 
295
> is ignored.
 
296
  </P
 
297
></DIV
 
298
><DIV
 
299
CLASS="NAVFOOTER"
 
300
><HR
 
301
ALIGN="LEFT"
 
302
WIDTH="100%"><TABLE
 
303
SUMMARY="Footer navigation table"
 
304
WIDTH="100%"
 
305
BORDER="0"
 
306
CELLPADDING="0"
 
307
CELLSPACING="0"
 
308
><TR
 
309
><TD
 
310
WIDTH="33%"
 
311
ALIGN="left"
 
312
VALIGN="top"
 
313
><A
 
314
HREF="spi-spi-prepare.html"
 
315
ACCESSKEY="P"
 
316
>Prev</A
 
317
></TD
 
318
><TD
 
319
WIDTH="34%"
 
320
ALIGN="center"
 
321
VALIGN="top"
 
322
><A
 
323
HREF="index.html"
 
324
ACCESSKEY="H"
 
325
>Home</A
 
326
></TD
 
327
><TD
 
328
WIDTH="33%"
 
329
ALIGN="right"
 
330
VALIGN="top"
 
331
><A
 
332
HREF="spi-spi-prepare-params.html"
 
333
ACCESSKEY="N"
 
334
>Next</A
 
335
></TD
 
336
></TR
 
337
><TR
 
338
><TD
 
339
WIDTH="33%"
 
340
ALIGN="left"
 
341
VALIGN="top"
 
342
>SPI_prepare</TD
 
343
><TD
 
344
WIDTH="34%"
 
345
ALIGN="center"
 
346
VALIGN="top"
 
347
><A
 
348
HREF="spi-interface.html"
 
349
ACCESSKEY="U"
 
350
>Up</A
 
351
></TD
 
352
><TD
 
353
WIDTH="33%"
 
354
ALIGN="right"
 
355
VALIGN="top"
 
356
>SPI_prepare_params</TD
 
357
></TR
 
358
></TABLE
 
359
></DIV
 
360
></BODY
 
361
></HTML
 
362
>
 
 
b'\\ No newline at end of file'