SPI_cursor_move (3)

Leading comments

    Title: SPI_cursor_move
   Author: The PostgreSQL Global Development Group
Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
     Date: 2017
   Manual: PostgreSQL 9.6.5 Documentation
   Source: PostgreSQL 9.6.5
 Language: English

NAME

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.