FT.ALIASLIST

FT.ALIASLIST index
Available in:
Redis Open Source / search 8.10.0
Time complexity:
O(N) where N is the number of aliases
ACL categories:
@search,
Compatibility:
Redis Software and Redis Cloud compatibility

Lists all aliases for the given index.

Required arguments

index

is the name of the index for which to list aliases.

Examples

Add an alias to an index

Add an alias to an index.

> FT.ALIASADD alias idx:bicycle
OK

List the aliases for idx:bicycle

> FT.ALIASLIST idx:bicycle
1) "alias"

Redis Software and Redis Cloud compatibility

Redis
Software
Redis Cloud
Flexible & Annual
Redis Cloud
Free & Fixed
Notes
❌ Not supported ❌ Not supported ❌ Not supported

Return information

One of the following:

  • An array of bulk strings, the names of existing index aliases, or an empty array if no aliases exist.
  • A simple error when the provided index doesn't exist.
RATE THIS PAGE
Back to top ↑