SPI_SCRO...SOR_FETCH(3)

🌸 NAME 🌸

SPI_scroll_cursor_fetch — fetch some rows from a cursor. This is the SPI_SCRO...SOR_FETCH(3) page from the PostgreSQL 13.23 manual, and bestie we are getting into it.

✨ SYNOPSIS ✨

void SPI_scroll_cursor_fetch(Portal portal, FetchDirection direction,
                             long count)

💅 DESCRIPTION 💅

SPI_scroll_cursor_fetch fetches some rows from a cursor. It is literally equivalent to the SQL command FETCH. Iconic behavior, no notes.

🎀 ARGUMENTS 🎀

• Portal portal — the portal containing the cursor.
• FetchDirection direction — one of FETCH_FORWARD, FETCH_BACKWARD, FETCH_ABSOLUTE, or FETCH_RELATIVE.
• long count — number of rows to fetch for FETCH_FORWARD or FETCH_BACKWARD; absolute row number to fetch for FETCH_ABSOLUTE; or relative row number to fetch for FETCH_RELATIVE.

🫶 RETURN VALUE 🫶

SPI_processed and SPI_tuptable are set as in SPI_execute if successful.

🔥 NOTES 🔥

See the SQL FETCH(7) command for details of the interpretation of the direction and count parameters.

Heads up, bestie: direction values other than FETCH_FORWARD may fail if the cursor’s plan was not created with the CURSOR_OPT_SCROLL option. That’s the vibe check, so plan accordingly 💀

okay that’s the page — source/version/date sign-off: PostgreSQL 13.23, 2025, SPI_SCRO...SOR_FETCH(3). bye bestie 💜