Back to Redis

Commands

content/operate/oss_and_stack/stack-with-enterprise/search/commands.md

latest8.3 KB
Original Source

The following table lists search and query commands. See the command links for more information about each command's syntax, arguments, and examples.

| Command | Redis Software | Redis Cloud Flexible & Annual | Redis Cloud Free & Fixed | Description | |:--------|:----------------------|:-----------------|:-----------------|:------| | [FT.AGGREGATE]({{< relref "commands/ft.aggregate" >}}) | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</nobr></span> | Runs a search query on an index and groups, sorts, transforms, limits, and/or filters the results. | | [FT.ALIASADD]({{< relref "commands/ft.aliasadd" >}}) | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</nobr></span> | Adds an alias to an index. | | [FT.ALIASDEL]({{< relref "commands/ft.aliasdel" >}}) | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</nobr></span> | Removes an alias from an index. | | [FT.ALIASUPDATE]({{< relref "commands/ft.aliasupdate" >}}) | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</nobr></span> | Adds an alias to an index. If the alias already exists for a different index, it updates the alias to point to the specified index instead. | | [FT.ALTER]({{< relref "commands/ft.alter" >}}) | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</nobr></span> | Adds a new field to an index. | | [FT.CONFIG GET]({{< relref "commands/ft.config-get" >}}) | <span title="Not supported"><nobr>❌ Not supported</span> | <span title="Not supported"><nobr>⚠️ Not supported</span><sup>2</sup> | <span title="Not supported"><nobr>❌ Not supported</nobr></span> | Displays configuration options. | | [FT.CONFIG HELP]({{< relref "commands/ft.config-help" >}}) | <span title="Not supported"><nobr>❌ Not supported</span> | <span title="Not supported"><nobr>❌ Not supported</span> | <span title="Not supported"><nobr>❌ Not supported</nobr></span> | Describes configuration options. | | [FT.CONFIG SET]({{< relref "commands/ft.config-set" >}}) | <span title="Not supported"><nobr>⚠️ Not supported</span><sup>1</sup> | <span title="Not supported"><nobr>⚠️ Not supported</span><sup>2</sup> | <span title="Not supported"><nobr>❌ Not supported</nobr></span> | Sets configuration options. | | [FT.CREATE]({{< relref "commands/ft.create" >}}) | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</nobr></span> | Creates an index. | | [FT.CURSOR DEL]({{< relref "commands/ft.cursor-del" >}}) | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</nobr></span> | Deletes a cursor. | | [FT.CURSOR READ]({{< relref "commands/ft.cursor-read/" >}}) | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</nobr></span> | Reads the next results from an existing cursor. | | [FT.DICTADD]({{< relref "commands/ft.dictadd" >}}) | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</nobr></span> | Adds terms to a dictionary. | | [FT.DICTDEL]({{< relref "commands/ft.dictdel" >}}) | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</nobr></span> | Deletes terms from a dictionary. | | [FT.DICTDUMP]({{< relref "commands/ft.dictdump" >}}) | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</nobr></span> | Returns all terms in the specified dictionary. | | [FT.DROPINDEX]({{< relref "commands/ft.dropindex" >}}) | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</nobr></span> | Deletes an index. | | [FT.EXPLAIN]({{< relref "commands/ft.explain" >}}) | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</nobr></span> | Returns the execution plan for a complex query as a string. | | [FT.EXPLAINCLI]({{< relref "commands/ft.explaincli" >}}) | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</nobr></span> | Returns the execution plan for a complex query as an [array]({{< relref "develop/reference/protocol-spec/#arrays" >}}). | | [FT.HYBRID]({{< relref "commands/ft.hybrid" >}}) | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</nobr></span> | Performs hybrid search combining text search and vector similarity with configurable fusion methods. | | [FT.INFO]({{< relref "commands/ft.info" >}}) | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</nobr></span> | Returns index information and statistics. | | [FT._LIST]({{< relref "commands/ft._list" >}}) | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</nobr></span> | Lists all indexes. | | [FT.PROFILE]({{< relref "commands/ft.profile" >}}) | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</nobr></span> | Runs [FT.SEARCH]({{< relref "commands/ft.search" >}}) or [FT.AGGREGATE]({{< relref "commands/ft.aggregate" >}}) and reports performance information. | | [FT.SEARCH]({{< relref "commands/ft.search" >}}) | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</nobr></span> | Searches an index for a text query and returns matching documents or document IDs. | | [FT.SPELLCHECK]({{< relref "commands/ft.spellcheck" >}}) | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</nobr></span> | Suggests spelling corrections for misspelled terms in a query. | | [FT.SYNDUMP]({{< relref "commands/ft.syndump" >}}) | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</nobr></span> | Returns a list of synonym terms and their synonym group IDs. | | [FT.SYNUPDATE]({{< relref "commands/ft.synupdate" >}}) | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</nobr></span> | Creates or updates a synonym group with additional terms. | | [FT.TAGVALS]({{< relref "commands/ft.tagvals" >}}) | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</nobr></span> | Returns all distinct values indexed in a tag field. |

  1. <a name="table-note-1" style="display: block; height: 80px; margin-top: -80px;"></a>Use [rladmin]({{< relref "/operate/rs/references/cli-utilities/rladmin" >}}) or the [REST API]({{< relref "/operate/rs/references/rest-api" >}}) to change search and query configuration for Redis Software. See [search and query configuration compatibility with Redis Software]({{< relref "/operate/oss_and_stack/stack-with-enterprise/search/config" >}}) for more information and examples.

  2. <a name="table-note-2" style="display: block; height: 80px; margin-top: -80px;"></a>Contact support to view the current configuration values or request configuration changes for Flexible or Annual Redis Cloud subscriptions.