org.springframework.data.elasticsearch.core

Class ElasticsearchRestTemplate

java.lang.Object

org.springframework.data.elasticsearch.core.AbstractElasticsearchTemplate

org.springframework.data.elasticsearch.core.ElasticsearchRestTemplate

All Implemented Interfaces:

Aware, ApplicationContextAware, DocumentOperations, ElasticsearchOperations, SearchOperations

public class ElasticsearchRestTemplate
extends AbstractElasticsearchTemplate

ElasticsearchRestTemplate

Since:

4.4

Author:

Rizwan Idrees, Mohsin Husen, Artur Konczak, Kevin Leturc, Mason Chan, Young Gu, Oliver Gierke, Mark Janssen, Chris White, Mark Paluch, Ilkang Na, Alen Turkovic, Sascha Woo, Ted Liang, Don Wellington, Zetang Zeng, Peter Nowak, Ivan Greene, Christoph Strobl, Lorenzo Spinelli, Dmitriy Yakovlev, Roman Puchkovskiy, Martin Choraine, Farid Azaza, Peter-Josef Meisch, Mathias Teier, Gyula Attila Csorogi, Massimiliano Poggi, Farid Faoudi, Sijia Liu

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ElasticsearchRestTemplate.ClientCallback<T> Callback interface to be used with execute(ClientCallback) for operating directly on RestHighLevelClient.

Nested classes/interfaces inherited from class org.springframework.data.elasticsearch.core.AbstractElasticsearchTemplate

AbstractElasticsearchTemplate.DocumentCallback<T>, AbstractElasticsearchTemplate.ReadDocumentCallback<T>, AbstractElasticsearchTemplate.ReadSearchDocumentResponseCallback<T>, AbstractElasticsearchTemplate.ReadSearchScrollDocumentResponseCallback<T>, AbstractElasticsearchTemplate.SearchDocumentResponseCallback<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected org.springframework.data.elasticsearch.core.RequestFactory	requestFactory

Fields inherited from class org.springframework.data.elasticsearch.core.AbstractElasticsearchTemplate

elasticsearchConverter, entityCallbacks, entityOperations, refreshPolicy, routingResolver

Constructor Summary

Constructors

Constructor and Description
ElasticsearchRestTemplate(org.elasticsearch.client.RestHighLevelClient client)
ElasticsearchRestTemplate(org.elasticsearch.client.RestHighLevelClient client, ElasticsearchConverter elasticsearchConverter)

Method Summary

