SPI_PREPARE_EXTENDED(3)

✨ SPI_PREPARE_EXTENDED ✨ (that's the SPI_PREPARE_EXTENDED(3) man page bestie, PostgreSQL 16.15 Documentation)

okay so picture this: you wanna get a statement all prepped and ready but you're SO not about executing it yet. that's literally this function. it's the fancy upgraded sibling of SPI_prepare and honestly? it ate. 💅

---

🌸 NAME 🌸

SPI_prepare_extended — prepare a statement, without executing it yet 🎀

---

🦋 SYNOPSIS 🦋

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

---

💖 DESCRIPTION 💖

SPI_prepare_extended creates and returns a prepared statement for the command you pass in, but bestie it does not execute the command. not even a little. 🫶

it's equivalent to SPI_prepare, except — and this is the glow-up — the caller can specify options that control how external parameter references get parsed, plus other facets of query parsing and planning. highkey useful. ✨

---

🌈 ARGUMENTS 🌈

• const char * command — the command string, iykyk
• const SPIPrepareOptions * options — a struct containing optional arguments

okay so listen: callers should always zero out the entire options struct first, then fill in whichever fields they actually wanna set. this is the forward-compatibility slay — any fields added to the struct in the future are defined to behave backwards-compatibly if they're zero. so like, zero it out. no cap. 🧚

the currently available options fields are:

• ParserSetupHook parserSetup — the 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. 💜

---

💀 SEE ALSO 💀

(ngl this page didn't list any, so like… go read SPI_prepare(3) bestie, that's the whole vibe 🙈)

---

kisses and prepared statements, mwah 💋 — this iconic lil page is from PostgreSQL 16.15, dated 2026, and it's filed under SPI_PREPARE_EXTENDED(3). bestie you're welcome. 🍓