codekingpro/portable-devtools

1<?xml version="1.0" encoding="UTF-8" standalone="no"?>2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>PREPARE</title><link rel="stylesheet" type="text/css" href="stylesheet.css" /><link rev="made" href="pgsql-docs@lists.postgresql.org" /><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /><link rel="prev" href="ecpg-sql-open.html" title="OPEN" /><link rel="next" href="ecpg-sql-set-autocommit.html" title="SET AUTOCOMMIT" /></head><body id="docContent" class="container-fluid col-10"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="5" align="center">PREPARE</th></tr><tr><td width="10%" align="left"><a accesskey="p" href="ecpg-sql-open.html" title="OPEN">Prev</a> </td><td width="10%" align="left"><a accesskey="u" href="ecpg-sql-commands.html" title="36.14. Embedded SQL Commands">Up</a></td><th width="60%" align="center">36.14. Embedded SQL Commands</th><td width="10%" align="right"><a accesskey="h" href="index.html" title="PostgreSQL 16.3 Documentation">Home</a></td><td width="10%" align="right"> <a accesskey="n" href="ecpg-sql-set-autocommit.html" title="SET AUTOCOMMIT">Next</a></td></tr></table><hr /></div><div class="refentry" id="ECPG-SQL-PREPARE"><div class="titlepage"></div><div class="refnamediv"><h2>PREPARE</h2><p>PREPARE — prepare a statement for execution</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">3PREPARE <em class="replaceable"><code>prepared_name</code></em> FROM <em class="replaceable"><code>string</code></em>4</pre></div><div class="refsect1" id="id-1.7.5.20.13.3"><h2>Description</h2><p>5     <code class="command">PREPARE</code> prepares a statement dynamically6     specified as a string for execution.  This is different from the7     direct SQL statement <a class="xref" href="sql-prepare.html" title="PREPARE"><span class="refentrytitle">PREPARE</span></a>, which can also8     be used in embedded programs.  The <a class="xref" href="sql-execute.html" title="EXECUTE"><span class="refentrytitle">EXECUTE</span></a>9     command is used to execute either kind of prepared statement.10    </p></div><div class="refsect1" id="id-1.7.5.20.13.4"><h2>Parameters</h2><div class="variablelist"><dl class="variablelist"><dt id="ECPG-SQL-PREPARE-PREPARED-NAME"><span class="term"><em class="replaceable"><code>prepared_name</code></em></span> <a href="#ECPG-SQL-PREPARE-PREPARED-NAME" class="id_link">#</a></dt><dd><p>11        An identifier for the prepared query.12       </p></dd><dt id="ECPG-SQL-PREPARE-STRING"><span class="term"><em class="replaceable"><code>string</code></em></span> <a href="#ECPG-SQL-PREPARE-STRING" class="id_link">#</a></dt><dd><p>13        A literal string or a host variable containing a preparable14        SQL statement, one of SELECT, INSERT, UPDATE, or DELETE.15        Use question marks (<code class="literal">?</code>) for parameter values16        to be supplied at execution.17       </p></dd></dl></div></div><div class="refsect1" id="id-1.7.5.20.13.5"><h2>Notes</h2><p>18     In typical usage, the <em class="replaceable"><code>string</code></em> is a host19     variable reference to a string containing a dynamically-constructed20     SQL statement.  The case of a literal string is not very useful;21     you might as well just write a direct SQL <code class="command">PREPARE</code>22     statement.23    </p><p>24     If you do use a literal string, keep in mind that any double quotes25     you might wish to include in the SQL statement must be written as26     octal escapes (<code class="literal">\042</code>) not the usual C27     idiom <code class="literal">\"</code>.  This is because the string is inside28     an <code class="literal">EXEC SQL</code> section, so the ECPG lexer parses it29     according to SQL rules not C rules.  Any embedded backslashes will30     later be handled according to C rules; but <code class="literal">\"</code>31     causes an immediate syntax error because it is seen as ending the32     literal.33    </p></div><div class="refsect1" id="id-1.7.5.20.13.6"><h2>Examples</h2><pre class="programlisting">34char *stmt = "SELECT * FROM test1 WHERE a = ? AND b = ?";35 36EXEC SQL ALLOCATE DESCRIPTOR outdesc;37EXEC SQL PREPARE foo FROM :stmt;38 39EXEC SQL EXECUTE foo USING SQL DESCRIPTOR indesc INTO SQL DESCRIPTOR outdesc;40</pre></div><div class="refsect1" id="id-1.7.5.20.13.7"><h2>Compatibility</h2><p>41     <code class="command">PREPARE</code> is specified in the SQL standard.42    </p></div><div class="refsect1" id="id-1.7.5.20.13.8"><h2>See Also</h2><span class="simplelist"><a class="xref" href="sql-execute.html" title="EXECUTE"><span class="refentrytitle">EXECUTE</span></a></span></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ecpg-sql-open.html" title="OPEN">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ecpg-sql-commands.html" title="36.14. Embedded SQL Commands">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ecpg-sql-set-autocommit.html" title="SET AUTOCOMMIT">Next</a></td></tr><tr><td width="40%" align="left" valign="top">OPEN </td><td width="20%" align="center"><a accesskey="h" href="index.html" title="PostgreSQL 16.3 Documentation">Home</a></td><td width="40%" align="right" valign="top"> SET AUTOCOMMIT</td></tr></table></div></body></html>