1999-07-22 17:09:15 +02:00
|
|
|
<!--
|
2007-04-12 08:53:49 +02:00
|
|
|
$PostgreSQL: pgsql/doc/src/sgml/ref/close.sgml,v 1.25 2007/04/12 06:53:45 neilc Exp $
|
2001-12-08 04:24:40 +01:00
|
|
|
PostgreSQL documentation
|
1999-07-22 17:09:15 +02:00
|
|
|
-->
|
|
|
|
|
1999-07-06 19:16:42 +02:00
|
|
|
<refentry id="SQL-CLOSE">
|
|
|
|
<refmeta>
|
2002-04-21 21:02:39 +02:00
|
|
|
<refentrytitle id="SQL-CLOSE-TITLE">CLOSE</refentrytitle>
|
1999-07-06 19:16:42 +02:00
|
|
|
<refmiscinfo>SQL - Language Statements</refmiscinfo>
|
|
|
|
</refmeta>
|
2003-04-15 15:25:08 +02:00
|
|
|
|
1999-07-06 19:16:42 +02:00
|
|
|
<refnamediv>
|
2003-04-15 15:25:08 +02:00
|
|
|
<refname>CLOSE</refname>
|
|
|
|
<refpurpose>close a cursor</refpurpose>
|
1998-12-29 03:24:47 +01:00
|
|
|
</refnamediv>
|
2003-04-15 15:25:08 +02:00
|
|
|
|
2003-08-31 19:32:24 +02:00
|
|
|
<indexterm zone="sql-close">
|
|
|
|
<primary>CLOSE</primary>
|
|
|
|
</indexterm>
|
|
|
|
|
2004-06-17 14:41:02 +02:00
|
|
|
<indexterm zone="sql-close">
|
|
|
|
<primary>cursor</primary>
|
|
|
|
<secondary>CLOSE</secondary>
|
|
|
|
</indexterm>
|
|
|
|
|
1999-07-06 19:16:42 +02:00
|
|
|
<refsynopsisdiv>
|
2003-04-15 15:25:08 +02:00
|
|
|
<synopsis>
|
2007-04-12 08:53:49 +02:00
|
|
|
CLOSE { <replaceable class="PARAMETER">name</replaceable> | ALL }
|
2003-04-15 15:25:08 +02:00
|
|
|
</synopsis>
|
1999-07-06 19:16:42 +02:00
|
|
|
</refsynopsisdiv>
|
|
|
|
|
2003-04-15 15:25:08 +02:00
|
|
|
<refsect1>
|
|
|
|
<title>Description</title>
|
|
|
|
|
1999-07-06 19:16:42 +02:00
|
|
|
<para>
|
1998-09-16 16:43:12 +02:00
|
|
|
<command>CLOSE</command> frees the resources associated with an open cursor.
|
1998-05-13 07:34:00 +02:00
|
|
|
After the cursor is closed, no subsequent operations
|
|
|
|
are allowed on it. A cursor should be closed when it is
|
|
|
|
no longer needed.
|
1999-07-06 19:16:42 +02:00
|
|
|
</para>
|
2003-04-15 15:25:08 +02:00
|
|
|
|
1999-07-06 19:16:42 +02:00
|
|
|
<para>
|
2003-08-17 06:46:00 +02:00
|
|
|
Every non-holdable open cursor is implicitly closed when a
|
|
|
|
transaction is terminated by <command>COMMIT</command> or
|
2003-09-09 20:28:53 +02:00
|
|
|
<command>ROLLBACK</command>. A holdable cursor is implicitly
|
|
|
|
closed if the transaction that created it aborts via
|
2007-04-12 08:53:49 +02:00
|
|
|
<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.
|
1999-07-06 19:16:42 +02:00
|
|
|
</para>
|
2003-04-15 15:25:08 +02:00
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>Parameters</title>
|
|
|
|
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
2003-09-22 02:16:58 +02:00
|
|
|
<term><replaceable class="PARAMETER">name</replaceable></term>
|
2003-04-15 15:25:08 +02:00
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
The name of an open cursor to close.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
2007-04-12 08:53:49 +02:00
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><literal>ALL</literal></term>
|
|
|
|
<listitem>
|
|
|
|
<para>
|
|
|
|
Close all open cursors.
|
|
|
|
</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
2003-04-15 15:25:08 +02:00
|
|
|
</variablelist>
|
1998-05-13 07:34:00 +02:00
|
|
|
</refsect1>
|
|
|
|
|
2003-04-15 15:25:08 +02:00
|
|
|
<refsect1>
|
|
|
|
<title>Notes</title>
|
|
|
|
|
1999-07-06 19:16:42 +02:00
|
|
|
<para>
|
2003-04-15 15:25:08 +02:00
|
|
|
<productname>PostgreSQL</productname> does not have an explicit
|
|
|
|
<command>OPEN</command> cursor statement; a cursor is considered
|
2005-01-04 01:39:53 +01:00
|
|
|
open when it is declared. Use the
|
|
|
|
<xref linkend="sql-declare" endterm="sql-declare-title">
|
2003-04-15 15:25:08 +02:00
|
|
|
statement to declare a cursor.
|
1999-07-06 19:16:42 +02:00
|
|
|
</para>
|
2006-01-18 07:49:30 +01:00
|
|
|
|
|
|
|
<para>
|
|
|
|
You can see all available cursors by querying the
|
|
|
|
<structname>pg_cursors</structname> system view.
|
|
|
|
</para>
|
2003-04-15 15:25:08 +02:00
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>Examples</title>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
Close the cursor <literal>liahona</literal>:
|
|
|
|
<programlisting>
|
1998-09-16 16:43:12 +02:00
|
|
|
CLOSE liahona;
|
2003-04-15 15:25:08 +02:00
|
|
|
</programlisting>
|
|
|
|
</para>
|
1999-07-06 19:16:42 +02:00
|
|
|
</refsect1>
|
1998-05-13 07:34:00 +02:00
|
|
|
|
2003-04-15 15:25:08 +02:00
|
|
|
<refsect1>
|
|
|
|
<title>Compatibility</title>
|
1998-05-13 07:34:00 +02:00
|
|
|
|
2003-04-15 15:25:08 +02:00
|
|
|
<para>
|
2007-04-12 08:53:49 +02:00
|
|
|
<command>CLOSE</command> is fully conforming with the SQL
|
|
|
|
standard. <command>CLOSE ALL</> is a <productname>PostgreSQL</>
|
|
|
|
extension.
|
2003-04-15 15:25:08 +02:00
|
|
|
</para>
|
1998-05-13 07:34:00 +02:00
|
|
|
</refsect1>
|
2005-01-04 01:39:53 +01:00
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>See Also</title>
|
|
|
|
|
|
|
|
<simplelist type="inline">
|
|
|
|
<member><xref linkend="sql-declare" endterm="sql-declare-title"></member>
|
|
|
|
<member><xref linkend="sql-fetch" endterm="sql-fetch-title"></member>
|
|
|
|
<member><xref linkend="sql-move" endterm="sql-move-title"></member>
|
|
|
|
</simplelist>
|
|
|
|
</refsect1>
|
1999-07-06 19:16:42 +02:00
|
|
|
</refentry>
|