<!--
$PostgreSQL: pgsql/doc/src/sgml/ref/deallocate.sgml,v 1.7 2004/09/30 04:23:27 neilc Exp $
PostgreSQL documentation
-->

<refentry id="SQL-DEALLOCATE">
 <refmeta>
  <refentrytitle id="sql-deallocate-title">DEALLOCATE</refentrytitle>
  <refmiscinfo>SQL - Language Statements</refmiscinfo>
 </refmeta>

 <refnamediv>
  <refname>DEALLOCATE</refname>
  <refpurpose>deallocate a prepared statement</refpurpose>
 </refnamediv>

 <indexterm zone="sql-deallocate">
  <primary>DEALLOCATE</primary>
 </indexterm>

 <indexterm zone="sql-deallocate">
  <primary>prepared statements</primary>
  <secondary>removing</secondary>
 </indexterm>

 <refsynopsisdiv>
<synopsis>
DEALLOCATE [ PREPARE ] <replaceable class="parameter">plan_name</replaceable>
</synopsis>
 </refsynopsisdiv>

 <refsect1>
  <title>Description</title>

  <para>
   <command>DEALLOCATE</command> is used to deallocate a previously
   prepared SQL statement. If you do not explicitly deallocate a
   prepared statement, it is deallocated when the session ends.
  </para>

  <para>
   For more information on prepared statements, see <xref
   linkend="sql-prepare" endterm="sql-prepare-title">.
  </para>
 </refsect1>

 <refsect1>
  <title>Parameters</title>

  <variablelist>
   <varlistentry>
    <term><literal>PREPARE</literal></term>
    <listitem>
     <para>
      This key word is ignored.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term><replaceable class="parameter">plan_name</replaceable></term>
    <listitem>
     <para>
      The name of the prepared statement to deallocate.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1>
  <title>Compatibility</title>

  <para>
   The SQL standard includes a <command>DEALLOCATE</command>
   statement, but it is only for use in embedded SQL.
  </para>
 </refsect1>

 <refsect1>
  <title>See Also</title>

  <simplelist type="inline">
   <member><xref linkend="sql-execute" endterm="sql-execute-title"></member>
   <member><xref linkend="sql-prepare" endterm="sql-prepare-title"></member>
  </simplelist>
 </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:nil
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../reference.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:"/usr/lib/sgml/catalog"
sgml-local-ecat-files:nil
End:
-->
