doc/src/sgml/ref/deallocate.sgml

   1 <!--
   2 $PostgreSQL$
   3 PostgreSQL documentation
   4 -->
   5
   6 <refentry id="SQL-DEALLOCATE">
   7  <refmeta>
   8   <refentrytitle id="sql-deallocate-title">DEALLOCATE</refentrytitle>
   9   <manvolnum>7</manvolnum>
  10   <refmiscinfo>SQL - Language Statements</refmiscinfo>
  11  </refmeta>
  12
  13  <refnamediv>
  14   <refname>DEALLOCATE</refname>
  15   <refpurpose>deallocate a prepared statement</refpurpose>
  16  </refnamediv>
  17
  18  <indexterm zone="sql-deallocate">
  19   <primary>DEALLOCATE</primary>
  20  </indexterm>
  21
  22  <indexterm zone="sql-deallocate">
  23   <primary>prepared statements</primary>
  24   <secondary>removing</secondary>
  25  </indexterm>
  26
  27  <refsynopsisdiv>
  28 <synopsis>
  29 DEALLOCATE [ 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" endterm="sql-prepare-title">.
  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" endterm="sql-execute-title"></member>
  95    <member><xref linkend="sql-prepare" endterm="sql-prepare-title"></member>
  96   </simplelist>
  97  </refsect1>
  98 </refentry>