← Back to branch summary

~ubuntu-branches/debian/sid/postgresql-9.3/sid

« back to all changes in this revision

Viewing changes to doc/src/sgml/html/spi-spi-saveplan.html

  • Committer: Package Import Robot
  • Author(s): Martin Pitt
  • Date: 2013-05-08 05:39:52 UTC
  • Revision ID: package-import@ubuntu.com-20130508053952-1j7uilp7mjtrvq8q
Tags: upstream-9.3~beta1
Import upstream version 9.3~beta1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/src/sgml/html/spi-spi-saveplan.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_saveplan</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.3beta1 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_keepplan"
 
19
HREF="spi-spi-keepplan.html"><LINK
 
20
REL="NEXT"
 
21
TITLE="Interface Support Functions"
 
22
HREF="spi-interface-support.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="2013-05-06T21:00:50"></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.3beta1 Documentation</A
 
48
></TH
 
49
></TR
 
50
><TR
 
51
><TD
 
52
WIDTH="10%"
 
53
ALIGN="left"
 
54
VALIGN="top"
 
55
><A
 
56
TITLE="SPI_keepplan"
 
57
HREF="spi-spi-keepplan.html"
 
58
ACCESSKEY="P"
 
59
>Prev</A
 
60
></TD
 
61
><TD
 
62
WIDTH="10%"
 
63
ALIGN="left"
 
64
VALIGN="top"
 
65
><A
 
66
HREF="spi-interface.html"
 
67
ACCESSKEY="U"
 
68
>Up</A
 
69
></TD
 
70
><TD
 
71
WIDTH="60%"
 
72
ALIGN="center"
 
73
VALIGN="bottom"
 
74
></TD
 
75
><TD
 
76
WIDTH="20%"
 
77
ALIGN="right"
 
78
VALIGN="top"
 
79
><A
 
80
TITLE="Interface Support Functions"
 
81
HREF="spi-interface-support.html"
 
82
ACCESSKEY="N"
 
83
>Next</A
 
84
></TD
 
85
></TR
 
86
></TABLE
 
87
><HR
 
88
ALIGN="LEFT"
 
89
WIDTH="100%"></DIV
 
90
><H1
 
91
><A
 
92
NAME="SPI-SPI-SAVEPLAN"
 
93
></A
 
94
>SPI_saveplan</H1
 
95
><DIV
 
96
CLASS="REFNAMEDIV"
 
97
><A
 
98
NAME="AEN62787"
 
99
></A
 
100
><H2
 
101
>Name</H2
 
102
>SPI_saveplan&nbsp;--&nbsp;save a prepared statement</DIV
 
103
><DIV
 
104
CLASS="REFSYNOPSISDIV"
 
105
><A
 
106
NAME="AEN62792"
 
107
></A
 
108
><H2
 
109
>Synopsis</H2
 
110
><PRE
 
111
CLASS="SYNOPSIS"
 
112
>SPIPlanPtr SPI_saveplan(SPIPlanPtr <TT
 
113
CLASS="PARAMETER"
 
114
>plan</TT
 
115
>)</PRE
 
116
></DIV
 
117
><DIV
 
118
CLASS="REFSECT1"
 
119
><A
 
120
NAME="AEN62795"
 
121
></A
 
122
><H2
 
123
>Description</H2
 
124
><P
 
125
>   <CODE
 
126
CLASS="FUNCTION"
 
127
>SPI_saveplan</CODE
 
128
> copies a passed statement (prepared by
 
129
   <CODE
 
130
CLASS="FUNCTION"
 
131
>SPI_prepare</CODE
 
132
>) into memory that will not be freed
 
133
   by <CODE
 
134
CLASS="FUNCTION"
 
135
>SPI_finish</CODE
 
136
> nor by the transaction manager,
 
137
   and returns a pointer to the copied statement.  This gives you the
 
138
   ability to reuse prepared statements in the subsequent invocations of
 
139
   your procedure in the current session.
 
140
  </P
 
141
></DIV
 
142
><DIV
 
143
CLASS="REFSECT1"
 
144
><A
 
145
NAME="AEN62801"
 
146
></A
 
147
><H2
 
148
>Arguments</H2
 
149
><P
 
150
></P
 
151
><DIV
 
152
CLASS="VARIABLELIST"
 
153
><DL
 
154
><DT
 
155
><TT
 
156
CLASS="LITERAL"
 
157
>SPIPlanPtr <TT
 
158
CLASS="PARAMETER"
 
159
>plan</TT
 
160
></TT
 
161
></DT
 
162
><DD
 
163
><P
 
