FT.CURSOR READ

Read next results from an existing cursor

Examples

See [Cursor API]({{< relref "develop/ai/search-and-query/advanced-concepts/aggregations#cursor-api" >}}) for more details.

Required arguments

<details open> <summary><code>index</code></summary>

is index name.

</details> <details open> <summary><code>cursor_id</code></summary>

is id of the cursor.

</details> <details open> <summary><code>[COUNT read_size]</code></summary>

is number of results to read. This parameter overrides COUNT specified in [FT.AGGREGATE]({{< relref "commands/ft.aggregate/" >}}).

</details>

Examples

<details open> <summary><b>Read next results from a cursor</b></summary>

{{< highlight bash >}} 127.0.0.1:6379> FT.CURSOR READ idx 342459320 COUNT 50 {{< / highlight >}}

</details>

Redis Software and Redis Cloud compatibility

| Redis Software | Redis Cloud Flexible & Annual | Redis Cloud Free & Fixed | <span style="min-width: 9em; display: table-cell">Notes</span> | |:----------------------|:-----------------|:-----------------|:------| | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</nobr></span> | |

Return information

{{< multitabs id="ft-cursor-read-return-info" tab1="RESP2" tab2="RESP3" >}}

One of the following:

• [Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) with search results and metadata.
• [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: cursor not found.

-tab-sep-

One of the following:

• [Map]({{< relref "/develop/reference/protocol-spec#maps" >}}) with structured search results and metadata.
• [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: cursor not found.

{{< /multitabs >}}

See also

[FT.CURSOR DEL]({{< relref "commands/ft.cursor-del/" >}}) | [FT.AGGREGATE]({{< relref "commands/ft.aggregate/" >}})

Related topics

[RediSearch]({{< relref "/develop/ai/search-and-query/" >}})