1<!--
2doc/src/sgml/ref/deallocate.sgml
3PostgreSQL documentation
4-->
5
6<refentry id="SQL-DEALLOCATE">
7 <indexterm zone="sql-deallocate">
8  <primary>DEALLOCATE</primary>
9 </indexterm>
10
11 <indexterm zone="sql-deallocate">
12  <primary>prepared statements</primary>
13  <secondary>removing</secondary>
14 </indexterm>
15
16 <refmeta>
17  <refentrytitle>DEALLOCATE</refentrytitle>
18  <manvolnum>7</manvolnum>
19  <refmiscinfo>SQL - Language Statements</refmiscinfo>
20 </refmeta>
21
22 <refnamediv>
23  <refname>DEALLOCATE</refname>
24  <refpurpose>deallocate a prepared statement</refpurpose>
25 </refnamediv>
26
27 <refsynopsisdiv>
28<synopsis>
29DEALLOCATE [ PREPARE ] { <replaceable class="parameter">name</replaceable> | ALL }
30</synopsis>
31 </refsynopsisdiv>
32
33 <refsect1>
34  <title>Description</title>
35
36  <para>
37   <command>DEALLOCATE</command> is used to deallocate a previously
38   prepared SQL statement. If you do not explicitly deallocate a
39   prepared statement, it is deallocated when the session ends.
40  </para>
41
42  <para>
43   For more information on prepared statements, see <xref
44   linkend="sql-prepare">.
45  </para>
46 </refsect1>
47
48 <refsect1>
49  <title>Parameters</title>
50
51  <variablelist>
52   <varlistentry>
53    <term><literal>PREPARE</literal></term>
54    <listitem>
55     <para>
56      This key word is ignored.
57     </para>
58    </listitem>
59   </varlistentry>
60
61   <varlistentry>
62    <term><replaceable class="parameter">name</replaceable></term>
63    <listitem>
64     <para>
65      The name of the prepared statement to deallocate.
66     </para>
67    </listitem>
68   </varlistentry>
69
70   <varlistentry>
71    <term><literal>ALL</literal></term>
72    <listitem>
73     <para>
74      Deallocate all prepared statements.
75     </para>
76    </listitem>
77   </varlistentry>
78  </variablelist>
79 </refsect1>
80
81 <refsect1>
82  <title>Compatibility</title>
83
84  <para>
85   The SQL standard includes a <command>DEALLOCATE</command>
86   statement, but it is only for use in embedded SQL.
87  </para>
88 </refsect1>
89
90 <refsect1>
91  <title>See Also</title>
92
93  <simplelist type="inline">
94   <member><xref linkend="sql-execute"></member>
95   <member><xref linkend="sql-prepare"></member>
96  </simplelist>
97 </refsect1>
98</refentry>
99