11<!--
2- $Header: /cvsroot/pgsql/doc/src/sgml/ref/deallocate.sgml,v 1.1 2002/08/27 04:55:07 tgl Exp $
2+ $Header: /cvsroot/pgsql/doc/src/sgml/ref/deallocate.sgml,v 1.2 2003/04/26 23:56:51 petere Exp $
33PostgreSQL documentation
44-->
55
@@ -8,114 +8,79 @@ PostgreSQL documentation
88 <refentrytitle id="sql-deallocate-title">DEALLOCATE</refentrytitle>
99 <refmiscinfo>SQL - Language Statements</refmiscinfo>
1010 </refmeta>
11+
1112 <refnamediv>
12- <refname>
13- DEALLOCATE
14- </refname>
15- <refpurpose>
16- remove a prepared query
17- </refpurpose>
13+ <refname>DEALLOCATE</refname>
14+ <refpurpose>deallocate a prepared statement</refpurpose>
1815 </refnamediv>
19- <refsynopsisdiv>
20- <refsynopsisdivinfo>
21- <date>2002-08-12</date>
22- </refsynopsisdivinfo>
23- <synopsis>
24- DEALLOCATE [ PREPARE ] <replaceable class="PARAMETER">plan_name</replaceable>
25- </synopsis>
26-
27- <refsect2 id="R2-SQL-DEALLOCATE-1">
28- <refsect2info>
29- <date>2002-08-12</date>
30- </refsect2info>
31- <title>
32- Inputs
33- </title>
34-
35- <para>
36- <variablelist>
37- <varlistentry>
38- <term>PREPARE</term>
39- <listitem>
40- <para>
41- This keyword is ignored.
42- </para>
43- </listitem>
44- </varlistentry>
45- <varlistentry>
46- <term><replaceable class="PARAMETER">plan_name</replaceable></term>
47- <listitem>
48- <para>
49- The name of the prepared query to remove.
50- </para>
51- </listitem>
52- </varlistentry>
53- </variablelist>
54- </para>
55- </refsect2>
56- <refsect2 id="R2-SQL-DEALLOCATE-2">
57- <refsect2info>
58- <date>2002-08-12</date>
59- </refsect2info>
60- <title>
61- Outputs
62- </title>
63- <para>
6416
65- <variablelist>
66- <varlistentry>
67- <term><computeroutput>
68- <returnvalue>DEALLOCATE</returnvalue>
69- </computeroutput></term>
70- <listitem>
71- <para>
72- The prepared query was removed successfully.
73- </para>
74- </listitem>
75- </varlistentry>
76- </variablelist>
77- </para>
78- </refsect2>
17+ <refsynopsisdiv>
18+ <synopsis>
19+ DEALLOCATE [ PREPARE ] <replaceable class="parameter">plan_name</replaceable>
20+ </synopsis>
7921 </refsynopsisdiv>
8022
81- <refsect1 id="R1-SQL-DEALLOCATE-1">
82- <refsect1info>
83- <date>2002-08-12</date>
84- </refsect1info>
85- <title>
86- Description
87- </title>
23+ <refsect1>
24+ <title>Description</title>
8825
8926 <para>
90- <command>DEALLOCATE</command> is used to remove a previously
91- prepared query. If you do not explicitly
92- <command>DEALLOCATE</command> a prepared query, it is removed when
93- the session ends.
27+ <command>DEALLOCATE</command> is used to deallocate a previously
28+ prepared SQL statement. If you do not explicitly deallocate a
29+ prepared statement, it is deallocated when the session ends.
9430 </para>
9531
9632 <para>
97- For more information on preparedqueries , see <xref
33+ For more information on preparedstatements , see <xref
9834 linkend="sql-prepare" endterm="sql-prepare-title">.
9935 </para>
10036 </refsect1>
10137
102- <refsect1 id="R1-SQL-DEALLOCATE-2">
103- <title>
104- Compatibility
105- </title>
38+ <refsect1>
39+ <title>Parameters</title>
40+
41+ <variablelist>
42+ <varlistentry>
43+ <term><literal>PREPARE</literal></term>
44+ <listitem>
45+ <para>
46+ This key word is ignored.
47+ </para>
48+ </listitem>
49+ </varlistentry>
50+
51+ <varlistentry>
52+ <term><replaceable class="parameter">plan_name</replaceable></term>
53+ <listitem>
54+ <para>
55+ The name of the prepared statement to deallocate.
56+ </para>
57+ </listitem>
58+ </varlistentry>
59+ </variablelist>
60+ </refsect1>
61+
62+ <refsect1>
63+ <title>Diagnostics</title>
64+
65+ <variablelist>
66+ <varlistentry>
67+ <term><computeroutput>DEALLOCATE</computeroutput></term>
68+ <listitem>
69+ <para>
70+ Message returned if the prepared statement was deallocated successfully.
71+ </para>
72+ </listitem>
73+ </varlistentry>
74+ </variablelist>
75+ </refsect1>
10676
107- <refsect2 id="R2-SQL-DEALLOCATE-3">
108- <refsect2info>
109- <date>2002-08-12</date>
110- </refsect2info>
111- <title>
112- SQL92
113- </title>
114- <para>
115- SQL92 includes a <command>DEALLOCATE</command> statement, but it is
116- only for use in embedded SQL clients.
117- </para>
118- </refsect2>
77+ <refsect1>
78+ <title>Compatibility</title>
79+
80+ <para>
81+ The SQL standard includes a <command>DEALLOCATE</command>
82+ statement, but it is only for use in embedded SQL.
83+ </para>
11984 </refsect1>
12085</refentry>
12186