Modifier and Type	Method and Description
void	bulkUpdate(List<UpdateQuery> queries, BulkOptions bulkOptions, IndexCoordinates index) Bulk update all objects.
protected List<IndexedObjectInformation>	checkForBulkOperationFailure(org.elasticsearch.action.bulk.BulkResponse bulkResponse) extract the list of IndexedObjectInformation from a BulkResponse.
ClusterOperations	cluster() return a ClusterOperations instance that uses the same client communication setup as this ElasticsearchOperations instance.
long	count(Query query, Class<?> clazz, IndexCoordinates index) return number of elements found by given query
ByQueryResponse	delete(Query query, Class<?> clazz, IndexCoordinates index) Delete all records matching the query.
List<IndexedObjectInformation>	doBulkOperation(List<?> queries, BulkOptions bulkOptions, IndexCoordinates index)
protected AbstractElasticsearchTemplate	doCopy() must return a copy of this instance that will for example be used to set a custom routing resolver without modifying the original object.
protected String	doDelete(String id, String routing, IndexCoordinates index)
protected boolean	doExists(String id, IndexCoordinates index)
String	doIndex(IndexQuery query, IndexCoordinates index)
protected <T> SearchHits<T>	doSearch(MoreLikeThisQuery query, Class<T> clazz, IndexCoordinates index)
<T> T	execute(ElasticsearchRestTemplate.ClientCallback<T> callback) Execute a callback with the RestHighLevelClient
<T> T	get(String id, Class<T> clazz, IndexCoordinates index) Retrieves an object from the index specified in the entity's Document annotation.
protected String	getClusterVersion() tries to extract the version of the Elasticsearch cluster
protected org.elasticsearch.action.search.MultiSearchResponse.Item[]	getMultiSearchResult(org.elasticsearch.action.search.MultiSearchRequest request)
org.springframework.data.elasticsearch.core.RequestFactory	getRequestFactory()
protected String	getRuntimeLibraryVersion()
protected String	getVendor()
Query	idsQuery(List<String> ids) Creates a Query to find get all documents with given ids.
IndexOperations	indexOps(Class<?> clazz) get an IndexOperations that is bound to the given class
IndexOperations	indexOps(IndexCoordinates index) get an IndexOperations that is bound to the given index
Query	matchAllQuery() Creates a Query to get all documents.
<T> List<MultiGetItem<T>>	multiGet(Query query, Class<T> clazz, IndexCoordinates index) Execute a multiGet against elasticsearch for the given ids.
<T> List<SearchHits<T>>	multiSearch(List<? extends Query> queries, Class<T> clazz, IndexCoordinates index) Execute the multi search query against elasticsearch and return result as List of SearchHits.
List<SearchHits<?>>	multiSearch(List<? extends Query> queries, List<Class<?>> classes) Execute the multi search query against elasticsearch and return result as List of SearchHits.
List<SearchHits<?>>	multiSearch(List<? extends Query> queries, List<Class<?>> classes, IndexCoordinates index) Execute the multi search query against elasticsearch and return result as List of SearchHits.
protected <R extends org.elasticsearch.action.support.WriteRequest<R>> R	prepareWriteRequest(R request) Preprocess the write request before it is sent to the server, e.g. by setting the refresh policy if applicable.
ReindexResponse	reindex(ReindexRequest reindexRequest) Copies documents from a source to a destination.
<T> SearchHits<T>	search(Query query, Class<T> clazz, IndexCoordinates index) Execute the criteria query against elasticsearch and return result as SearchHits
void	searchScrollClear(List<String> scrollIds)
<T> SearchScrollHits<T>	searchScrollContinue(String scrollId, long scrollTimeInMillis, Class<T> clazz, IndexCoordinates index)
<T> SearchScrollHits<T>	searchScrollStart(long scrollTimeInMillis, Query query, Class<T> clazz, IndexCoordinates index)
String	submitReindex(ReindexRequest reindexRequest) Submits a reindex task.
org.elasticsearch.action.search.SearchResponse	suggest(org.elasticsearch.search.suggest.SuggestBuilder suggestion, Class<?> clazz) Deprecated.
org.elasticsearch.action.search.SearchResponse	suggest(org.elasticsearch.search.suggest.SuggestBuilder suggestion, IndexCoordinates index) Does a suggest query
UpdateResponse	update(UpdateQuery query, IndexCoordinates index) Partial update of the document.
ByQueryResponse	updateByQuery(UpdateQuery query, IndexCoordinates index) Update document(s) by query

Methods inherited from class org.springframework.data.elasticsearch.core.AbstractElasticsearchTemplate

bulkIndex, bulkIndex, bulkIndex, bulkOperation, bulkUpdate, count, delete, delete, delete, delete, delete, delete, exists, exists, get, getElasticsearchConverter, getEntityCreator, getEntityRouting, getIndexCoordinatesFor, getRefreshPolicy, index, logVersions, maybeCallbackAfterConvert, maybeCallbackAfterLoad, maybeCallbackAfterSave, maybeCallbackAfterSaveWithQueries, maybeCallbackAfterSaveWithQuery, maybeCallbackBeforeConvert, maybeCallbackBeforeConvertWithQueries, maybeCallbackBeforeConvertWithQuery, multiGet, multiSearch, save, save, save, save, save, search, search, search, searchForStream, searchForStream, searchScrollClear, setApplicationContext, setEntityCallbacks, setRefreshPolicy, toArray, updateIndexedObject, updateIndexedObjectsWithQueries, withRouting

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.data.elasticsearch.core.ElasticsearchOperations

stringIdRepresentation

Methods inherited from interface org.springframework.data.elasticsearch.core.DocumentOperations

bulkIndex, bulkUpdate

Methods inherited from interface org.springframework.data.elasticsearch.core.SearchOperations

count, searchOne, searchOne

Field Detail

requestFactory

protected org.springframework.data.elasticsearch.core.RequestFactory requestFactory

Constructor Detail

ElasticsearchRestTemplate

public ElasticsearchRestTemplate(org.elasticsearch.client.RestHighLevelClient client)

ElasticsearchRestTemplate

public ElasticsearchRestTemplate(org.elasticsearch.client.RestHighLevelClient client,
                                 ElasticsearchConverter elasticsearchConverter)

Method Detail

doCopy

protected AbstractElasticsearchTemplate doCopy()

Description copied from class: AbstractElasticsearchTemplate

must return a copy of this instance that will for example be used to set a custom routing resolver without modifying the original object.

Specified by:

doCopy in class AbstractElasticsearchTemplate

getRequestFactory

public org.springframework.data.elasticsearch.core.RequestFactory getRequestFactory()

Since:

4.0

indexOps

public IndexOperations indexOps(Class<?> clazz)

Description copied from interface: ElasticsearchOperations

get an IndexOperations that is bound to the given class

Returns:

IndexOperations

indexOps

public IndexOperations indexOps(IndexCoordinates index)

