1999-07-22 17:09:15 +02:00
|
|
|
<!--
|
2010-09-20 22:08:53 +02:00
|
|
|
doc/src/sgml/ref/close.sgml
|
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">
|
2014-02-24 03:25:35 +01:00
|
|
|
<indexterm zone="sql-close">
|
|
|
|
<primary>CLOSE</primary>
|
|
|
|
</indexterm>
|
|
|
|
|
|
|
|
<indexterm zone="sql-close">
|
|
|
|
<primary>cursor</primary>
|
|
|
|
<secondary>CLOSE</secondary>
|
|
|
|
</indexterm>
|
|
|
|
|
1999-07-06 19:16:42 +02:00
|
|
|
<refmeta>
|
2010-04-03 09:23:02 +02:00
|
|
|
<refentrytitle>CLOSE</refentrytitle>
|
2008-11-14 11:22:48 +01:00
|
|
|
<manvolnum>7</manvolnum>
|
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
|
|
|
|
1999-07-06 19:16:42 +02:00
|
|
|
<refsynopsisdiv>
|
2003-04-15 15:25:08 +02:00
|
|
|
<synopsis>
|
2017-10-09 04:00:57 +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>
|
2010-11-23 21:27:50 +01:00
|
|
|
|
2003-04-15 15:25:08 +02:00
|
|
|
<refsect1>
|
|
|
|
<title>Parameters</title>
|
|
|
|
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
2017-10-09 04:00:57 +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
|
2010-04-03 09:23:02 +02:00
|
|
|
<xref linkend="sql-declare">
|
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>
|
2007-05-15 21:13:55 +02:00
|
|
|
You can see all available cursors by querying the <link
|
|
|
|
linkend="view-pg-cursors"><structname>pg_cursors</></> system view.
|
2006-01-18 07:49:30 +01:00
|
|
|
</para>
|
2008-05-12 18:23:26 +02:00
|
|
|
|
|
|
|
<para>
|
|
|
|
If a cursor is closed after a savepoint which is later rolled back,
|
|
|
|
the <command>CLOSE</command> is not rolled back; that is, the cursor
|
|
|
|
remains closed.
|
|
|
|
</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;
|
2011-08-07 09:49:45 +02:00
|
|
|
</programlisting></para>
|
1999-07-06 19:16:42 +02:00
|
|
|
</refsect1>
|
2010-11-23 21:27:50 +01:00
|
|
|
|
2003-04-15 15:25:08 +02:00
|
|
|
<refsect1>
|
|
|
|
<title>Compatibility</title>
|
2010-11-23 21:27:50 +01: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">
|
2010-04-03 09:23:02 +02:00
|
|
|
<member><xref linkend="sql-declare"></member>
|
|
|
|
<member><xref linkend="sql-fetch"></member>
|
|
|
|
<member><xref linkend="sql-move"></member>
|
2005-01-04 01:39:53 +01:00
|
|
|
</simplelist>
|
|
|
|
</refsect1>
|
1999-07-06 19:16:42 +02:00
|
|
|
</refentry>
|