SPI_EXECUTE_PLAN(3)

✨ SPI_EXECUTE_PLAN ✨

okay so bestie, this is the SPI_EXECUTE_PLAN(3) page from the PostgreSQL 17.11 docs, and we're literally about to make prepared-statement execution make Sense 💅 buckle up.

---

🎀 NAME 🎀

SPI_execute_plan — the one that runs a statement you already prepped with SPI_prepare. it's giving "reusing your fave fit instead of building a new one" 👑

---

🌸 SYNOPSIS 🌸

int SPI_execute_plan(SPIPlanPtr plan, Datum * values, const char * nulls,
                     bool read_only, long count)

five args, no cap. count them. 🫶

---

🦋 DESCRIPTION 🦋

k so SPI_execute_plan executes a statement that was prepared by SPI_prepare or one of its siblings (yes, it has siblings, it's a whole family situation 👯). the read_only and count params mean exactly the same thing they mean in SPI_execute — same interpretation, no plot twist, no extra lore. periodt. ⭐

---

💖 ARGUMENTS 💖

• SPIPlanPtr plan — your prepared statement, aka the thing SPI_prepare handed you back. main character energy right here 👑
• Datum * values — an array of the actual parameter values. it must be the same length as the statement's number of arguments — no short-changing, no extras, it's a vibe check and it has to match 💀
• const char * nulls — an array that says which parameters are null. also must be the same length as the statement's number of arguments.

here's the tea ☕ if nulls is NULL, then SPI_execute_plan assumes no parameters are null. otherwise, each entry of the nulls array should be ' ' when the matching parameter value is non-null, or 'n' when the matching parameter value is null. (and in that null case, whatever you stuffed in the corresponding values entry literally doesn't matter — it's irrelevant, it's not the moment 🙈.) also important: nulls is not a text string, it's just an array — so it does not need a '\0' terminator, bestie, don't add one 🎀

• bool read_only — pass true for read-only execution. simple as that ✨
• long count — maximum number of rows to return, or 0 for no limit. zero means "all of them, idc, bring the whole menu" 🍓

---

🔥 RETURN VALUE 🔥

the return value is the same as for SPI_execute — same deal, same energy — with these additional possible error (negative) results:

• SPI_ERROR_ARGUMENT — if plan is NULL or invalid, or if count is less than 0 😭
• SPI_ERROR_PARAM — if values is NULL and plan was prepared with some parameters

and if it all goes well, SPI_processed and SPI_tuptable are set just like in SPI_execute 🌈💜

---

ngl, if you're getting negative returns, check your plan first. it's almost always the plan. 🧚

---

okay that's the whole page, you ate it up fr fr 🫶 this was SPI_EXECUTE_PLAN(3) from the PostgreSQL 17.11 Documentation, dated 2026 — go forth and execute your plans, icon 💅👑