postgresql/doc/src/sgml/ref/close.sgml

<refentry id="SQL-CLOSE">
 <refmeta>
  <refentrytitle>
   CLOSE
  </refentrytitle>
  <refmiscinfo>SQL - Language Statements</refmiscinfo>
 </refmeta>
 <refnamediv>
  <refname>
   CLOSE
  </refname>
  <refpurpose>
   Close a cursor
  </refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  <refsynopsisdivinfo>
   <date>1998-09-08</date>
  </refsynopsisdivinfo>
  <synopsis>
CLOSE <replaceable class="PARAMETER">cursor</replaceable>
  </synopsis>
  
  <refsect2 id="R2-SQL-CLOSE-1">
   <refsect2info>
    <date>1998-09-08</date>
   </refsect2info>
   <title>
    Inputs
   </title>
   <para>

    <variablelist>
     <varlistentry>
      <term><replaceable class="PARAMETER">cursor</replaceable></term>
      <listitem>
       <para>
	The name of an open cursor to close.
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </para>
  </refsect2>
  
  <refsect2 id="R2-SQL-CLOSE-2">
   <refsect2info>
    <date>1998-09-08</date>
   </refsect2info>
   <title>
    Outputs
   </title>
   <para>

    <variablelist>
     <varlistentry>
      <term><computeroutput>
CLOSE
       </computeroutput></term>
      <listitem>
       <para>
	Message returned if the cursor is successfully closed.
       </para>
      </listitem>
     </varlistentry>
     <varlistentry>
      <term><computeroutput>
NOTICE PerformPortalClose: portal "<replaceable class="PARAMETER">cursor</replaceable>" not found
       </computeroutput></term>
      <listitem>
       <para>
	This warning is given if
	<replaceable class="PARAMETER">cursor</replaceable> is not
	declared or has already been closed.
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </para>
  </refsect2>
 </refsynopsisdiv>

 <refsect1 id="R1-SQL-CLOSE-1">
  <refsect1info>
   <date>1998-09-08</date>
  </refsect1info>
  <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>
   An implicit close is executed for every open cursor when a
   transaction is terminated by <command>COMMIT</command>
 or <command>ROLLBACK</command>.
  </para>
  
  <refsect2 id="R2-SQL-CLOSE-3">
   <refsect2info>
    <date>1998-09-08</date>
   </refsect2info>
   <title>
    Notes
   </title>
   <para>
    <productname>Postgres</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>
  </refsect2>
 </refsect1>

 <refsect1 id="R1-SQL-CLOSE-2">
  <title>
   Usage
  </title>
  <para>
   Close the cursor liahona:
  </para>
  <programlisting>
CLOSE liahona;
  </programlisting>
 </refsect1>
 
 <refsect1 id="R1-SQL-CLOSE-3">
  <title>
   Compatibility
  </title>
  <para>
  </para>
  
  <refsect2 id="R2-SQL-CLOSE-4">
   <refsect2info>
    <date>1998-09-08</date>
   </refsect2info>
   <title>
    SQL92
   </title>
   <para>
    <command>CLOSE</command> is fully compatible with SQL92.
   </para>
  </refsect2>
 </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:
-->