SPI_SCROL...RSOR_MOVE(3)

📦
version 18.6 · 21 versions
, in alpine 3.23, alpine 3.24, arch rolling, fedora 43, fedora 44, nixos 26.05, ubuntu resolute, ubuntu stonking

💫 SPI_SCROL...RSOR_MOVE 💫

okay bestie, welcome to the PostgreSQL 18.6 docs, page SPI_SCROL...RSOR_MOVE(3). yes the name is truncated, no we're not gonna talk about it, it's giving ✨mysterious✨. anyway this is the page about SPI_scroll_cursor_move and it's lowkey so useful.

🌸 NAME 🌸

SPI_scroll_cursor_move — move a cursor 🦋

✨ 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. literally that's it, that's the whole job. it's equivalent to the SQL command MOVE. no cap 🫶

🎀 ARGUMENTS 🎀

  • Portal portal — the portal that's holding the cursor 💅
  • FetchDirection direction — one of FETCH_FORWARD, FETCH_BACKWARD, FETCH_ABSOLUTE or FETCH_RELATIVE. pick your vibe 🔥
  • long count — here's the tea, the meaning shifts depending on your direction:
    • for FETCH_FORWARD or FETCH_BACKWARD: the number of rows to move
    • for FETCH_ABSOLUTE: the absolute row number to move to
    • for FETCH_RELATIVE: the relative row number to move to

👑 RETURN VALUE 👑

if it works, SPI_processed is set as in SPI_execute. and SPI_tuptable is set to NULL, since no rows are returned by this function. it moved, it didn't bring anything back. it's a mover not a giver, iykyk 💀

🧚 NOTES 🧚

  • go read the SQL FETCH(7) command if you want the full details on how direction and count are interpreted. fr fr, it's all in there 📖
  • ⚠️ direction values other than FETCH_FORWARD may fail if the cursor's plan was not created with the CURSOR_OPT_SCROLL option. so like... check that first, bestie, don't get caught out 😭

PostgreSQL 18.6 · 2026 · SPI_SCROL...RSOR_MOVE(3)

and that's the whole page! 💜 mwah, go move some cursors, you absolute icon, and remember: scroll responsibly ✨🎀🦋

📦 where this page comes from