SPI_KEEPPLAN(3)

📦
version 18.6 · 21 versions
, in alpine 3.23, alpine 3.24, arch rolling, fedora 43, fedora 44, nixos 26.05, ubuntu resolute, ubuntu stonking

💖 SPI_KEEPPLAN(3) 💖

okay bestie, welcome to the SPI_keepplan page, straight out of the PostgreSQL 18.6 Documentation ✨ this one's a lil C-level gem, and honestly? it's giving forever-statement energy 💅

🌸 NAME 🌸

SPI_keepplan — save a prepared statement 🫶

✨ SYNOPSIS ✨

int SPI_keepplan(SPIPlanPtr plan)

🦋 DESCRIPTION 🦋

so here's the tea, bestie ☕ SPI_keepplan saves a passed statement — one that was prepared by SPI_prepare — so that it will not be freed by SPI_finish nor by the transaction manager. 😤 like, it's protected. it's safe. it's untouchable.

and why do we care?? because this gives you the ability to reuse prepared statements in the subsequent invocations of your C function in the current session. 🎀 it's literally the "keep it for later" button and the way that it just... persists?? obsessed. ✨

💅 ARGUMENTS 💅

  • SPIPlanPtr plan — the prepared statement to be saved 🥰 that's it, that's the whole argument, she's simple and she slays

👑 RETURN VALUE 👑

  • 0 on success 🎉 yay!
  • SPI_ERROR_ARGUMENT if plan is NULL or invalid 💀 yeah no, that one's not cute

🌈 NOTES 🌈

ngl this part is kinda iconic 🔥 the passed-in statement is relocated to permanent storage by means of pointer adjustment — and no data copying is required. zero copying. none. the pointer just... moves. main character energy fr fr 💫

and if you later wish to delete it, use SPI_freeplan on it 🧹 because everything that stays forever eventually needs a lil cleanup, iykyk

and that's the whole page, bestie!! 🌸 this was PostgreSQL 18.6, dated 2026, and you just read the SPI_KEEPPLAN(3) manual page 💖 go keep those plans, periodt 💅✨

📦 where this page comes from