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