From 5e45211a64149b3c659b90ff2de6fa982a5a93ed Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sat, 4 May 2024 14:17:33 +0200 Subject: Adding upstream version 15.5. Signed-off-by: Daniel Baumann --- doc/src/sgml/html/spi-spi-prepare-cursor.html | 35 +++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 doc/src/sgml/html/spi-spi-prepare-cursor.html (limited to 'doc/src/sgml/html/spi-spi-prepare-cursor.html') diff --git a/doc/src/sgml/html/spi-spi-prepare-cursor.html b/doc/src/sgml/html/spi-spi-prepare-cursor.html new file mode 100644 index 0000000..9975f88 --- /dev/null +++ b/doc/src/sgml/html/spi-spi-prepare-cursor.html @@ -0,0 +1,35 @@ + +SPI_prepare_cursor
SPI_prepare_cursor
Prev Up47.1. Interface FunctionsHome Next

SPI_prepare_cursor

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 parameters +

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, + CURSOR_OPT_NO_SCROLL, + CURSOR_OPT_FAST_PLAN, + CURSOR_OPT_GENERIC_PLAN, and + CURSOR_OPT_CUSTOM_PLAN. Note in particular that + CURSOR_OPT_HOLD is ignored. +

Prev Up Next
SPI_prepare Home SPI_prepare_extended
\ No newline at end of file -- cgit v1.2.3