Redis Search commands

Lists Redis Search commands and provides links to the command reference pages.

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

Command Redis Software Redis Software
Flex		 Redis Cloud
Flexible & Annual		 Redis Cloud
Free & Fixed		 Description
FT.AGGREGATE ✅ Supported ⚠️ Limited3 ✅ Supported ✅ Supported Runs a search query on an index and groups, sorts, transforms, limits, and/or filters the results.
FT.ALIASADD ✅ Supported ✅ Supported ✅ Supported ✅ Supported Adds an alias to an index.
FT.ALIASDEL ✅ Supported ✅ Supported ✅ Supported ✅ Supported Removes an alias from an index.
FT.ALIASLIST ❌ Not supported ❌ Not supported ❌ Not supported ❌ Not supported List aliases for an index.
FT.ALIASUPDATE ✅ Supported ✅ Supported ✅ Supported ✅ Supported 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 ✅ Supported ❌ Not supported ✅ Supported ✅ Supported Adds a new field to an index.
FT.CONFIG GET ❌ Not supported ❌ Not supported ⚠️ Not supported2 ❌ Not supported Displays configuration options.
FT.CONFIG HELP ❌ Not supported ❌ Not supported ❌ Not supported ❌ Not supported Describes configuration options.
FT.CONFIG SET ⚠️ Not supported1 ⚠️ Not supported1 ⚠️ Not supported2 ❌ Not supported Sets configuration options.
FT.CREATE ✅ Supported ⚠️ Limited3 ✅ Supported ✅ Supported Creates an index.
FT.CURSOR DEL ✅ Supported ❌ Not supported ✅ Supported ✅ Supported Deletes a cursor.
FT.CURSOR READ ✅ Supported ❌ Not supported ✅ Supported ✅ Supported Reads the next results from an existing cursor.
FT.DICTADD ✅ Supported ❌ Not supported ✅ Supported ✅ Supported Adds terms to a dictionary.
FT.DICTDEL ✅ Supported ❌ Not supported ✅ Supported ✅ Supported Deletes terms from a dictionary.
FT.DICTDUMP ✅ Supported ❌ Not supported ✅ Supported ✅ Supported Returns all terms in the specified dictionary.
FT.DROPINDEX ✅ Supported ⚠️ Limited3 ✅ Supported ✅ Supported Deletes an index.
FT.EXPLAIN ✅ Supported ✅ Supported ✅ Supported ✅ Supported Returns the execution plan for a complex query as a string.
FT.EXPLAINCLI ✅ Supported ✅ Supported ✅ Supported ✅ Supported Returns the execution plan for a complex query as an array.
FT.HYBRID ✅ Supported ❌ Not supported ✅ Supported ✅ Supported Performs hybrid search combining text search and vector similarity with configurable fusion methods.
FT.INFO ✅ Supported ⚠️ Limited3 ✅ Supported ✅ Supported Returns index information and statistics.
FT._LIST ✅ Supported ✅ Supported ✅ Supported ✅ Supported Lists all indexes.
FT.PROFILE ✅ Supported ✅ Supported ✅ Supported ✅ Supported Runs FT.SEARCH or FT.AGGREGATE and reports performance information.
FT.SEARCH ✅ Supported ✅ Supported ✅ Supported ✅ Supported Searches an index for a text query and returns matching documents or document IDs.
FT.SPELLCHECK ✅ Supported ❌ Not supported ✅ Supported ✅ Supported Suggests spelling corrections for misspelled terms in a query.
FT.SYNDUMP ✅ Supported ❌ Not supported ✅ Supported ✅ Supported Returns a list of synonym terms and their synonym group IDs.
FT.SYNUPDATE ✅ Supported ❌ Not supported ✅ Supported ✅ Supported Creates or updates a synonym group with additional terms.
FT.TAGVALS ✅ Supported ❌ Not supported ✅ Supported ✅ Supported Returns all distinct values indexed in a tag field.

  1. Use rladmin or the REST API to change Redis Search configuration for Redis Software. See Redis Search configuration compatibility with Redis Software for more information and examples.

  2. Contact support to view the current configuration values or request configuration changes for Flexible or Annual Redis Cloud subscriptions.

  3. Redis Search on Flex databases supports this command with limitations.

RATE THIS PAGE
Back to top ↑