Index Aliases API
editIndex Aliases API
editIndices Aliases Request
editThe Index Aliases API allows aliasing an index with a name, with all APIs automatically converting the alias name to the actual index name.
An IndicesAliasesRequest
must have at least one AliasActions
:
IndicesAliasesRequest request = new IndicesAliasesRequest(); AliasActions aliasAction = new AliasActions(AliasActions.Type.ADD) .index("index1") .alias("alias1"); request.addAliasAction(aliasAction);
Creates an |
|
Creates an |
|
Adds the alias action to the request |
The following action types are supported: add
- alias an index, remove
-
removes the alias associated with the index, and remove_index
- deletes the
index.
AliasActions addIndexAction = new AliasActions(AliasActions.Type.ADD) .index("index1") .alias("alias1") .filter("{\"term\":{\"year\":2016}}"); AliasActions addIndicesAction = new AliasActions(AliasActions.Type.ADD) .indices("index1", "index2") .alias("alias2") .routing("1"); AliasActions removeAction = new AliasActions(AliasActions.Type.REMOVE) .index("index3") .alias("alias3"); AliasActions removeIndexAction = new AliasActions(AliasActions.Type.REMOVE_INDEX) .index("index4");
Creates an alias |
|
Creates an alias |
|
Removes the associated alias |
|
|
Optional arguments
editThe following arguments can optionally be provided:
Timeout to wait for the all the nodes to acknowledge the operation as a |
|
Timeout to wait for the all the nodes to acknowledge the operation as a |
Synchronous Execution
editWhen executing a IndicesAliasesRequest
in the following manner, the client waits
for the IndicesAliasesResponse
to be returned before continuing with code execution:
AcknowledgedResponse indicesAliasesResponse = client.indices().updateAliases(request, RequestOptions.DEFAULT);
Synchronous calls may throw an IOException
in case of either failing to
parse the REST response in the high-level REST client, the request times out
or similar cases where there is no response coming back from the server.
In cases where the server returns a 4xx
or 5xx
error code, the high-level
client tries to parse the response body error details instead and then throws
a generic ElasticsearchException
and adds the original ResponseException
as a
suppressed exception to it.
Asynchronous Execution
editExecuting a IndicesAliasesRequest
can also be done in an asynchronous fashion so that
the client can return directly. Users need to specify how the response or
potential failures will be handled by passing the request and a listener to the
asynchronous update-aliases method:
The asynchronous method does not block and returns immediately. Once it is
completed the ActionListener
is called back using the onResponse
method
if the execution successfully completed or using the onFailure
method if
it failed. Failure scenarios and expected exceptions are the same as in the
synchronous execution case.
A typical listener for update-aliases
looks like:
Indices Aliases Response
editThe returned IndicesAliasesResponse
allows to retrieve information about the
executed operation as follows: