blob: 35f0993e6a2af81f84b9ce7682942fb2e594bfc8 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
<!--
$PostgreSQL: pgsql/doc/src/sgml/ref/close.sgml,v 1.23 2006/01/18 06:49:26 neilc 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>
<indexterm zone="sql-close">
<primary>cursor</primary>
<secondary>CLOSE</secondary>
</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
<xref linkend="sql-declare" endterm="sql-declare-title">
statement to declare a cursor.
</para>
<para>
You can see all available cursors by querying the
<structname>pg_cursors</structname> system view.
</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>
<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>
</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:
-->
|
