CLOSE

Name

CLOSE -- close a cursor

Synopsis

CLOSE cursor

Description

CLOSE 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.

Every non-holdable open cursor is implicitly closed when a transaction is terminated by COMMIT or ROLLBACK. Holdable cursors are implicitely closed if the transaction that created them aborts via ROLLBACK; if this does not happen, the holdable cursor remains open until an explicit CLOSE is executed, or the client disconnects.

Parameters

cursor

The name of an open cursor to close.

Diagnostics

CLOSE CURSOR

Message returned if the cursor is successfully closed.

ERROR: cursor "cursor" does not exist

Message returned if cursor is not declared or has already been closed.

Notes

PostgreSQL does not have an explicit OPEN cursor statement; a cursor is considered open when it is declared. Use the DECLARE statement to declare a cursor.

Examples

Close the cursor liahona:

CLOSE liahona;

Compatibility

CLOSE is fully conforming with the SQL standard.