1SPI_SCROLL_CURSOR_MOVE(3)PostgreSQL 16.1 DocumentationSPI_SCROLL_CURSOR_MOVE(3)
2
3
4

NAME

6       SPI_scroll_cursor_move - move a cursor
7

SYNOPSIS

9       void SPI_scroll_cursor_move(Portal portal, FetchDirection direction,
10                                   long count)
11

DESCRIPTION

13       SPI_scroll_cursor_move skips over some number of rows in a cursor. This
14       is equivalent to the SQL command MOVE.
15

ARGUMENTS

17       Portal portal
18           portal containing the cursor
19
20       FetchDirection direction
21           one of FETCH_FORWARD, FETCH_BACKWARD, FETCH_ABSOLUTE or
22           FETCH_RELATIVE
23
24       long count
25           number of rows to move for FETCH_FORWARD or FETCH_BACKWARD;
26           absolute row number to move to for FETCH_ABSOLUTE; or relative row
27           number to move to for FETCH_RELATIVE
28

RETURN VALUE

30       SPI_processed is set as in SPI_execute if successful.  SPI_tuptable is
31       set to NULL, since no rows are returned by this function.
32

NOTES

34       See the SQL FETCH(7) command for details of the interpretation of the
35       direction and count parameters.
36
37       Direction values other than FETCH_FORWARD may fail if the cursor's plan
38       was not created with the CURSOR_OPT_SCROLL option.
39
40
41
42PostgreSQL 16.1                      2023            SPI_SCROLL_CURSOR_MOVE(3)
Impressum