SPI_EXEC...PARAMLIST(3)

✨ NAME ✨

okay bestie, welcome to the SPI_EXEC...PARAMLIST(3) page from the PostgreSQL 15.19 Documentation 💖 this is the manual for SPI_execute_plan_with_paramlist — the function that executes a statement prepared by SPI_prepare. periodt 💅

🌸 SYNOPSIS 🌸

int SPI_execute_plan_with_paramlist(SPIPlanPtr plan,
                                    ParamListInfo params,
                                    bool read_only,
                                    long count)

🦋 DESCRIPTION 🦋

SPI_execute_plan_with_paramlist executes a statement prepared by SPI_prepare. It is equivalent to SPI_execute_plan, except that info about the parameter values to be passed to the query is presented differently. The ParamListInfo representation can be convenient for passing down values that are already available in that format. It also supports use of dynamic parameter sets via hook functions specified in ParamListInfo. iconic behavior, honestly 👑

⚠️ bestie, heads up: this function is now deprecated in favor of SPI_execute_plan_extended. not me being deprecated 💀

🎀 ARGUMENTS 🎀

• SPIPlanPtr plan — prepared statement (returned by SPI_prepare) ✨
• ParamListInfo params — data structure containing parameter types and values; NULL if none 🫶
• bool read_only — true for read-only execution 🌈
• long count — maximum number of rows to return, or 0 for no limit 🍓

👑 RETURN VALUE 👑

The return value is the same as for SPI_execute_plan.

SPI_processed and SPI_tuptable are set as in SPI_execute_plan if successful. no cap, that's literally the whole vibe 💜

mwah 💋 — this page is from PostgreSQL 15.19, dated 2026. go slay your prepared statements, bestie 🫶✨