SPI_CURSOR_OPEN_WITH_PARAMLIST(3pg16)

💅 SPI_CURSO...PARAMLIST(3) — the PostgreSQL 16.15 manual page, bestie 🎀

✨ NAME ✨

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 🌸

Okay so SPI_cursor_open_with_paramlist sets up a cursor — internally, a portal — that will execute a statement prepared by SPI_prepare. It's literally equivalent to SPI_cursor_open, except that the info about the parameter values you're passing 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. Slay. ✨

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. 💖

🎀 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. 🎀

Heads up, bestie: there is no error return convention here — any error will be reported via elog. 😭

💖 That's the tea: this page is from PostgreSQL 16.15, dated 2026, and it's the SPI_CURSO...PARAMLIST(3) manual page. Periodt. 🎀