---
title: "SPI_scroll_cursor_fetch"
id: spi-spi-scroll-cursor-fetch
pg_version: "20devel"
---

<a id="spi-spi-scroll-cursor-fetch"></a>

# SPI_scroll_cursor_fetch — fetch some rows from a cursor

## Synopsis

```
void SPI_scroll_cursor_fetch(Portal portal, FetchDirection direction,
                             long count)
```

<a id="id-1.8.12.8.26.5"></a>

## Description

`SPI_scroll_cursor_fetch` fetches some rows from a cursor. This is equivalent to the SQL command `FETCH`. 

<a id="id-1.8.12.8.26.6"></a>

## Arguments

**`Portal portal`**

 portal containing the cursor **`FetchDirection direction`**

 one of `FETCH_FORWARD`, `FETCH_BACKWARD`, `FETCH_ABSOLUTE` or `FETCH_RELATIVE` **`long count`**

 number of rows to fetch for `FETCH_FORWARD` or `FETCH_BACKWARD`; absolute row number to fetch for `FETCH_ABSOLUTE`; or relative row number to fetch for `FETCH_RELATIVE` <a id="id-1.8.12.8.26.7"></a>

## Return Value

`SPI_processed` and `SPI_tuptable` are set as in `SPI_execute` if successful. 

<a id="id-1.8.12.8.26.8"></a>

## Notes

See the SQL [FETCH](sql-fetch.md) command for details of the interpretation of the `direction` and `count` parameters. 

Direction values other than `FETCH_FORWARD` may fail if the cursor's plan was not created with the `CURSOR_OPT_SCROLL` option.