SPI_KEEPPLAN(3)

💅 SPI_KEEPPLAN(3) 💅

okay so bestie, this one is from the PostgreSQL 13.23 Documentation and it’s lowkey iconic: it’s all about saving a prepared statement so it sticks around. periodt. 🎀

🌸 NAME 🌸

SPI_keepplan — save a prepared statement. bestie, that’s literally the whole vibe of this page. ✨

🦋 SYNOPSIS 🦋

int SPI_keepplan(SPIPlanPtr plan)

💖 DESCRIPTION 💖

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. no cap. 🫶

this gives you the ability to reuse prepared statements in the subsequent invocations of your C function in the current session. it’s giving “keep the thing alive so future you can use it again” energy. 👑

🎀 ARGUMENTS 🎀

• SPIPlanPtr plan — the prepared statement to be saved.

🔥 RETURN VALUE 🔥

• 0 on success; SPI_ERROR_ARGUMENT if plan is NULL or invalid.

💜 NOTES 💜

the passed-in statement is relocated to permanent storage by means of pointer adjustment — no data copying is required. the pointer gets adjusted, and that’s the whole trick. 💅

if you later wish to delete it, use SPI_freeplan on it. don’t just leave it vibing forever unless you want to, bestie. 😭

alright, that’s the page 🫶 — source and version: PostgreSQL 13.23 Documentation, dated 2025. mwah 💋✨