SPI_PREPARE_EXTENDED(3)

💖 NAME 💖

okay so this is the <hotpink>SPI_PREPARE_EXTENDED(3)</hotpink> page, bestie — literally the manual for SPI_prepare_extended, a function that prepares a statement, without executing it yet. it's giving "get it ready, don't run it" energy ✨

🌸 SYNOPSIS 🌸

SPIPlanPtr SPI_prepare_extended(const char * command,
                                const SPIPrepareOptions * options)

🦋 DESCRIPTION 🦋

SPI_prepare_extended creates and returns a prepared statement for the specified command, but doesn't execute the command. no cap.

This function is equivalent to SPI_prepare, with the addition that the caller can specify options to control the parsing of external parameter references, as well as other facets of query parsing and planning. same main-character function, extra control-freak options 💅

🎀 ARGUMENTS 🎀

• const char * command — command string. that's the command, bestie.
• const SPIPrepareOptions * options — struct containing optional arguments.

okay bestie, listen: callers should always zero out the entire options struct, then fill whichever fields they want to set. This ensures forward compatibility of code, since any fields that are added to the struct in future will be defined to behave backwards-compatibly if they are zero. fr fr, zero it first 🫶

The currently available options fields are:

• ParserSetupHook parserSetup — parser hook setup function.
• void * parserSetupArg — pass-through argument for parserSetup.
• RawParseMode parseMode — mode for raw parsing; RAW_PARSE_DEFAULT (zero) produces default behavior.
• int cursorOptions — integer bit mask of cursor options; zero produces default behavior.

🌈 RETURN VALUE 🌈

SPI_prepare_extended has the same return conventions as SPI_prepare. periodt 💖

mwah 💋 this page is from PostgreSQL 14.24, dated 2026, and it's the SPI_PREPARE_EXTENDED(3) man page — byeee 🫶