2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
4 <!ENTITY % myents SYSTEM "entities.inc">
8 <!-- prepared statements -->
10 <reference id="ref-prepared">
11 <title>Prepared Statements</title>
18 <refentry id="prepare-sql">
20 <refentrytitle>PREPARE-SQL</refentrytitle>
23 <refname>>PREPARE-SQL</refname>
24 <refpurpose>Create a prepared statement.</refpurpose>
25 <refclass>Function</refclass>
30 <function>prepare-sql</function> <replaceable>sql-stmt types</replaceable> &key <replaceable>database</replaceable> <replaceable>result-types</replaceable> <replaceable>field-names</replaceable> => <returnvalue>result</returnvalue></synopsis>
33 <title>Arguments and Values</title>
35 <!-- arguments and values -->
39 <title>Description</title>
40 <para>Prepares a SQL statement <parameter>sql-stmt</parameter>
41 for execution. <parameter>types</parameter> contains a list of
42 types corresponding to the input parameters. Returns a
43 prepared-statement object.
54 <title>Examples</title>
60 <title>Side Effects</title>
66 <title>Affected by</title>
74 <title>Exceptional Situations</title>
76 <!-- execeptional situations -->
80 <title>See Also</title>
95 <refentry id="run-prepared-sql">
97 <refentrytitle>RUN-PREPARED-SQL</refentrytitle>
100 <refname>RUN-PREPARED-SQL</refname>
101 <refpurpose>Execute a prepared statement.</refpurpose>
102 <refclass>Function</refclass>
105 <title>Syntax</title>
107 <function>run-prepared-sql</function> <replaceable>prepared-stmt</replaceable> => <returnvalue><!-- result --></returnvalue></synopsis>
110 <title>Arguments and Values</title>
112 <!-- arguments and values -->
116 <title>Description</title>
117 <para>Execute the prepared sql statment. All input
118 parameters must be bound.
122 <title>Examples</title>
128 <title>Side Effects</title>
130 <!-- side effects -->
134 <title>Affected by</title>
142 <title>Exceptional Situations</title>
144 <!-- execeptional situations -->
148 <title>See Also</title>
163 <refentry id="free-prepared-sql">
165 <refentrytitle>FREE-PREPARED-SQL</refentrytitle>
168 <refname>FREE-PREPARED-SQL</refname>
169 <refpurpose>Delete a prepared statement object.</refpurpose>
170 <refclass>Function</refclass>
173 <title>Syntax</title>
175 <function>free-prepared-sql</function> <replaceable>prepared-stmt</replaceable> => <returnvalue><!-- result --></returnvalue></synopsis>
178 <title>Arguments and Values</title>
180 <!-- arguments and values -->
184 <title>Description</title>
185 <para>Delete the objects associated with a prepared
190 <title>Examples</title>
196 <title>Side Effects</title>
198 <!-- side effects -->
202 <title>Affected by</title>
210 <title>Exceptional Situations</title>
212 <!-- execeptional situations -->
216 <title>See Also</title>
231 <refentry id="bind-parameter">
233 <refentrytitle>BIND-PARAMETER</refentrytitle>
236 <refname>BIND-PARAMETER</refname>
237 <refpurpose>Bind a parameter in a prepared statement.</refpurpose>
238 <refclass>Function</refclass>
241 <title>Syntax</title>
243 <function>bind-parameter</function> <replaceable>prepared-stmt</replaceable> <replaceable>position</replaceable> <replaceable>value</replaceable> => <returnvalue><!-- result --></returnvalue></synopsis>
246 <title>Arguments and Values</title>
248 <!-- arguments and values -->
252 <title>Description</title>
253 <para>Sets the value of a parameter in a prepared statement.
257 <title>Examples</title>
263 <title>Side Effects</title>
265 <!-- side effects -->
269 <title>Affected by</title>
277 <title>Exceptional Situations</title>
279 <!-- execeptional situations -->
283 <title>See Also</title>