This page in other versions: 9.1 / 9.2 / 9.3 / 9.4  |  Development versions: devel / 9.5  |  Unsupported versions: 9.0



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


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


SPI_prepare_params creates and returns an execution plan 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.


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.

Privacy Policy | About PostgreSQL
Copyright © 1996-2015 The PostgreSQL Global Development Group