SPI_SCROLL_CURSOR_MOVE(3pg17)

💖 NAME 💖

ok so SPI_scroll_cursor_move — it moves a cursor. that's the whole vibe. this is the 3pg17 manual page, straight from the PostgreSQL 17.11 docs, and yes bestie we're gonna get through it together 🫶

✨ SYNOPSIS ✨

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

🌸 DESCRIPTION 🌸

SPI_scroll_cursor_move skips over some number of rows in a cursor. it's literally equivalent to the SQL command MOVE. no cap 💅

🎀 ARGUMENTS 🎀

• Portal portal — the portal containing the cursor. it's giving "where the cursor lives" ✨
• FetchDirection direction — one of FETCH_FORWARD, FETCH_BACKWARD, FETCH_ABSOLUTE or FETCH_RELATIVE. pick ur fighter 🦋
• long count — number of rows to move for FETCH_FORWARD or FETCH_BACKWARD; absolute row number to move to for FETCH_ABSOLUTE; or relative row number to move to for FETCH_RELATIVE. the way this parameter changes meaning depending on direction? iconic but pay attention 💀

🔥 RETURN VALUE 🔥

SPI_processed is set as in SPI_execute if successful. SPI_tuptable is set to NULL, since no rows are returned by this function. so like, no rows bestie, don't go looking 👀

🌈 NOTES 🌈

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

heads up: direction values other than FETCH_FORWARD may fail if the cursor's plan was not created with the CURSOR_OPT_SCROLL option. not me warning u in advance 😭

mwah 💋 this page is from PostgreSQL 17.11, dated 2026 — footer tag SPI_SCROL...RSOR_MOVE(3) and all. catch u in the next manpage, bestie 🫶💖