1SPI_PREPARE_PARAMS(3)    PostgreSQL 13.4 Documentation   SPI_PREPARE_PARAMS(3)
2
3
4

NAME

6       SPI_prepare_params - prepare a statement, without executing it yet
7

SYNOPSIS

9       SPIPlanPtr SPI_prepare_params(const char * command,
10                                     ParserSetupHook parserSetup,
11                                     void * parserSetupArg,
12                                     int cursorOptions)
13

DESCRIPTION

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

ARGUMENTS

22       const char * command
23           command string
24
25       ParserSetupHook parserSetup
26           Parser hook setup function
27
28       void * parserSetupArg
29           pass-through argument for parserSetup
30
31       int cursorOptions
32           integer bit mask of cursor options; zero produces default behavior
33

RETURN VALUE

35       SPI_prepare_params has the same return conventions as SPI_prepare.
36
37
38
39PostgreSQL 13.4                      2021                SPI_PREPARE_PARAMS(3)