SPI_SCRO...SOR_FETCH(3)

🌸 NAME 🌸

okay bestie, this is the SPI_SCRO...SOR_FETCH(3) page from the PostgreSQL 15.19 docs. the function is SPI_scroll_cursor_fetch — it fetches some rows from a cursor. that's it, that's the job 💅.

✨ SYNOPSIS ✨

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

💅 DESCRIPTION 💅

SPI_scroll_cursor_fetch fetches some rows from a cursor. it's literally equivalent to the SQL command FETCH — same energy, different API. no cap 🫶.

🎀 ARGUMENTS 🎀

• Portal portal — the portal containing the cursor. that's your cursor's home base 🏠
• FetchDirection direction — one of FETCH_FORWARD, FETCH_BACKWARD, FETCH_ABSOLUTE or FETCH_RELATIVE. pick your fighter ✨
• 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. yes, the meaning shifts depending on direction, so read the room bestie 👀

🔥 RETURN VALUE 🔥

if it succeeds, SPI_processed and SPI_tuptable are set as in SPI_execute. that's the whole return-value tea ☕✨

🦋 NOTES 🦋

for the full deets on how the direction and count parameters are interpreted, see the SQL FETCH(7) command. iykyk 📖

⚠️ 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 a real caveat, not a vibe — don't sleep on it 💀

mwah 💋 that's the whole page — source/version: PostgreSQL 15.19, date: 2026, manual name: SPI_SCRO...SOR_FETCH(3). byeee 🫶👑