1SPI_SCROLL_CURSOR_FETCH(3)PostgreSQL 15.4 DocumentatioSnPI_SCROLL_CURSOR_FETCH(3)
2
3
4

NAME

6       SPI_scroll_cursor_fetch - fetch some rows from a cursor
7

SYNOPSIS

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

DESCRIPTION

13       SPI_scroll_cursor_fetch fetches some rows from a cursor. This is
14       equivalent to the SQL command FETCH.
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 fetch for FETCH_FORWARD or FETCH_BACKWARD;
26           absolute row number to fetch for FETCH_ABSOLUTE; or relative row
27           number to fetch for FETCH_RELATIVE
28

RETURN VALUE

30       SPI_processed and SPI_tuptable are set as in SPI_execute if successful.
31

NOTES

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