Skip to main content

FT.SYNUPDATE

Syntax

FT.SYNUPDATE index synonym_group_id 
[SKIPINITIALSCAN] term [term ...]

Time complexity: O(N)

Description

Creates or updates a synonym group with additional terms. By default, the command triggers a scan of all documents.

Required arguments

index

is index name. You must first create the index using the FT.CREATE command.

synonym_group_id

is the identifier of the synonym group to create or update.

term [term ...]

one or more terms to be added to the synonym group.

Optional arguments

SKIPINITIALSCAN

This argument is not supported in Dragonfly and is silently ignored.

note

SKIPINITIALSCAN is included for compatibility with Redis, but has no effect in Dragonfly.

Return

FT.SYNUPDATE returns a simple string reply OK if executed correctly, or an error reply otherwise.

Examples

Update a synonym group
dragonfly> FT.SYNUPDATE idx synonym hello hi shalom
OK
dragonfly> FT.SYNUPDATE idx synonym SKIPINITIALSCAN hello hi shalom
OK

See also

FT.SYNDUMP