Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Index Warmup API #1913
Index warming allows to run registered search requests to warm up the index before it is available for search. With the near real time aspect of search, cold data (segments) will be warmed up before they become available for search.
Warmup searches typically include requests that require heavy loading of data, such as faceting or sorting on specific fields.
The warmup APIs allows to register warmup (search) under specific names, remove them, and get them.
Index warmup can be disabled by setting
Allows to put a warmup search request on a specific index (or indices), with the body composing of a regular search request. Types can be provided as part of the URI if the search request is designed to be run only against the specific types.
Here is an example that registers a warmup called
And an example that registers a warmup against specific types:
Removing a warmer can be done against an index (or alias / indices) based on its name. The provided name can be a simple wildcard expression or omitted to remove all warmers. Some samples:
Getting a warmer for specific index (or alias, or several indices) based on its name. The provided name can be a simple wildcard expression or omitted to get all warmers. Some examples: