--- acl_categories: - '@search' arguments: - name: index type: string categories: - docs - develop - stack - oss - rs - rc - oss - kubernetes - clients complexity: O(1) description: Dumps the contents of a synonym group group: search hidden: false linkTitle: FT.SYNDUMP module: Search railroad_diagram: /images/railroad/ft.syndump.svg since: 1.2.0 stack_path: docs/interact/search-and-query summary: Dumps the contents of a synonym group syntax_fmt: FT.SYNDUMP index title: FT.SYNDUMP --- Dump the contents of a synonym group [Examples](#examples) ## Required arguments
index is index name.
Use FT.SYNDUMP to dump the synonyms data structure. This command returns a list of synonym terms and their synonym group ids. ## Examples
Return the contents of a synonym group {{< highlight bash >}} 127.0.0.1:6379> FT.SYNDUMP idx 1) "shalom" 2) 1) "synonym1" 2) "synonym2" 3) "hi" 4) 1) "synonym1" 5) "hello" 6) 1) "synonym1" {{< / highlight >}}
## Redis Software and Redis Cloud compatibility | Redis
Software | Redis Cloud
Flexible & Annual | Redis Cloud
Free & Fixed | Notes | |:----------------------|:-----------------|:-----------------|:------| | ✅ Supported | ✅ Supported | ✅ Supported | | ## Return information {{< multitabs id="ft-syndump-return-info" tab1="RESP2" tab2="RESP3" >}} One of the following: * [Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of synonym terms and their associated synonym groups. * [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: no such index. -tab-sep- One of the following: * [Map]({{< relref "/develop/reference/protocol-spec#maps" >}}) where keys are synonym terms and values are arrays of their associated synonym groups. * [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: no such index. {{< /multitabs >}} ## See also [`FT.SYNUPDATE`]({{< relref "commands/ft.synupdate/" >}}) ## Related topics [RediSearch]({{< relref "/develop/ai/search-and-query/" >}})