File: pgtcl-pgexec.html

package info (click to toggle)
pgtcl 1%3A1.9%2Bgit20120911-3
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 2,240 kB
  • ctags: 315
  • sloc: ansic: 4,475; tcl: 634; sh: 149; makefile: 36; sql: 11
file content (311 lines) | stat: -rw-r--r-- 4,600 bytes parent folder | download | duplicates (2)
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML
><HEAD
><TITLE
>pg_exec</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
REV="MADE"
HREF="mailto:pgsql-docs@postgresql.org"><LINK
REL="HOME"
TITLE="PostgreSQL Tcl Interface Documentation"
HREF="index.html"><LINK
REL="UP"
TITLE="pgtcl Command Reference"
HREF="libpgtcl-ref.html"><LINK
REL="PREVIOUS"
TITLE="pg_conndefaults"
HREF="pgtcl-pgconndefaults.html"><LINK
REL="NEXT"
TITLE="pg_exec_prepared"
HREF="pgtcl-pgexecprepared.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
HREF="stylesheet.css"><META
NAME="creation"
CONTENT="2005-11-27T13:24:31"></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"
>PostgreSQL Tcl Interface Documentation</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
HREF="pgtcl-pgconndefaults.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
HREF="pgtcl-pgconndefaults.html"
>Fast Backward</A
></TD
><TD
WIDTH="60%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="top"
><A
HREF="pgtcl-pgexecprepared.html"
>Fast Forward</A
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="top"
><A
HREF="pgtcl-pgexecprepared.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="PGTCL-PGEXEC"
></A
>pg_exec</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN608"
></A
><H2
>Name</H2
>pg_exec&nbsp;--&nbsp;send a command to the server<A
NAME="IX-PGTCL-PGEXEC-2"
></A
></DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN613"
></A
><H2
>Synopsis</H2
><PRE
CLASS="SYNOPSIS"
>pg_exec <VAR
CLASS="PARAMETER"
>conn</VAR
> <VAR
CLASS="PARAMETER"
>commandString</VAR
> ?<SPAN
CLASS="OPTIONAL"
><VAR
CLASS="PARAMETER"
>args</VAR
></SPAN
>?</PRE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN619"
></A
><H2
>Description</H2
><P
>   <CODE
CLASS="FUNCTION"
>pg_exec</CODE
> submits a command to the
   <SPAN
CLASS="PRODUCTNAME"
>PostgreSQL</SPAN
> server and returns a result.
   Command result handles start with the connection handle and add a
   period and a result number.
  </P
><P
>   Note that lack of a Tcl error is not proof that the command
   succeeded!  An error message returned by the server will be
   processed as a command result with failure status, not by
   generating a Tcl error in <CODE
CLASS="FUNCTION"
>pg_exec</CODE
>.
  </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN626"
></A
><H2
>Arguments</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><VAR
CLASS="PARAMETER"
>conn</VAR
></DT
><DD
><P
>      The handle of the connection on which to execute the command.
     </P
></DD
><DT
><VAR
CLASS="PARAMETER"
>commandString</VAR
></DT
><DD
><P
>      The SQL command to execute.
     </P
></DD
><DT
><VAR
CLASS="PARAMETER"
>args</VAR
></DT
><DD
><P
>      For <SPAN
CLASS="PRODUCTNAME"
>PostgreSQL</SPAN
> versions greater than 7.4, <VAR
CLASS="PARAMETER"
>args</VAR
>
      consists of zero or more optional values that can be inserted,
      unquoted, into the SQL statement using $-style substitution.
     </P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN646"
></A
><H2
>Return Value</H2
><P
>   A result handle. A Tcl error will be returned if
   <SPAN
CLASS="APPLICATION"
>pgtcl</SPAN
> was unable to obtain a server
   response.  Otherwise, a command result object is created and a
   handle for it is returned.  This handle can be passed to
   <CODE
CLASS="FUNCTION"
>pg_result</CODE
> to obtain the results of the
   command.
  </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN651"
></A
><H2
>Example</H2
><P
></P><PRE
CLASS="PROGRAMLISTING"
>pg_exec $conn {select * from table1 where id = $1 and user = $2} $id $user</PRE
><P>
  </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="pgtcl-pgconndefaults.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="pgtcl-pgexecprepared.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>pg_conndefaults</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="libpgtcl-ref.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>pg_exec_prepared</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>