blob: 1c1b0a64f03d5a05c869c81b2aa8d806f1cfd8ca (
plain)
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
|
'\" t
.\" Title: EXECUTE
.\" Author: The PostgreSQL Global Development Group
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 2024
.\" Manual: PostgreSQL 15.7 Documentation
.\" Source: PostgreSQL 15.7
.\" Language: English
.\"
.TH "EXECUTE" "7" "2024" "PostgreSQL 15.7" "PostgreSQL 15.7 Documentation"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
EXECUTE \- execute a prepared statement
.SH "SYNOPSIS"
.sp
.nf
EXECUTE \fIname\fR [ ( \fIparameter\fR [, \&.\&.\&.] ) ]
.fi
.SH "DESCRIPTION"
.PP
\fBEXECUTE\fR
is used to execute a previously prepared statement\&. Since prepared statements only exist for the duration of a session, the prepared statement must have been created by a
\fBPREPARE\fR
statement executed earlier in the current session\&.
.PP
If the
\fBPREPARE\fR
statement that created the statement specified some parameters, a compatible set of parameters must be passed to the
\fBEXECUTE\fR
statement, or else an error is raised\&. Note that (unlike functions) prepared statements are not overloaded based on the type or number of their parameters; the name of a prepared statement must be unique within a database session\&.
.PP
For more information on the creation and usage of prepared statements, see
\fBPREPARE\fR(7)\&.
.SH "PARAMETERS"
.PP
\fIname\fR
.RS 4
The name of the prepared statement to execute\&.
.RE
.PP
\fIparameter\fR
.RS 4
The actual value of a parameter to the prepared statement\&. This must be an expression yielding a value that is compatible with the data type of this parameter, as was determined when the prepared statement was created\&.
.RE
.SH "OUTPUTS"
.PP
The command tag returned by
\fBEXECUTE\fR
is that of the prepared statement, and not
EXECUTE\&.
.SH "EXAMPLES"
.PP
Examples are given in
Examples
in the
\fBPREPARE\fR(7)
documentation\&.
.SH "COMPATIBILITY"
.PP
The SQL standard includes an
\fBEXECUTE\fR
statement, but it is only for use in embedded SQL\&. This version of the
\fBEXECUTE\fR
statement also uses a somewhat different syntax\&.
.SH "SEE ALSO"
\fBDEALLOCATE\fR(7), \fBPREPARE\fR(7)
|
