From: Neil Conway <neilc@samurai.com>
Date: Mon, 26 Jan 2004 17:26:31 +0000 (+0000)
Subject: Add usage examples for PREPARE and EXECUTE. Original patch from Gavin
X-Git-Tag: REL8_0_0BETA1~1276
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=f30d39e706568f375291c8e2e14cf19ba84477dc;p=postgresql

Add usage examples for PREPARE and EXECUTE. Original patch from Gavin
Sherry, editorializing by Neil Conway.
---

diff --git a/doc/src/sgml/ref/execute.sgml b/doc/src/sgml/ref/execute.sgml
index c182ae0624..83c9fa91aa 100644
--- a/doc/src/sgml/ref/execute.sgml
+++ b/doc/src/sgml/ref/execute.sgml
@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/execute.sgml,v 1.7 2003/11/29 19:51:38 pgsql Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/execute.sgml,v 1.8 2004/01/26 17:26:30 neilc Exp $
 PostgreSQL documentation
 -->
 
@@ -78,6 +78,15 @@ EXECUTE <replaceable class="PARAMETER">plan_name</replaceable> [ (<replaceable c
   </variablelist>
  </refsect1>
 
+ <refsect1>
+  <title>Examples</>
+   <para>
+    Examples are given in the <xref linkend="sql-prepare-examples"
+    endterm="sql-prepare-examples-title"> section of the <xref
+    linkend="sql-prepare" endterm="sql-prepare-title"> documentation.
+   </para>
+ </refsect1>
+
  <refsect1>
   <title>Compatibility</title>
 
diff --git a/doc/src/sgml/ref/prepare.sgml b/doc/src/sgml/ref/prepare.sgml
index e7190b1b17..780c5231c4 100644
--- a/doc/src/sgml/ref/prepare.sgml
+++ b/doc/src/sgml/ref/prepare.sgml
@@ -1,5 +1,5 @@
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/prepare.sgml,v 1.10 2003/12/14 00:55:46 neilc Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/prepare.sgml,v 1.11 2004/01/26 17:26:31 neilc Exp $
 PostgreSQL documentation
 -->
 
@@ -139,6 +139,29 @@ PREPARE <replaceable class="PARAMETER">plan_name</replaceable> [ (<replaceable c
   </para>
  </refsect1>
 
+ <refsect1 id="sql-prepare-examples">
+  <title id="sql-prepare-examples-title">Examples</title>
+  <para>
+   Create a prepared query for an <command>INSERT</command> statement,
+   and then execute it:
+<programlisting>
+PREPARE fooplan (int, text, bool, numeric(8,2)) AS
+    INSERT INTO foo VALUES($1, '$2', '$3', '$4');
+EXECUTE fooplan(1, 'Hunter Valley', 't', '200.00');
+</programlisting>
+  </para>
+
+  <para>
+   Create a prepared query for a <command>SELECT</command> statement,
+   and then execute it:
+<programlisting>
+PREPARE usrrptplan (int, date) AS
+    SELECT * FROM users u, logs l WHERE u.usrid=$1 AND u.usrid=l.usrid
+    AND l.date = $2;
+EXECUTE usrrptplan(1, current_date);
+</programlisting>
+  </para>
+ </refsect1>
  <refsect1>
   <title>Compatibility</title>