Supported versions: Current (18) / 17 / 16 / 15 / 14

Development versions: 19 / 20devel

Unsupported versions: 13 / 12 / 11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0 / 8.4 / 8.3

Historical version. PostgreSQL 8.3 has reached end of support. See the current manual.

SPI_prepare_cursor

Name

SPI_prepare_cursor -- prepare a plan for a command, without executing it yet

Synopsis

SPIPlanPtr SPI_prepare_cursor(const char * command, int nargs, Oid * argtypes, int cursorOptions)

Description

SPI_prepare_cursor is identical to SPI_prepare, except that it also allows specification of the planner's "cursor options" parameter. This is a bitmask having the values shown in nodes/parsenodes.h for the options field of DeclareCursorStmt. SPI_prepare always takes these options as zero.

Arguments

const char * command: command string
int nargs: number of input parameters ($1, $2, etc.)
Oid * argtypes: pointer to an array containing the OIDs of the data types of the parameters
int cursorOptions: integer bitmask of cursor options; zero produces default behavior

Return Value

SPI_prepare_cursor has the same return conventions as SPI_prepare.

Notes

Useful bits to set in cursorOptions include CURSOR_OPT_SCROLL, CURSOR_OPT_NO_SCROLL, and CURSOR_OPT_FAST_PLAN. Note in particular that CURSOR_OPT_HOLD is ignored.

Report a documentation issue

Read the upstream documentation. For corrections, first check the current manual.