SPI_SCRO...SOR_FETCH(3)

πŸ“¦ version 16.15, in opensuse-leap 16.0

πŸ’– NAME πŸ’–

okay so bestie, you're reading the SPI_scroll_cursor_fetch(3) page from the PostgreSQL 16.15 docs β€” and it's literally about SPI_scroll_cursor_fetch: fetch some rows from a cursor. slay.


✨ SYNOPSIS ✨

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

πŸ¦‹ DESCRIPTION πŸ¦‹

SPI_scroll_cursor_fetch fetches some rows from a cursor. This is equivalent to the SQL command FETCH. no cap, that's the whole main-character move πŸ’…


πŸŽ€ ARGUMENTS πŸŽ€

  • Portal portal β€” the portal containing the cursor, periodt.
  • 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. that's the vibe check βœ…


🌸 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. not me warning you with love πŸ’€πŸ’–

made with love under the PostgreSQL 16.15 banner, dated 2026 β€” mwah πŸ’‹

πŸ“¦ where this page comes from