Description copied from interface: ElasticsearchOperations

get an IndexOperations that is bound to the given index

Returns:

IndexOperations

cluster

public ClusterOperations cluster()

Description copied from interface: ElasticsearchOperations

return a ClusterOperations instance that uses the same client communication setup as this ElasticsearchOperations instance.

Returns:

ClusterOperations implementation

doIndex

public String doIndex(IndexQuery query,
                      IndexCoordinates index)

Specified by:

doIndex in class AbstractElasticsearchTemplate

get

@Nullable
public <T> T get(String id,
                           Class<T> clazz,
                           IndexCoordinates index)

Description copied from interface: DocumentOperations

Retrieves an object from the index specified in the entity's Document annotation.

Parameters:

id - the id of the object

clazz - the entity class,

index - the index from which the object is read.

Returns:

the entity

multiGet

public <T> List<MultiGetItem<T>> multiGet(Query query,
                                          Class<T> clazz,
                                          IndexCoordinates index)

Description copied from interface: DocumentOperations

Execute a multiGet against elasticsearch for the given ids.

Parameters:

query - the query defining the ids of the objects to get

clazz - the type of the object to be returned

index - the index(es) from which the objects are read.

Returns:

list of MultiGetItems

See Also:

Query.multiGetQuery(Collection), Query.multiGetQueryWithRouting(List)

doExists

protected boolean doExists(String id,
                           IndexCoordinates index)

Specified by:

doExists in class AbstractElasticsearchTemplate

bulkUpdate

public void bulkUpdate(List<UpdateQuery> queries,
                       BulkOptions bulkOptions,
                       IndexCoordinates index)

Description copied from interface: DocumentOperations

Bulk update all objects. Will do update.

Parameters:

queries - the queries to execute in bulk

bulkOptions - options to be added to the bulk request

doDelete

protected String doDelete(String id,
                          @Nullable
                          String routing,
                          IndexCoordinates index)

Specified by:

doDelete in class AbstractElasticsearchTemplate

delete

public ByQueryResponse delete(Query query,
                              Class<?> clazz,
                              IndexCoordinates index)

Description copied from interface: DocumentOperations

Delete all records matching the query.

Parameters:

query - query defining the objects

clazz - The entity class, must be annotated with Document

index - the index from which to delete

Returns:

response with detailed information

update

public UpdateResponse update(UpdateQuery query,
                             IndexCoordinates index)

Description copied from interface: DocumentOperations

Partial update of the document.

Parameters:

query - query defining the update

index - the index where to update the records

Returns:

the update response

updateByQuery

public ByQueryResponse updateByQuery(UpdateQuery query,
                                     IndexCoordinates index)

Description copied from interface: DocumentOperations

Update document(s) by query

Parameters:

query - query defining the update, must not be null

index - the index where to update the records , must not be null

Returns:

the update response

reindex

public ReindexResponse reindex(ReindexRequest reindexRequest)

Description copied from interface: DocumentOperations

Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself. (@see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html)

Parameters:

reindexRequest - reindex request parameters

Returns:

the reindex response

submitReindex

public String submitReindex(ReindexRequest reindexRequest)

Description copied from interface: DocumentOperations

Submits a reindex task. (@see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html)

Parameters:

reindexRequest - reindex request parameters

Returns:

the task id

doBulkOperation

public List<IndexedObjectInformation> doBulkOperation(List<?> queries,
                                                      BulkOptions bulkOptions,
                                                      IndexCoordinates index)

Specified by:

doBulkOperation in class AbstractElasticsearchTemplate

prepareWriteRequest

protected <R extends org.elasticsearch.action.support.WriteRequest<R>> R prepareWriteRequest(R request)

Preprocess the write request before it is sent to the server, e.g. by setting the refresh policy if applicable.

Type Parameters:

R - the request type

Parameters:

request - must not be null.

Returns:

the processed WriteRequest.

checkForBulkOperationFailure

protected List<IndexedObjectInformation> checkForBulkOperationFailure(org.elasticsearch.action.bulk.BulkResponse bulkResponse)

extract the list of IndexedObjectInformation from a BulkResponse.

Parameters:

bulkResponse - the response to evaluate

Returns:

the list of the IndexedObjectInformations

count

public long count(Query query,
                  @Nullable
                  Class<?> clazz,
                  IndexCoordinates index)

Description copied from interface: SearchOperations

return number of elements found by given query

Parameters:

query - the query to execute

clazz - the entity clazz used for property mapping

index - the index to run the query against

Returns:

count

search

public <T> SearchHits<T> search(Query query,
                                Class<T> clazz,
                                IndexCoordinates index)

Description copied from interface: SearchOperations

