IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Deprecation info APIs Repositories metering APIs »
Elastic Docs ›Elasticsearch Guide [7.10] ›REST APIs

Reload search analyzers API

edit

Reload search analyzers API

edit

Reloads an index’s search analyzers and their resources. For data streams, the API reloads search analyzers and resources for the stream’s backing indices.

POST /my-index-000001/_reload_search_analyzers

Request

edit

POST /<target>/_reload_search_analyzers

GET /<target>/_reload_search_analyzers

Prerequisites

edit
  • If the Elasticsearch security features are enabled, you must have the manage index privilege for the target data stream, index, or index alias.

Description

edit

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 parameters

edit
<target>

(Required, string) Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported.

To target all data streams and indices in a cluster, use _all or *.

Query parameters

edit
allow_no_indices

(Optional, Boolean) If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

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 false, the request returns an error if it targets a missing or closed index. Defaults to false.

Examples

edit

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-000001
{
  "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-000001/_reload_search_analyzers

The API returns the following response.

{
  "_shards": {
    "total": 2,
    "successful": 2,
    "failed": 0
  },
  "reload_details": [
    {
      "index": "my-index-000001",
      "reloaded_analyzers": [
        "my_synonyms"
      ],
      "reloaded_node_ids": [
        "mfdqTXn_T7SGr2Ho2KT8uw"
      ]
    }
  ]
}
« Deprecation info APIs Repositories metering APIs »