SPI_cursor_move

Supported versions: Current (18) / 17 / 16 / 15 / 14

Development versions: 19 / 20devel

Unsupported versions: 13 / 12 / 11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0 / 8.4 / 8.3 / 8.2 / 8.1 / 8.0 / 7.4

Development snapshot. PostgreSQL 20devel has not been released. Content may change.

SPI_cursor_move
Prev	Up	45.1. Interface Functions	Home	Next

SPI_cursor_move — move a cursor

Synopsis

void SPI_cursor_move(Portal portal, bool forward, long count)

Description

SPI_cursor_move skips over some number of rows in a cursor. This is equivalent to a subset of the SQL command MOVE (see SPI_scroll_cursor_move for more functionality).

Arguments

Portal portal: portal containing the cursor
bool forward: true for move forward, false for move backward
long count: maximum number of rows to move

Notes

Moving backward may fail if the cursor's plan was not created with the CURSOR_OPT_SCROLL option.

Prev	Up	Next
SPI_cursor_fetch	Home	SPI_scroll_cursor_fetch

Report a documentation issue

Read the upstream documentation. For corrections, first check the current manual.