--- acl_categories: - '@read' - '@search' arguments: - name: index type: string - name: cursor_id type: integer - name: read size optional: true token: COUNT type: integer categories: - docs - develop - stack - oss - rs - rc - oss - kubernetes - clients complexity: O(1) description: Reads from a cursor group: search hidden: false linkTitle: FT.CURSOR READ module: Search railroad_diagram: /images/railroad/ft.cursor-read.svg since: 1.1.0 stack_path: docs/interact/search-and-query summary: Reads from a cursor syntax_fmt: "FT.CURSOR READ index cursor_id [COUNT\_read size]" title: FT.CURSOR READ --- Read next results from an existing cursor [Examples](#examples) See [Cursor API]({{< relref "develop/ai/search-and-query/advanced-concepts/aggregations#cursor-api" >}}) for more details. ## Required arguments
index is index name.
cursor_id is id of the cursor.
[COUNT read_size] is number of results to read. This parameter overrides `COUNT` specified in [`FT.AGGREGATE`]({{< relref "commands/ft.aggregate/" >}}).
## Examples
Read next results from a cursor {{< highlight bash >}} 127.0.0.1:6379> FT.CURSOR READ idx 342459320 COUNT 50 {{< / highlight >}}
## Redis Software and Redis Cloud compatibility | Redis
Software | Redis Cloud
Flexible & Annual | Redis Cloud
Free & Fixed | Notes | |:----------------------|:-----------------|:-----------------|:------| | ✅ Supported | ✅ Supported | ✅ Supported | | ## 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/" >}})