algolia dictionary
Manage your Algolia dictionaries.
algolia dictionary entries
algolia dictionary entries [flags]
Manage your Algolia dictionaries entries.
algolia dictionary entries browse
algolia dictionary entries browse {<dictionary>... | --all} [--include-defaults] [flags]
Browse dictionary entries.
Examples
1
2
3
4
5
6
7
8
9
10
11
12
# Retrieve all entries from the "stopwords" dictionary (doesn't include default stopwords)
$ algolia dictionary entries browse stopwords
# Retrieve all entries from the "stopwords" and "plurals" dictionaries
$ algolia dictionary entries browse stopwords plurals
# Retrieve all entries from all dictionaries
$ algolia dictionary entries browse --all
# Retrieve all entries from the "stopwords" dictionaries (including default stopwords)
$ algolia dictionary entries browse stopwords --include-defaults
Flags
-
-a
,--all
-
browse all dictionaries
-
-d
,--include-defaults
-
include default stopwords
Output formatting flags
-
--allow-missing-template-keys
-
If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.
-
-o
,--output
-
Output format. One of: (json, jsonpath, jsonpath-as-json, jsonpath-file).
-
--template
-
Template string or path to template file to use when –output=jsonpath, –output=jsonpath-file.
algolia dictionary entries clear
algolia dictionary entries clear {<dictionary>... | --all} [--confirm] [flags]
Clear dictionary entries.
Examples
1
2
3
4
5
6
7
8
9
# Delete all entries from the "stopwords" dictionary
$ algolia dictionary entries clear stopwords
# Delete all entries from the "stopwords" and "plurals" dictionaries
$ algolia dictionary entries clear stopwords plurals
# Delete all entries from all dictionaries
$ algolia dictionary entries clear --all
Flags
-
-a
,--all
-
clear all dictionaries
-
-y
,--confirm
-
skip confirmation prompt
algolia dictionary entries delete
algolia dictionary entries delete <dictionary> --object-ids <object-ids> [--confirm] [flags]
Delete dictionary entries.
Examples
1
2
3
4
5
6
# Delete one single entry with the ID "1" from the "plurals" dictionary
$ algolia dictionary entries delete plurals --object-ids 1
# Delete multiple entries with the IDs "1" and "2" from the "plurals" dictionary
$ algolia dictionary entries delete plurals --object-ids 1,2
Flags
-
-y
,--confirm
-
skip confirmation prompt
-
--object-ids
-
Object IDs to delete
algolia dictionary entries import
algolia dictionary entries import <dictionary> -F <file> [--wait] [--continue-on-errors] [flags]
Import dictionary entries from a file to the specified index.
Examples
1
2
3
4
5
6
# Import entries from the "entries.ndjson" file to "stopwords" dictionary
$ algolia dictionary import stopwords -F entries.ndjson
# Import entries from the "entries.ndjson" file to "plurals" dictionary and continue importing entries even if some entries are invalid
$ algolia dictionary import plurals -F entries.ndjson --continue-on-errors
Flags
-
-C
,--continue-on-error
-
Continue importing entries even if some entries are invalid.
-
-F
,--file
-
Read entries to import from
file
(use “-“ to read from standard input) -
-w
,--wait
-
Wait for the operation to complete before returning
algolia dictionary settings
algolia dictionary settings [flags]
Manage your Algolia dictionaries settings.
algolia dictionary settings get
algolia dictionary settings get [flags]
Get the dictionary settings.
Examples
1
2
3
# Get the dictionary settings
$ algolia dictionary settings get
Output formatting flags
-
--allow-missing-template-keys
-
If true, ignore any errors in templates when a field or map key is missing in the template. Only applies to golang and jsonpath output formats.
-
-o
,--output
-
Output format. One of: (json, jsonpath, jsonpath-as-json, jsonpath-file).
-
--template
-
Template string or path to template file to use when –output=jsonpath, –output=jsonpath-file.
algolia dictionary settings set
algolia dictionary settings set --disable-standard-entries <languages...> --enable-standard-entries <languages...> [--reset-standard-entries] [flags]
Set dictionary settings.
Examples
1
2
3
4
5
6
7
8
9
10
11
12
# Disable standard entries for English and French
$ algolia dictionary settings set --disable-standard-entries en,fr
# Enable standard entries for English and French languages
$ algolia dictionary settings set --enable-standard-entries en,fr
# Disable standard entries for English and French languages and enable standard entries for Spanish language.
$ algolia dictionary settings set --disable-standard-entries en,fr --enable-standard-entries es
# Reset standard entries to their default values
$ algolia dictionary settings set --reset-standard-entries
Flags
-
-d
,--disable-standard-entries
-
Disable standard entries for the given languages
-
-e
,--enable-standard-entries
-
Enable standard entries for the given languages
-
-r
,--reset-standard-entries
-
Reset standard entries to their default values