WARNING: Version 2.3 of Elasticsearch has passed its EOL date.
This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Java API changes
editJava API changes
editTransport API construction
editThe TransportClient
construction code has changed, it now uses the builder
pattern. Instead of:
Settings settings = Settings.settingsBuilder() .put("cluster.name", "myClusterName").build(); Client client = new TransportClient(settings);
Use the following:
Settings settings = Settings.settingsBuilder() .put("cluster.name", "myClusterName").build(); Client client = TransportClient.builder().settings(settings).build();
The transport client also no longer supports loading settings from config files. If you have a config file, you can load it into settings yourself before constructing the transport client:
Settings settings = Settings.settingsBuilder() .loadFromPath(pathToYourSettingsFile).build(); Client client = TransportClient.builder().settings(settings).build();
Exception are only thrown on total failure
editPreviously, many APIs would throw an exception if any shard failed to execute
the request. Now the exception is only thrown if all shards fail the request.
The responses for these APIs will always have a getShardFailures
method that
you can and should check for failures.
IndexMissingException removed.
editUse IndexNotFoundException
instead.
Automatically thread client listeners
editPreviously, the user had to set request listener threads to true
when on the
client side in order not to block IO threads on heavy operations. This proved
to be very trappy for users, and ended up creating problems that are very hard
to debug.
In 2.0, Elasticsearch automatically threads listeners that are used from the client when the client is a node client or a transport client. Threading can no longer be manually set.
Query/filter refactoring
editorg.elasticsearch.index.queries.FilterBuilders
has been removed as part of the merge of
queries and filters. These filters are now available in QueryBuilders
with the same name.
All methods that used to accept a FilterBuilder
now accept a QueryBuilder
instead.
In addition some query builders have been removed or renamed:
-
commonTerms(...)
renamed withcommonTermsQuery(...)
-
queryString(...)
renamed withqueryStringQuery(...)
-
simpleQueryString(...)
renamed withsimpleQueryStringQuery(...)
-
textPhrase(...)
removed -
textPhrasePrefix(...)
removed -
textPhrasePrefixQuery(...)
removed -
filtered(...)
removed. UsefilteredQuery(...)
instead. -
inQuery(...)
removed.
GetIndexRequest
editGetIndexRequest.features()
now returns an array of Feature Enums instead of an array of String values.
The following deprecated methods have been removed:
-
GetIndexRequest.addFeatures(String[])
- UseGetIndexRequest.addFeatures(Feature[])
instead -
GetIndexRequest.features(String[])
- UseGetIndexRequest.features(Feature[])
instead. -
GetIndexRequestBuilder.addFeatures(String[])
- UseGetIndexRequestBuilder.addFeatures(Feature[])
instead. -
GetIndexRequestBuilder.setFeatures(String[])
- UseGetIndexRequestBuilder.setFeatures(Feature[])
instead.
BytesQueryBuilder removed
editThe redundant BytesQueryBuilder has been removed in favour of the WrapperQueryBuilder internally.
TermsQueryBuilder execution removed
editThe TermsQueryBuilder#execution
method has been removed as it has no effect, it is ignored by the
corresponding parser.
ImmutableSettings removed
editUse Settings.builder()
instead of ImmutableSettings.builder()
.
InetSocketTransportAddress removed
editUse InetSocketTransportAddress(InetSocketAddress address)
instead of InetSocketTransportAddress(String, int)
.
You can create an InetSocketAddress instance with InetSocketAddress(String, int)
. For example:
new InetSocketTransportAddress(new InetSocketAddress("127.0.0.1", 0));
Request Builders refactoring
editAn action
parameter has been added to various request builders:
-
Instead of
new SnapshotsStatusRequestBuilder(elasticSearchClient)
usenew SnapshotsStatusRequestBuilder(elasticSearchClient, SnapshotsStatusAction.INSTANCE)
. -
Instead of
new CreateSnapshotRequestBuilder(elasticSearchClient)
usenew CreateSnapshotRequestBuilder(elasticSearchClient, CreateSnapshotAction.INSTANCE)
. -
Instead of
new CreateIndexRequestBuilder(elasticSearchClient, index)
usenew CreateIndexRequestBuilder(elasticSearchClient, CreateIndexAction.INSTANCE, index)
.
Shading and package relocation removed
editElasticsearch used to shade its dependencies and to relocate packages. We no longer use shading or relocation. You might need to change your imports to the original package names:
-
com.google.common
wasorg.elasticsearch.common
-
com.carrotsearch.hppc
wasorg.elasticsearch.common.hppc
-
jsr166e
wasorg.elasticsearch.common.util.concurrent.jsr166e
-
com.fasterxml.jackson
wasorg.elasticsearch.common.jackson
-
org.joda.time
wasorg.elasticsearch.common.joda.time
-
org.joda.convert
wasorg.elasticsearch.common.joda.convert
-
org.jboss.netty
wasorg.elasticsearch.common.netty
-
com.ning.compress
wasorg.elasticsearch.common.compress
-
com.github.mustachejava
wasorg.elasticsearch.common.mustache
-
com.tdunning.math.stats
wasorg.elasticsearch.common.stats
-
org.apache.commons.lang
wasorg.elasticsearch.common.lang
-
org.apache.commons.cli
wasorg.elasticsearch.common.cli.commons