Skip to main content
Usage

Examples

Import synonyms from the “synonyms.ndjson” file to the “MOVIES” index:
Import synonyms from the standard input to the “MOVIES” index:
Browse the synonyms in the “SERIES” index and import them to the “MOVIES” index:
Import synonyms from the “synonyms.ndjson” file to the “MOVIES” index and replace existing synonyms:
Import synonyms from the “synonyms.ndjson” file to the “MOVIES” index and don’t forward the synonyms to the index replicas:

Flags

--dry-run
Validate and preview the import request without sending it
-F, --file
Import synonyms from a file (use ”-” to read from standard input)
-f, --forward-to-replicas
Whether to also add the synonyms to replicas
-r, --replace-existing-synonyms
Replace existing synonyms in the index
-w, --wait
wait for the operation to complete

Output formatting flags

--allow-missing-template-keys
If true, ignore errors in templates due to missing fields or map keys. This only applies to golang and jsonpath output formats.
-o, --output
Output format. One of: (json, jsonl, ndjson, jsonpath, jsonpath-as-json, jsonpath-file).
--template
Template string or path to a template file to use when —output=jsonpath, —output=jsonpath-file.
Last modified on July 15, 2026