SPI_PREPARE_PARAMS(3)

💖 NAME 💖

Okay so welcome to the SPI_PREPARE_PARAMS(3) page, bestie! This one is all about SPI_prepare_params — and what it does is prepare a statement, without executing it yet. Literally prepping it, not running it. 💅

✨ 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. No cap, it just gets it ready. 🎀

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. That's the extra little sparkle. ✨

Big heads-up, bestie: this function is now deprecated in favor of SPI_prepare_extended. The docs said it, not me. 💀

🫶 ARGUMENTS 🫶

• const char * command — command string. Literally the command string, bestie.
• 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 return vibe check. 🫶

Later, bestie! 💋 This page is from PostgreSQL 14.24 documentation, dated 2026. Mwah. 🎀