SPI_PREPARE_PARAMS(3)

πŸ“¦ version 17.11, in opensuse-leap 16.0

πŸ’… SPI_PREPARE_PARAMS(3) β€” prepare a statement, without executing it yet

okay bestie, welcome to the SPI_PREPARE_PARAMS(3) manual page ✨ this one is all about getting a statement prepared but not executed yet β€” like getting your outfit ready but not leaving the house πŸ’–


🌸 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 it doesn't execute the command. No cap, it just prepares it and hands it back to you 🫢

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. It's giving "same vibe, but with parser-hook customization" ✨

Heads up, bestie: this function is now deprecated in favor of SPI_prepare_extended πŸ’… so it's still iconic, but it's not the main character anymore.

πŸ’œ ARGUMENTS πŸ’œ

  • const char * command β€” the command string 🧚
  • ParserSetupHook parserSetup β€” the parser hook setup function 🌸
  • void * parserSetupArg β€” the pass-through argument for parserSetup πŸŽ€
  • int cursorOptions β€” an integer bit mask of cursor options; zero produces default behavior ⭐

πŸ‘‘ RETURN VALUE πŸ‘‘

SPI_prepare_params has the same return conventions as SPI_prepare. So whatever you'd expect from SPI_prepare, that's the energy here πŸ’–


That's the whole page, bestie β€” every detail accounted for, every vibe slayed. πŸ’…βœ¨

This one comes from the PostgreSQL 17.11 Documentation, dated 2026 β€” mwah πŸ˜˜πŸ’–

πŸ“¦ where this page comes from