SPI_SAVEPLAN(3)

✨ NAME ✨

SPI_saveplan — save a prepared statement 💾✨

Yes bestie, this is the SPI_SAVEPLAN(3) manual page, and we’re keeping every detail — no cap.

🌸 SYNOPSIS 🌸

SPIPlanPtr SPI_saveplan(SPIPlanPtr plan)

🦋 DESCRIPTION 🦋

Okay so SPI_saveplan copies a passed statement (prepared by SPI_prepare) into memory that will not be freed by SPI_finish nor by the transaction manager, and returns a pointer to the copied statement 🫶. Basically it gives you the ability to reuse prepared statements in the subsequent invocations of your C function in the current session. Slay.

🎀 ARGUMENTS 🎀

• SPIPlanPtr plan — the prepared statement to be saved 💾

💅 RETURN VALUE 💅

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
• SPI_ERROR_UNCONNECTED — if called from an unconnected C function

🔥 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 🫧. Not me reminding you about memory leaks — okay yes, me reminding you.

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 👑. Lowkey the better vibe here.

mwah 💋 — PostgreSQL 13.23, dated 2025, signing off from the SPI_SAVEPLAN(3) page 🫶