SPI_PREPARE_PARAMS(3)

💅 SPI_PREPARE_PARAMS(3) — prepare a statement, without executing it yet 💅

okay bestie, welcome to the SPI_PREPARE_PARAMS(3) page from the PostgreSQL 16.15 documentation. this is the “get your prepared statement ready but do not run it yet” situation — prep only, no execution, main character energy. 💖

---

🌸 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 🦋

okay so SPI_prepare_params creates and returns a prepared statement for the command you specified, but it does not execute the command. literally preparing, not performing. no cap.

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. iykyk — parser hooks are the little backstage crew here. 🎀

heads up, bestie: this function is now deprecated in favor of SPI_prepare_extended. it still exists, but the manual is lowkey saying “move on, babe.” 💅

---

🌈 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. that's the whole return-value vibe, periodt. ✨

---

xoxo, PostgreSQL 16.15 documentation, 2026 💖