Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
SPI_PREPARE_PARAMS(3)	 PostgreSQL 17.5 Documentation	 SPI_PREPARE_PARAMS(3)

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.

       This function is	now deprecated in favor	of SPI_prepare_extended.

ARGUMENTS
       const char * command
	   command string

       ParserSetupHook parserSetup
	   Parser hook setup function

       void * parserSetupArg
	   pass-through	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.

PostgreSQL 17.5			     2025		 SPI_PREPARE_PARAMS(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=SPI_prepare_params&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help