SPI_PREPARE_CURSOR(3) PostgreSQL 18.6 Documentation SPI_PREPARE_CURSOR(3) NAME SPI_prepare_cursor - prepare a statement, 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 bit mask having the values shown in nodes/parsenodes.h for the options field of DeclareCursorStmt. SPI_prepare always takes the cursor options as zero. This function is now deprecated in favor of SPI_prepare_extended. 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 para- meters int cursorOptions integer bit mask 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, CUR- SOR_OPT_NO_SCROLL, CURSOR_OPT_FAST_PLAN, CURSOR_OPT_GENERIC_PLAN, and CUR- SOR_OPT_CUSTOM_PLAN. Note in particular that CURSOR_OPT_HOLD is ignored. PostgreSQL 18.6 2026 SPI_PREPARE_CURSOR(3)
NAME | SYNOPSIS | DESCRIPTION | ARGUMENTS | RETURN VALUE | NOTES
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=SPI_prepare_cursor&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>