SPI_CURSOR_OPEN_WITH_PARAMLIST(3pg13)

💅 SPI_CURSOR_OPEN_WITH_PARAMLIST(3) — PostgreSQL 13.23 Documentation

okay so bestie, this is the page for SPI_cursor_open_with_paramlist from the PostgreSQL 13.23 docs ✨ buckle up, it's actually so good 🫶

---

🌸 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)

look at her. four arguments. main character energy fr fr 👑

---

🦋 DESCRIPTION 🦋

okay so SPI_cursor_open_with_paramlist sets up a cursor — internally that's a portal, yes the cool kids call it a portal 💅 — and that cursor will execute a statement you already prepped with SPI_prepare.

Here's the tea: this function is equivalent to SPI_cursor_open, except the info about the parameter values you're passing to the query is presented differently. That's it, that's the whole difference. Not me explaining it twice 🙈

So why would you reach for this one? Because the ParamListInfo representation can be convenient when the values you want to pass down are already chillin' in that format. No conversion era needed. It also supports use of dynamic parameter sets via hook functions specified in ParamListInfo — iykyk ⭐

And this part matters, so listen up: the passed-in parameter data will be copied into the cursor's portal, so you can free it while the cursor still exists. Go ahead, free it, she's got her own copy now 💖

---

🎀 ARGUMENTS 🎀

• const char * name — name for the portal, or NULL to let the system select a name for you (letting the system pick is so valid of you)
• SPIPlanPtr plan — the prepared statement (the one returned by SPI_prepare)
• ParamListInfo params — data structure containing parameter types and values; NULL if there aren't any
• bool read_only — true for read-only execution 🧚

---

🔥 RETURN VALUE 🔥

Pointer to the portal containing the cursor. 🫶

heads up bestie: there is no error return convention here. Any error gets reported via elog. So don't go checking a return value for failure, that's not the vibe 💀

---

🌈 SEE ALSO 🌈

lowkey there's nothing listed here in this page, so go off and read the rest of the SPI docs yourself, you've got this 😭💜

---

sign-off szn 🎀 — this little icon was brought to you by PostgreSQL 13.23, dated 2025. slay, bye bestie! 🦋🌸✨