<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/deallocate.sgml,v 1.1 2002/08/27 04:55:07 tgl 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>
   remove a prepared query
  </refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  <refsynopsisdivinfo>
   <date>2002-08-12</date>
  </refsynopsisdivinfo>
  <synopsis>
   DEALLOCATE [ PREPARE ] <replaceable class="PARAMETER">plan_name</replaceable>
  </synopsis>

  <refsect2 id="R2-SQL-DEALLOCATE-1">
   <refsect2info>
    <date>2002-08-12</date>
   </refsect2info>
   <title>
    Inputs
   </title>

   <para>
    <variablelist>
	 <varlistentry>
	  <term>PREPARE</term>
	  <listitem>
	   <para>
		This keyword is ignored.
	   </para>
	  </listitem>
	  </varlistentry>
     <varlistentry>
      <term><replaceable class="PARAMETER">plan_name</replaceable></term>
      <listitem>
       <para>
		The name of the prepared query to remove.
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </para>
  </refsect2>
  <refsect2 id="R2-SQL-DEALLOCATE-2">
   <refsect2info>
    <date>2002-08-12</date>
   </refsect2info>
   <title>
    Outputs
   </title>
   <para>

    <variablelist>
     <varlistentry>
      <term><computeroutput>
		<returnvalue>DEALLOCATE</returnvalue>
       </computeroutput></term>
      <listitem>
       <para>
		The prepared query was removed successfully.
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </para>
  </refsect2>
 </refsynopsisdiv>

 <refsect1 id="R1-SQL-DEALLOCATE-1">
  <refsect1info>
   <date>2002-08-12</date>
  </refsect1info>
  <title>
   Description
  </title>

  <para>
   <command>DEALLOCATE</command> is used to remove a previously
   prepared query. If you do not explicitly
   <command>DEALLOCATE</command> a prepared query, it is removed when
   the session ends.
  </para>

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

 <refsect1 id="R1-SQL-DEALLOCATE-2">
  <title>
   Compatibility
  </title>

  <refsect2 id="R2-SQL-DEALLOCATE-3">
   <refsect2info>
    <date>2002-08-12</date>
   </refsect2info>
   <title>
    SQL92
   </title>
   <para>
	SQL92 includes a <command>DEALLOCATE</command> statement, but it is
    only for use in embedded SQL clients.
   </para>
  </refsect2>
 </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:
-->
