]> begriffs open source - ai-pg/blob - full-docs/txt/sql-close.txt
Convert HTML docs to more streamlined TXT
[ai-pg] / full-docs / txt / sql-close.txt
1
2 CLOSE
3
4    CLOSE — close a cursor
5
6 Synopsis
7
8 CLOSE { name | ALL }
9
10 Description
11
12    CLOSE frees the resources associated with an open cursor. After the
13    cursor is closed, no subsequent operations are allowed on it. A cursor
14    should be closed when it is no longer needed.
15
16    Every non-holdable open cursor is implicitly closed when a transaction
17    is terminated by COMMIT or ROLLBACK. A holdable cursor is implicitly
18    closed if the transaction that created it aborts via ROLLBACK. If the
19    creating transaction successfully commits, the holdable cursor remains
20    open until an explicit CLOSE is executed, or the client disconnects.
21
22 Parameters
23
24    name
25           The name of an open cursor to close.
26
27    ALL
28           Close all open cursors.
29
30 Notes
31
32    PostgreSQL does not have an explicit OPEN cursor statement; a cursor is
33    considered open when it is declared. Use the DECLARE statement to
34    declare a cursor.
35
36    You can see all available cursors by querying the pg_cursors system
37    view.
38
39    If a cursor is closed after a savepoint which is later rolled back, the
40    CLOSE is not rolled back; that is, the cursor remains closed.
41
42 Examples
43
44    Close the cursor liahona:
45 CLOSE liahona;
46
47 Compatibility
48
49    CLOSE is fully conforming with the SQL standard. CLOSE ALL is a
50    PostgreSQL extension.
51
52 See Also
53
54    DECLARE, FETCH, MOVE