Download documentation

Choose the products and versions you want. Everything arrives as one .tar.gz, with a directory per product.

Format

This page

	Products	Version
	Develop with Redis Clients, data types, programmability, and Redis for AI. RedisVL is listed separately.
	Libraries and tools Client libraries, observability, and cloud integrations. Redis Data Integration is listed separately.
	RedisVL
	Redis Software
	Redis Cloud
	Redis for Kubernetes
	Redis Open Source
	Redis Iris context engine
	Redis Feature Form
	Redis Insight
	Redis Data Integration
	Glossary
	Command reference

FT.SYNDUMP

Syntax text Syntax diagram API methods

FT.SYNDUMP index

Client:

syndump() → Dict[str, List[str]]  // The contents of the synonym group

SYNDUMP(
    index: RedisArgument  // The index name
) → Promise<FTSynDumpResult>  // The contents of the synonym group

ftSynDump(
    indexName: String  // The index name
) → Map<String, List<String>>  // The contents of the synonym group

FTSynDump(
    ctx: context.Context,
    index: string  // The index name
) → *FTSynDumpCmd  // The contents of the synonym group

SynDump(
    indexName: string  // The index name
) → Dictionary<string, List<string>>  // Synonym groups and their terms

SynDumpAsync(
    indexName: string  // The index name
) → Task<Dictionary<string, List<string>>>  // Synonym groups and their terms

ftsyndump(
    $index: string  // The index name
) → array  // Synonym groups and their terms

Dump the contents of a synonym group

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.

Return the contents of a synonym group

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"

Redis Software	Redis Cloud Flexible & Annual	Redis Cloud Free & Fixed	Notes
✅ Supported	✅ Supported	✅ Supported

RESP2 RESP3

One of the following:

One of the following:

Map where keys are synonym terms and values are arrays of their associated synonym groups.
Simple error reply in these cases: no such index.