ContextQMD
Back to Redis

FT.CURSOR DEL

content/commands/ft.cursor-del.md

latest1.8 KB
Original Source

Delete a cursor

Examples

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>

Examples

<details open> <summary><b>Delete a cursor</b></summary>

{{< highlight bash >}} redis> FT.CURSOR DEL idx 342459320 OK {{< / highlight >}}

Check that the cursor is deleted.

{{< highlight bash >}} 127.0.0.1:6379> FT.CURSOR DEL idx 342459320 (error) Cursor does not exist {{< / 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-del-return-info" tab1="RESP2" tab2="RESP3" >}}

One of the following:

  • [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}): OK if executed correctly.
  • [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: cursor does not exist.

-tab-sep-

One of the following:

  • [Simple string reply]({{< relref "/develop/reference/protocol-spec#simple-strings" >}}): OK if executed correctly.
  • [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: cursor does not exist.

{{< /multitabs >}}

See also

[FT.CURSOR READ]({{< relref "commands/ft.cursor-read/" >}})

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