aboutsummaryrefslogtreecommitdiff
path: root/doc/src/sgml/ref/close.sgml
blob: e82bb4d90ed2ede9f03eb85bff09ab5f9832243a (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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/close.sgml,v 1.13 2002/05/18 15:44:47 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>
 <refsynopsisdiv>
  <refsynopsisdivinfo>
   <date>1999-07-20</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 CURSOR
       </computeroutput></term>
      <listitem>
       <para>
	Message returned if the cursor is successfully closed.
       </para>
      </listitem>
     </varlistentry>
     <varlistentry>
      <term><computeroutput>
WARNING:  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>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>
  </refsect2>
 </refsect1>

 <refsect1 id="R1-SQL-CLOSE-2">
  <title>
   Usage
  </title>
  <para>
   Close the cursor <literal>liahona</literal>:
  </para>
  <programlisting>
CLOSE liahona;
  </programlisting>
 </refsect1>
 
 <refsect1 id="R1-SQL-CLOSE-3">
  <title>
   Compatibility
  </title>
  
  <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:
-->