SPI_EXEC...PARAMLIST(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_EXEC...PARAMLIST ✨

okay bestie, welcome to the PostgreSQL 18.6 docs, page for SPI_execute_plan_with_paramlist 💖 this one lives in the SPI_EXEC...PARAMLIST(3) manual, section 3, and it's giving "I run your prepared statements but with a lil twist" energy 🎀

🌸 NAME 🌸

SPI_execute_plan_with_paramlist — execute a statement prepared by SPI_prepare 💅

🦋 SYNOPSIS 🦋

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

like look at her, four args, iconic, no notes 👑

💜 DESCRIPTION 💜

so basically SPI_execute_plan_with_paramlist runs a statement that was prepped by SPI_prepare, fr fr. This function is equivalent to SPI_execute_plan except that the info about the parameter values getting passed to the query is presented differently 🫶

the ParamListInfo representation is lowkey convenient when you already have values chillin' in that format — just hand 'em over, no conversion drama 💅

and it also supports use of dynamic parameter sets via hook functions specified in ParamListInfo ✨ which is a whole vibe.

ngl this function is now deprecated in favor of SPI_execute_plan_extended 💀 it still works but like… the newer one is the main character now. use that one bestie.

🌈 ARGUMENTS 🌈

  • SPIPlanPtr plan — your prepared statement, aka the thing that was returned by SPI_prepare 🎀
  • ParamListInfo params — the data structure holding the parameter types and values; pass NULL if there are none 🙈
  • bool read_only — true for read-only execution, so she behaves herself and doesn't write anything 💖
  • long count — the maximum number of rows to return, or 0 for no limit (go off, unlimited queen 👑)

⭐ RETURN VALUE ⭐

the return value is the same as for SPI_execute_plan — no surprises, same energy 🦋

SPI_processed and SPI_tuptable are set as in SPI_execute_plan if it succeeds ✨

mwah 💋 that's the whole page. sourced straight from the PostgreSQL 18.6 docs, dated 2026, and yeah — this is the SPI_EXEC...PARAMLIST(3) manual page, we ate and left no crumbs 🍓

📦 where this page comes from