Execute the criteria query against elasticsearch and return result as SearchHits

Type Parameters:

T - element return type

Parameters:

query - the query to execute

clazz - the entity clazz used for property mapping

index - the index to run the query against

Returns:

SearchHits containing the list of found objects

doSearch

protected <T> SearchHits<T> doSearch(MoreLikeThisQuery query,
                                     Class<T> clazz,
                                     IndexCoordinates index)

Specified by:

doSearch in class AbstractElasticsearchTemplate

searchScrollStart

public <T> SearchScrollHits<T> searchScrollStart(long scrollTimeInMillis,
                                                 Query query,
                                                 Class<T> clazz,
                                                 IndexCoordinates index)

Specified by:

searchScrollStart in class AbstractElasticsearchTemplate

searchScrollContinue

public <T> SearchScrollHits<T> searchScrollContinue(String scrollId,
                                                    long scrollTimeInMillis,
                                                    Class<T> clazz,
                                                    IndexCoordinates index)

Specified by:

searchScrollContinue in class AbstractElasticsearchTemplate

searchScrollClear

public void searchScrollClear(List<String> scrollIds)

Specified by:

searchScrollClear in class AbstractElasticsearchTemplate

suggest

public org.elasticsearch.action.search.SearchResponse suggest(org.elasticsearch.search.suggest.SuggestBuilder suggestion,
                                                              IndexCoordinates index)

Description copied from interface: SearchOperations

Does a suggest query

Parameters:

suggestion - the query

index - the index to run the query against

Returns:

the suggest response

multiSearch

public <T> List<SearchHits<T>> multiSearch(List<? extends Query> queries,
                                           Class<T> clazz,
                                           IndexCoordinates index)

Description copied from interface: SearchOperations

Execute the multi search query against elasticsearch and return result as List of SearchHits.

Type Parameters:

T - element return type

Parameters:

queries - the queries to execute

clazz - the entity clazz used for property mapping

index - the index to run the query against

Returns:

list of SearchHits

multiSearch

public List<SearchHits<?>> multiSearch(List<? extends Query> queries,
                                       List<Class<?>> classes)

Description copied from interface: SearchOperations

Execute the multi search query against elasticsearch and return result as List of SearchHits.

Parameters:

queries - the queries to execute

classes - the entity classes

Returns:

list of SearchHits

multiSearch

public List<SearchHits<?>> multiSearch(List<? extends Query> queries,
                                       List<Class<?>> classes,
                                       IndexCoordinates index)

Description copied from interface: SearchOperations

Execute the multi search query against elasticsearch and return result as List of SearchHits.

Parameters:

queries - the queries to execute

classes - the entity classes used for property mapping

index - the index to run the query against

Returns:

list of SearchHits

getMultiSearchResult

protected org.elasticsearch.action.search.MultiSearchResponse.Item[] getMultiSearchResult(org.elasticsearch.action.search.MultiSearchRequest request)

execute

public <T> T execute(ElasticsearchRestTemplate.ClientCallback<T> callback)

Execute a callback with the RestHighLevelClient

Type Parameters:

T - the type returned from the callback

Parameters:

callback - the callback to execute, must not be null

Returns:

the callback result

Since:

4.0

getClusterVersion

protected String getClusterVersion()

Description copied from class: AbstractElasticsearchTemplate

tries to extract the version of the Elasticsearch cluster

Specified by:

getClusterVersion in class AbstractElasticsearchTemplate

Returns:

the version as string if it can be retrieved

matchAllQuery

public Query matchAllQuery()

Description copied from interface: SearchOperations

Creates a Query to get all documents. Must be implemented by the concrete implementations to provide an appropriate query using the respective client.

Returns:

a query to find all documents

idsQuery

public Query idsQuery(List<String> ids)

Description copied from interface: SearchOperations

Creates a Query to find get all documents with given ids. Must be implemented by the concrete implementations to provide an appropriate query using the respective client.

Parameters:

ids - the list of ids must not be null

Returns:

query returning the documents with the given ids

getVendor

protected String getVendor()

Specified by:

getVendor in class AbstractElasticsearchTemplate

Returns:

the vendor name of the used cluster and client library

getRuntimeLibraryVersion

protected String getRuntimeLibraryVersion()

Specified by:

getRuntimeLibraryVersion in class AbstractElasticsearchTemplate

Returns:

the version of the used client runtime library.

suggest

@Deprecated
public org.elasticsearch.action.search.SearchResponse suggest(org.elasticsearch.search.suggest.SuggestBuilder suggestion,
                                                                          Class<?> clazz)

Deprecated.

Description copied from interface: SearchOperations

Does a suggest query

Parameters:

suggestion - the query

clazz - the entity class

Returns:

the suggest response