FT.SYNUPDATE
- Available in:
- Redis Stack / Search 1.2.0
- Time complexity:
- O(1)
Update a synonym group
Syntax
FT.SYNUPDATE index synonym_group_id
[SKIPINITIALSCAN] term [term ...]
Required parameters
index
is index name.
synonym_group_id
is synonym group to return.
Use FT.SYNUPDATE to create or update a synonym group with additional terms. The command triggers a scan of all documents.
Optional parameters
SKIPINITIALSCAN
does not scan and index, and only documents that are indexed after the update are affected.
Return
FT.SYNUPDATE returns a simple string reply OK
if executed correctly, or an error reply otherwise.
Examples
Update a synonym group
127.0.0.1:6379> FT.SYNUPDATE idx synonym hello hi shalom
OK
127.0.0.1:6379> FT.SYNUPDATE idx synonym SKIPINITIALSCAN hello hi shalom
OK
See also
Related topics
Feedback
If you've found issues on this page, or have suggestions for improvement, please submit a request to merge or open an issue in the repository.