Reload search analyzers APIedit
Reloads an index’s search analyzers and their resources.
POST /twitter/_reload_search_analyzers
Requestedit
POST /<index>/_reload_search_analyzers
GET /<index>/_reload_search_analyzers
Descriptionedit
You can use the reload search analyzers API
to pick up changes to synonym files
used in the synonym_graph
or synonym token filter
of a search analyzer.
To be eligible,
the token filter must have an updateable flag of true
and only be used in search analyzers.
This API does not perform a reload for each shard of an index. Instead, it performs a reload for each node containing index shards. As a result, the total shard count returned by the API can differ from the number of index shards.
Because reloading affects every node with an index shard, its important to update the synonym file on every data node in the cluster, including nodes that don’t contain a shard replica, before using this API. This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future.
Path parametersedit
-
<index> - (Required, string) Comma-separated list or wildcard expression of index names used to limit the request.
Query parametersedit
-
allow_no_indices -
(Optional, boolean) If
true, the request does not return an error if a wildcard expression or_allvalue retrieves only missing or closed indices.This parameter also applies to index aliases that point to a missing or closed index.
Defaults to
true. -
expand_wildcards -
(Optional, string) Controls what kind of indices that wildcard expressions can expand to. Multiple values are accepted when separated by a comma, as in
open,hidden. Valid values are:-
all - Expand to open and closed indices, including hidden indices.
-
open - Expand only to open indices.
-
closed - Expand only to closed indices.
-
hidden -
Expansion of wildcards will include hidden indices.
Must be combined with
open,closed, or both. -
none - Wildcard expressions are not accepted.
Defaults to
open. -
-
ignore_unavailable -
(Optional, boolean) If
true, missing or closed indices are not included in the response. Defaults tofalse.
Examplesedit
Use the create index API to create an index with a search analyzer that contains an updateable synonym filter.
Using the following analyzer as an index analyzer results in an error.
PUT /my_index
{
"settings": {
"index" : {
"analysis" : {
"analyzer" : {
"my_synonyms" : {
"tokenizer" : "whitespace",
"filter" : ["synonym"]
}
},
"filter" : {
"synonym" : {
"type" : "synonym_graph",
"synonyms_path" : "analysis/synonym.txt",
"updateable" : true
}
}
}
}
},
"mappings": {
"properties": {
"text": {
"type": "text",
"analyzer" : "standard",
"search_analyzer": "my_synonyms"
}
}
}
}
|
Includes a synonym file. |
|
|
Marks the token filter as updateable. |
|
|
Marks the analyzer as a search analyzer. |
After updating the synonym file, use the analyzer reload API to reload the search analyzer and pick up the file changes.
POST /my_index/_reload_search_analyzers
The API returns the following response.
{
"_shards" : {
"total" : 2,
"successful" : 2,
"failed" : 0
},
"reload_details" : [
{
"index" : "my_index",
"reloaded_analyzers" : [
"my_synonyms"
],
"reloaded_node_ids" : [
"mfdqTXn_T7SGr2Ho2KT8uw"
]
}
]
}