SPI_cursor_move

Name

SPI_cursor_move -- move a cursor

Synopsis

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

Description

Note: At present, this section is just taken from PostgreSQL documentation and is subject to revision for Postgres-XC.

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

Note: At present, this section is just taken from PostgreSQL documentation and is subject to revision for Postgres-XC.

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

Note: At present, this section is just taken from PostgreSQL documentation and is subject to revision for Postgres-XC.

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