Provided by: postgresql-doc-15_15.2-1_all
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. This is equivalent to the SQL command MOVE.
ARGUMENTS
Portal portal portal containing the cursor FetchDirection direction one of FETCH_FORWARD, FETCH_BACKWARD, FETCH_ABSOLUTE or FETCH_RELATIVE 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
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.
NOTES
See the SQL FETCH(7) command for details of the interpretation of the direction and count parameters. Direction values other than FETCH_FORWARD may fail if the cursor's plan was not created with the CURSOR_OPT_SCROLL option.