SPI_CURSOR_OPEN_WITH_PARAMLIST(3pg14)

🎀 NAME 🎀

okay so bestie, welcome to the SPI_cursor_open_with_paramlist page — manual section 3pg14 — and it’s literally giving “cursor setup, but make it parameter-list flavored” 💅✨

SPI_cursor_open_with_paramlist — set up a cursor using parameters 🦋

✨ SYNOPSIS ✨

       Portal SPI_cursor_open_with_paramlist(const char *name,
                                             SPIPlanPtr plan,
                                             ParamListInfo params,
                                             bool read_only)

💖 DESCRIPTION 💖

so SPI_cursor_open_with_paramlist sets up a cursor — internally, a portal — that will execute a statement prepared by SPI_prepare. it’s equivalent to SPI_cursor_open except that the 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 🫶

the passed-in parameter data will be copied into the cursor’s portal, so it can be freed while the cursor still exists. no cap, that’s the vibe 💅

🌸 ARGUMENTS 🌸

• const char * name — name for portal, or NULL to let the system select a name 🎀
• 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 ✅

👑 RETURN VALUE 👑

Pointer to portal containing the cursor. note there is no error return convention; any error will be reported via elog 💀✨

mwah 💖 — this page is from PostgreSQL 14.24 and dated 2026, so take that cursor energy and slay, bestie 🫶💅🌈