<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/close.sgml,v 1.19 2003/09/22 00:16:57 petere Exp $
PostgreSQL documentation
-->

<refentry id="SQL-CLOSE">
 <refmeta>
  <refentrytitle id="SQL-CLOSE-TITLE">CLOSE</refentrytitle>
  <refmiscinfo>SQL - Language Statements</refmiscinfo>
 </refmeta>

 <refnamediv>
  <refname>CLOSE</refname>
  <refpurpose>close a cursor</refpurpose>
 </refnamediv>

 <indexterm zone="sql-close">
  <primary>CLOSE</primary>
 </indexterm>

 <refsynopsisdiv>
<synopsis>
CLOSE <replaceable class="PARAMETER">name</replaceable>
</synopsis>
 </refsynopsisdiv>

 <refsect1>
  <title>Description</title>

  <para>
   <command>CLOSE</command> frees the resources associated with an open cursor.
   After the cursor is closed, no subsequent operations
   are allowed on it. A cursor should be closed when it is
   no longer needed.
  </para>

  <para>
   Every non-holdable open cursor is implicitly closed when a
   transaction is terminated by <command>COMMIT</command> or
   <command>ROLLBACK</command>.  A holdable cursor is implicitly
   closed if the transaction that created it aborts via
   <command>ROLLBACK</command>.  If the creating transaction successfully
   commits, the holdable
   cursor remains open until an explicit <command>CLOSE</command> is
   executed, or the client disconnects.
  </para>
 </refsect1>
  
 <refsect1>
  <title>Parameters</title>

  <variablelist>
   <varlistentry>
    <term><replaceable class="PARAMETER">name</replaceable></term>
    <listitem>
     <para>
      The name of an open cursor to close.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1>
  <title>Notes</title>

  <para>
   <productname>PostgreSQL</productname> does not have an explicit
   <command>OPEN</command> cursor statement; a cursor is considered
   open when it is declared.  Use the <command>DECLARE</command>
   statement to declare a cursor.
  </para>
 </refsect1>

 <refsect1>
  <title>Examples</title>

  <para>
   Close the cursor <literal>liahona</literal>:
<programlisting>
CLOSE liahona;
</programlisting>
  </para>
 </refsect1>
 
 <refsect1>
  <title>Compatibility</title>
  
  <para>
   <command>CLOSE</command> is fully conforming with the SQL standard.
  </para>
 </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
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:
-->
