1SPI_PREPARE_PARAMS(3)    PostgreSQL 14.3 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
21       This function is now deprecated in favor of SPI_prepare_extended.
22

ARGUMENTS

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

RETURN VALUE

37       SPI_prepare_params has the same return conventions as SPI_prepare.
38
39
40
41PostgreSQL 14.3                      2022                SPI_PREPARE_PARAMS(3)