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

Historical version. PostgreSQL 9.3 has reached end of support. 2018-11-08. See the current manual.

SPI_prepare_params

Name

SPI_prepare_params -- prepare a statement, without executing it yet

Synopsis

SPIPlanPtr SPI_prepare_params(const char * command,
                              ParserSetupHook parserSetup,
                              void * parserSetupArg,
                              int cursorOptions)

Description

SPI_prepare_params creates and returns a prepared statement for the specified command, but doesn't execute the command. This function is equivalent to SPI_prepare_cursor, with the addition that the caller can specify parser hook functions to control the parsing of external parameter references.

Arguments

const char * command: command string
ParserSetupHook parserSetup: Parser hook setup function
void * parserSetupArg: passthrough argument for parserSetup
int cursorOptions: integer bit mask of cursor options; zero produces default behavior

Return Value

SPI_prepare_params has the same return conventions as SPI_prepare.

Report a documentation issue

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