SPI_SAVEPLAN(3)

💖 SPI_SAVEPLAN(3) 💖

okay so bestie, this is the SPI_saveplan page from the PostgreSQL 15.19 Documentation, and it's giving “save your prepared statement so future-you can use it again” energy. No cap, let's get into it. 🎀

✨ NAME ✨

SPI_saveplan — save a prepared statement. Literally the whole gig. 💅

🌸 SYNOPSIS 🌸

SPIPlanPtr SPI_saveplan(SPIPlanPtr plan)

🦋 DESCRIPTION 🦋

Okay so SPI_saveplan copies a statement you passed in — one that was prepared by SPI_prepare — into memory that will not be freed by SPI_finish nor by the transaction manager, and then it returns a pointer to the copied statement. The way this is lowkey iconic? It gives you the ability to reuse prepared statements in the subsequent invocations of your C function in the current session. Reuse era fr fr. ✨

💅 ARGUMENTS 💅

• SPIPlanPtr plan — the prepared statement to be saved. That's the one, bestie. 🫶

🔥 RETURN VALUE 🔥

A pointer to the copied statement; or NULL if unsuccessful. On error, SPI_result is set thus:

• SPI_ERROR_ARGUMENT — if plan is NULL or invalid. Not valid? Not today. 💀
• SPI_ERROR_UNCONNECTED — if called from an unconnected C function. Ma'am, connect first. 😭

👑 NOTES 👑

• The originally passed-in statement is not freed, so you might wish to do SPI_freeplan on it to avoid leaking memory until SPI_finish. Memory leak vibes? We don't claim them. 🙈
• In most cases, SPI_keepplan is preferred to this function, since it accomplishes largely the same result without needing to physically copy the prepared statement's data structures. So like, check that one first, iykyk. 💜

and that's the whole page, bestie — cute sign-off time: this was from PostgreSQL 15.19, dated 2026. Mwah, go save those plans responsibly. 🧚‍♀️💖