164
>      the prepared statement to be saved
 
165
     </P
 
166
></DD
 
167
></DL
 
168
></DIV
 
169
></DIV
 
170
><DIV
 
171
CLASS="REFSECT1"
 
172
><A
 
173
NAME="AEN62810"
 
174
></A
 
175
><H2
 
176
>Return Value</H2
 
177
><P
 
178
>   Pointer to the copied statement; or <TT
 
179
CLASS="SYMBOL"
 
180
>NULL</TT
 
181
> if unsuccessful.
 
182
   On error, <TT
 
183
CLASS="VARNAME"
 
184
>SPI_result</TT
 
185
> is set thus:
 
186
 
 
187
   <P
 
188
></P
 
189
></P><DIV
 
190
CLASS="VARIABLELIST"
 
191
><DL
 
192
><DT
 
193
><TT
 
194
CLASS="SYMBOL"
 
195
>SPI_ERROR_ARGUMENT</TT
 
196
></DT
 
197
><DD
 
198
><P
 
199
>       if <TT
 
200
CLASS="PARAMETER"
 
201
>plan</TT
 
202
> is <TT
 
203
CLASS="SYMBOL"
 
204
>NULL</TT
 
205
> or invalid
 
206
      </P
 
207
></DD
 
208
><DT
 
209
><TT
 
210
CLASS="SYMBOL"
 
211
>SPI_ERROR_UNCONNECTED</TT
 
212
></DT
 
213
><DD
 
214
><P
 
215
>       if called from an unconnected procedure
 
216
      </P
 
217
></DD
 
218
></DL
 
219
></DIV
 
220
><P>
 
221
  </P
 
222
></DIV
 
223
><DIV
 
224
CLASS="REFSECT1"
 
225
><A
 
226
NAME="AEN62828"
 
227
></A
 
228
><H2
 
229
>Notes</H2
 
230
><P
 
231
>   The originally passed-in statement is not freed, so you might wish to do
 
232
   <CODE
 
233
CLASS="FUNCTION"
 
234
>SPI_freeplan</CODE
 
235
> on it to avoid leaking memory
 
236
   until <CODE
 
237
CLASS="FUNCTION"
 
238
>SPI_finish</CODE
 
239
>.
 
240
  </P
 
241
><P
 
242
>   In most cases, <CODE
 
243
CLASS="FUNCTION"
 
244
>SPI_keepplan</CODE
 
245
> is preferred to this
 
246
   function, since it accomplishes largely the same result without needing
 
247
   to physically copy the prepared statement's data structures.
 
248
  </P
 
249
></DIV
 
250
><DIV
 
251
CLASS="NAVFOOTER"
 
252
><HR
 
253
ALIGN="LEFT"
 
254
WIDTH="100%"><TABLE
 
255
SUMMARY="Footer navigation table"
 
256
WIDTH="100%"
 
257
BORDER="0"
 
258
CELLPADDING="0"
 
259
CELLSPACING="0"
 
260
><TR
 
261
><TD
 
262
WIDTH="33%"
 
263
ALIGN="left"
 
264
VALIGN="top"
 
265
><A
 
266
HREF="spi-spi-keepplan.html"
 
267
ACCESSKEY="P"
 
268
>Prev</A
 
269
></TD
 
270
><TD
 
271
WIDTH="34%"
 
272
ALIGN="center"
 
273
VALIGN="top"
 
274
><A
 
275
HREF="index.html"
 
276
ACCESSKEY="H"
 
277
>Home</A
 
278
></TD
 
279
><TD
 
280
WIDTH="33%"
 
281
ALIGN="right"
 
282
VALIGN="top"
 
283
><A
 
284
HREF="spi-interface-support.html"
 
285
ACCESSKEY="N"
 
286
>Next</A
 
287
></TD
 
288
></TR
 
289
><TR
 
290
><TD
 
291
WIDTH="33%"
 
292
ALIGN="left"
 
293
VALIGN="top"
 
294
>SPI_keepplan</TD
 
295
><TD
 
296
WIDTH="34%"
 
297
ALIGN="center"
 
298
VALIGN="top"
 
299
><A
 
300
HREF="spi-interface.html"
 
301
ACCESSKEY="U"
 
302
>Up</A
 
303
></TD
 
304
><TD
 
305
WIDTH="33%"
 
306
ALIGN="right"
 
307
VALIGN="top"
 
308
>Interface Support Functions</TD
 
309
></TR
 
310
></TABLE
 
311
></DIV
 
312
></BODY
 
313
></HTML
 
314
>
 
 
b'\\ No newline at end of file'