Class ReactiveElasticsearchTemplate

java.lang.Object

org.springframework.data.elasticsearch.core.AbstractReactiveElasticsearchTemplate

org.springframework.data.elasticsearch.client.elc.ReactiveElasticsearchTemplate

All Implemented Interfaces:

Aware, ApplicationContextAware, ReactiveDocumentOperations, ReactiveElasticsearchOperations, ReactiveSearchOperations, ReactiveScriptOperations, ReactiveSqlOperations

public class ReactiveElasticsearchTemplate
extends AbstractReactiveElasticsearchTemplate

Implementation of ReactiveElasticsearchOperations using the new Elasticsearch client.

Since:

4.4

Author:

Peter-Josef Meisch, Illia Ulianov, Junghoon Ban, maryantocinn

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ReactiveElasticsearchTemplate.ClientCallback<T extends Publisher<?>>	Callback interface to be used with invalid @link {@link #execute(ReactiveElasticsearchTemplate.ClientCallback<>) } for operating directly on ReactiveElasticsearchClient.

Nested classes/interfaces inherited from class AbstractReactiveElasticsearchTemplate

AbstractReactiveElasticsearchTemplate.DocumentCallback<T>, AbstractReactiveElasticsearchTemplate.Entities<T>, AbstractReactiveElasticsearchTemplate.IndexResponseMetaData, AbstractReactiveElasticsearchTemplate.ReadDocumentCallback<T>, AbstractReactiveElasticsearchTemplate.ReadSearchDocumentCallback<T>, AbstractReactiveElasticsearchTemplate.SearchDocumentCallback<T>

Field Summary

Fields inherited from class AbstractReactiveElasticsearchTemplate

converter, entityCallbacks, entityOperations, mappingContext, observationRegistry, refreshPolicy, routingResolver

Fields inherited from interface ReactiveDocumentOperations

FLUX_SAVE_BULK_SIZE

Constructor Summary

Constructors

Constructor	Description
ReactiveElasticsearchTemplate(ReactiveElasticsearchClient client, ElasticsearchConverter converter)

Method Summary

Modifier and Type	Method	Description
Flux<? extends AggregationContainer<?>>	aggregate(Query query, Class<?> entityType, IndexCoordinates index)	Perform an aggregation specified by the given query.
Mono<Void>	bulkUpdate(List<UpdateQuery> queries, BulkOptions bulkOptions, IndexCoordinates index)	Bulk update all objects.
Mono<Boolean>	closePointInTime(String pit)	Closes a point in time
ReactiveClusterOperations	cluster()	return a ReactiveClusterOperations instance that uses the same client communication setup as this ElasticsearchOperations instance.
Mono<Long>	count(Query query, Class<?> entityType, IndexCoordinates index)	Count the number of documents matching the given Query.
protected void	customizeCopy(AbstractReactiveElasticsearchTemplate copy)	Hook for subclasses to copy additional state during AbstractReactiveElasticsearchTemplate.copy().
Mono<String>	delete(Object entity, IndexCoordinates index)	Delete the given entity extracting index from entity metadata.
Mono<String>	delete(String id, IndexCoordinates index)	Delete the entity with given id.
Mono<ByQueryResponse>	delete(DeleteQuery query, Class<?> entityType, IndexCoordinates index)	Delete the documents matching the given Query extracting index from entity metadata.
Mono<Boolean>	deleteScript(String name)	Deletes the script with the given name
protected ReactiveElasticsearchTemplate	doCopy()
protected Mono<Long>	doCount(Query query, Class<?> entityType, IndexCoordinates index)
protected Mono<String>	doDeleteById(String id, @Nullable String routing, IndexCoordinates index)
protected Mono<Boolean>	doExists(String id, IndexCoordinates index)
protected Flux<SearchDocument>	doFind(Query query, Class<?> clazz, IndexCoordinates index)
protected <T> Mono<SearchDocumentResponse>	doFindForResponse(Query query, Class<?> clazz, IndexCoordinates index)
protected <T> Mono<Tuple2<T, AbstractReactiveElasticsearchTemplate.IndexResponseMetaData>>	doIndex(T entity, IndexCoordinates index)
<T> Publisher<T>	execute(ReactiveElasticsearchTemplate.ClientCallback<Publisher<T>> callback)	Execute a callback with the ReactiveElasticsearchClient and provide exception translation.
Mono<Boolean>	exists(String id, IndexCoordinates index)	Check if an entity with given id exists.
<T> Mono<T>	get(String id, Class<T> entityType, IndexCoordinates index)	Fetch the entity with given id.
Mono<String>	getClusterVersion()
Mono<String>	getRuntimeLibraryVersion()
Mono<Script>	getScript(String name)	Gest the script with the given name.
Mono<String>	getVendor()
Query	idsQuery(List<String> ids)	Creates a Query to find get all documents with given ids.
ReactiveIndexOperations	indexOps(Class<?> clazz)	Creates a ReactiveIndexOperations that is bound to the given class
ReactiveIndexOperations	indexOps(IndexCoordinates index)	Creates a ReactiveIndexOperations that is bound to the given index
Query	matchAllQuery()	Creates a Query to find all documents.
<T> Flux<MultiGetItem<T>>	multiGet(Query query, Class<T> clazz, IndexCoordinates index)	Execute a multiGet against elasticsearch for the given ids.
Mono<String>	openPointInTime(IndexCoordinates index, Duration keepAlive, Boolean ignoreUnavailable)	Opens a point in time (pit) in Elasticsearch.
Mono<Boolean>	putScript(Script script)	Stores the given script in the Elasticsearch cluster.
BaseQueryBuilder	queryBuilderWithIds(List<String> ids)	Creates a BaseQueryBuilder that has the given ids setto the parameter value.
Mono<ReindexResponse>	reindex(ReindexRequest reindexRequest)	Copies documents from a source to a destination.
<T> Mono<T>	save(T entity, IndexCoordinates index)	Index the entity under the given type in the given index.
<T> Flux<T>	saveAll(Mono<? extends Collection<? extends T>> entitiesPublisher, IndexCoordinates index)	Index entities in the given index.
<T> Flux<SearchHit<T>>	search(Query query, Class<?> entityType, Class<T> resultType, IndexCoordinates index)	Search the index for entities matching the given query.
Mono<SqlResponse>	search(SqlQuery query)	Execute the sql query against elasticsearch and return result as SqlResponse
void	setApplicationContext(ApplicationContext applicationContext)
void	setObservationConvention(@Nullable ElasticsearchObservationConvention observationConvention)	Set a custom ElasticsearchObservationConvention to override the default convention.
Mono<String>	submitReindex(ReindexRequest reindexRequest)	Submits a reindex task.
Mono<UpdateResponse>	update(UpdateQuery updateQuery, IndexCoordinates index)	Partial update of the document.
Mono<ByQueryResponse>	updateByQuery(UpdateQuery updateQuery, IndexCoordinates index)	Update document(s) by query.

Methods inherited from class AbstractReactiveElasticsearchTemplate

aggregate, count, delete, delete, delete, exists, get, getElasticsearchConverter, getEntityRouting, getIndexCoordinatesFor, getIndexQuery, getPersistentEntityFor, getRefreshPolicy, logVersions, maybeCallbackAfterConvert, maybeCallbackAfterLoad, maybeCallbackAfterSave, maybeCallbackBeforeConvert, multiGet, save, save, save, saveAll, search, searchForHits, searchForHits, searchForPage, searchForPage, setEntityCallbacks, setObservationRegistry, setRefreshPolicy, suggest, suggest, withRefreshPolicy, withRouting

Methods inherited from class Object

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

Methods inherited from interface ReactiveDocumentOperations

bulkUpdate, save, save, save, save, saveAll, saveAll

Methods inherited from interface ReactiveSearchOperations

count, openPointInTime, search, search, searchForHits, searchForHits, searchForPage, searchForPage

Constructor Details

ReactiveElasticsearchTemplate

public ReactiveElasticsearchTemplate(ReactiveElasticsearchClient client,
 ElasticsearchConverter converter)

Method Details

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Overrides:

setApplicationContext in class AbstractReactiveElasticsearchTemplate

Throws:

BeansException

setObservationConvention

public void setObservationConvention(@Nullable ElasticsearchObservationConvention observationConvention)

Set a custom ElasticsearchObservationConvention to override the default convention.

Parameters:

observationConvention - can be null.

Since:

6.1

save

public <T> Mono<T> save(T entity,
 IndexCoordinates index)

Description copied from interface: ReactiveDocumentOperations

Index the entity under the given type in the given index. If the index is null or empty the index name provided via entity metadata is used. Same for the type.

Specified by:

save in interface ReactiveDocumentOperations

Overrides:

save in class AbstractReactiveElasticsearchTemplate

Type Parameters:

T -

Parameters:

entity - must not be null.

index - the target index, must not be null

Returns:

a Mono emitting the saved entity.

exists

public Mono<Boolean> exists(String id,
 IndexCoordinates index)

Description copied from interface: ReactiveDocumentOperations

Check if an entity with given id exists.

Specified by:

exists in interface ReactiveDocumentOperations

Overrides:

exists in class AbstractReactiveElasticsearchTemplate

Parameters:

id - the _id of the document to look for.

index - the target index, must not be null

Returns:

a Mono emitting true if a matching document exists, false otherwise.

delete

public Mono<String> delete(Object entity,
 IndexCoordinates index)

Description copied from interface: ReactiveDocumentOperations

Delete the given entity extracting index from entity metadata.

Specified by:

delete in interface ReactiveDocumentOperations

Overrides:

delete in class AbstractReactiveElasticsearchTemplate

Parameters:

entity - must not be null.

index - the target index, must not be null

Returns:

a Mono emitting the id of the removed document.

delete

public Mono<String> delete(String id,
 IndexCoordinates index)

Description copied from interface: ReactiveDocumentOperations

Delete the entity with given id.

Specified by:

delete in interface ReactiveDocumentOperations

Overrides:

delete in class AbstractReactiveElasticsearchTemplate

Parameters:

id - must not be null.

index - the target index, must not be null

Returns:

a Mono emitting the id of the removed document.

search

public <T> Flux<SearchHit<T>> search(Query query,
 Class<?> entityType,
 Class<T> resultType,
 IndexCoordinates index)

Description copied from interface: ReactiveSearchOperations

Search the index for entities matching the given query.

Specified by:

search in interface ReactiveSearchOperations

Overrides:

search in class AbstractReactiveElasticsearchTemplate

Type Parameters:

T -

Parameters:

query - must not be null.

entityType - must not be null.

resultType - the projection result type.

index - the target index, must not be null

Returns:

a Flux emitting matching entities one by one wrapped in a SearchHit.

count

public Mono<Long> count(Query query,
 Class<?> entityType,
 IndexCoordinates index)

Description copied from interface: ReactiveSearchOperations

Count the number of documents matching the given Query.

Specified by:

count in interface ReactiveSearchOperations

Overrides:

count in class AbstractReactiveElasticsearchTemplate

Parameters:

query - must not be null.

entityType - must not be null.

index - the target index, must not be null

Returns:

a Mono emitting the nr of matching documents.

doIndex

protected <T>
Mono<Tuple2<T, AbstractReactiveElasticsearchTemplate.IndexResponseMetaData>> doIndex(T entity,
 IndexCoordinates index)

Specified by:

doIndex in class AbstractReactiveElasticsearchTemplate

saveAll

public <T> Flux<T> saveAll(Mono<? extends Collection<? extends T>> entitiesPublisher,
 IndexCoordinates index)

Description copied from interface: ReactiveDocumentOperations

Index entities in the given index. If the index is null or empty the index name provided via entity metadata is used.

Type Parameters:

T -

Parameters:

entitiesPublisher - must not be null.

index - the target index, must not be null

Returns:

a Flux emitting saved entities.

doExists

protected Mono<Boolean> doExists(String id,
 IndexCoordinates index)

Specified by:

doExists in class AbstractReactiveElasticsearchTemplate

delete

public Mono<ByQueryResponse> delete(DeleteQuery query,
 Class<?> entityType,
 IndexCoordinates index)

Description copied from interface: ReactiveDocumentOperations

Delete the documents matching the given Query extracting index from entity metadata.

Parameters:

query - must not be null.

entityType - must not be null.

index - the target index, must not be null

Returns:

a Mono emitting the number of the removed documents.

get

public <T> Mono<T> get(String id,
 Class<T> entityType,
 IndexCoordinates index)

Description copied from interface: ReactiveDocumentOperations

Fetch the entity with given id.

Type Parameters:

T -

Parameters:

id - must not be null.

index - the target index, must not be null

Returns:

the Mono emitting the entity or signalling completion if none found.

reindex

public Mono<ReindexResponse> reindex(ReindexRequest reindexRequest)

Description copied from interface: ReactiveDocumentOperations

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:

a Mono emitting the reindex response

submitReindex

public Mono<String> submitReindex(ReindexRequest reindexRequest)

Description copied from interface: ReactiveDocumentOperations

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

Parameters:

reindexRequest - reindex request parameters

Returns:

a Mono emitting the task id.

update

public Mono<UpdateResponse> update(UpdateQuery updateQuery,
 IndexCoordinates index)

Description copied from interface: ReactiveDocumentOperations

Partial update of the document.

Parameters:

updateQuery - query defining the update

index - the index where to update the records

Returns:

a Mono emitting the update response

updateByQuery

public Mono<ByQueryResponse> updateByQuery(UpdateQuery updateQuery,
 IndexCoordinates index)

Description copied from interface: ReactiveDocumentOperations

Update document(s) by query.

Parameters:

updateQuery - query defining the update, must not be null

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

Returns:

a Mono emitting the update response

bulkUpdate

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

Description copied from interface: ReactiveDocumentOperations

Bulk update all objects. Will do update.

Parameters:

queries - the queries to execute in bulk

bulkOptions - options to be added to the bulk request

doDeleteById

protected Mono<String> doDeleteById(String id,
 @Nullable String routing,
 IndexCoordinates index)

Specified by:

doDeleteById in class AbstractReactiveElasticsearchTemplate

multiGet

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

Description copied from interface: ReactiveDocumentOperations

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:

flux with list of MultiGetItems that contain the entities

See Also:

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

doCopy

protected ReactiveElasticsearchTemplate doCopy()

Specified by:

doCopy in class AbstractReactiveElasticsearchTemplate

customizeCopy

protected void customizeCopy(AbstractReactiveElasticsearchTemplate copy)

Description copied from class: AbstractReactiveElasticsearchTemplate

Hook for subclasses to copy additional state during AbstractReactiveElasticsearchTemplate.copy(). Called after all common fields have been copied. The default implementation does nothing.

Overrides:

customizeCopy in class AbstractReactiveElasticsearchTemplate

Parameters:

copy - the new template instance to customize

doFind

protected Flux<SearchDocument> doFind(Query query,
 Class<?> clazz,
 IndexCoordinates index)

Specified by:

doFind in class AbstractReactiveElasticsearchTemplate

doCount

protected Mono<Long> doCount(Query query,
 Class<?> entityType,
 IndexCoordinates index)

Specified by:

doCount in class AbstractReactiveElasticsearchTemplate

doFindForResponse

protected <T> Mono<SearchDocumentResponse> doFindForResponse(Query query,
 Class<?> clazz,
 IndexCoordinates index)

Specified by:

doFindForResponse in class AbstractReactiveElasticsearchTemplate

aggregate

public Flux<? extends AggregationContainer<?>> aggregate(Query query,
 Class<?> entityType,
 IndexCoordinates index)

Description copied from interface: ReactiveSearchOperations

Perform an aggregation specified by the given query.

Parameters:

query - must not be null.

entityType - must not be null.

index - the target index, must not be null

Returns:

a Flux emitting matching aggregations one by one.

openPointInTime

public Mono<String> openPointInTime(IndexCoordinates index,
 Duration keepAlive,
 Boolean ignoreUnavailable)

Description copied from interface: ReactiveSearchOperations

Opens a point in time (pit) in Elasticsearch.

Specified by:

openPointInTime in interface ReactiveSearchOperations

Overrides:

openPointInTime in class AbstractReactiveElasticsearchTemplate

Parameters:

index - the index name(s) to use

keepAlive - the duration the pit shoult be kept alive

ignoreUnavailable - if {$literal true} the call will fail if any of the indices is missing or closed

Returns:

the pit identifier

closePointInTime

public Mono<Boolean> closePointInTime(String pit)

Description copied from interface: ReactiveSearchOperations

Closes a point in time

Specified by:

closePointInTime in interface ReactiveSearchOperations

Overrides:

closePointInTime in class AbstractReactiveElasticsearchTemplate

Parameters:

pit - the pit identifier as returned by ReactiveSearchOperations.openPointInTime(IndexCoordinates, Duration, Boolean)

Returns:

true on success

putScript

public Mono<Boolean> putScript(Script script)

Description copied from interface: ReactiveScriptOperations

Stores the given script in the Elasticsearch cluster.

Specified by:

putScript in interface ReactiveScriptOperations

Overrides:

putScript in class AbstractReactiveElasticsearchTemplate

Returns:

{true if successful

getScript

public Mono<Script> getScript(String name)

Description copied from interface: ReactiveScriptOperations

Gest the script with the given name.

Specified by:

getScript in interface ReactiveScriptOperations

Overrides:

getScript in class AbstractReactiveElasticsearchTemplate

Parameters:

name - the name of the script

Returns:

Script or null when a script with this name does not exist.

deleteScript

public Mono<Boolean> deleteScript(String name)

Description copied from interface: ReactiveScriptOperations

Deletes the script with the given name

Specified by:

deleteScript in interface ReactiveScriptOperations

Overrides:

deleteScript in class AbstractReactiveElasticsearchTemplate

Parameters:

name - the name of the script.

Returns:

true if the request was acknowledged by the cluster.

getVendor

public Mono<String> getVendor()

Specified by:

getVendor in class AbstractReactiveElasticsearchTemplate

Returns:

the vendor name of the used cluster and client library

getRuntimeLibraryVersion

public Mono<String> getRuntimeLibraryVersion()

Specified by:

getRuntimeLibraryVersion in class AbstractReactiveElasticsearchTemplate

Returns:

the version of the used client runtime library.

getClusterVersion

public Mono<String> getClusterVersion()

Specified by:

getClusterVersion in class AbstractReactiveElasticsearchTemplate

indexOps

public ReactiveIndexOperations indexOps(IndexCoordinates index)

Description copied from interface: ReactiveElasticsearchOperations

Creates a ReactiveIndexOperations that is bound to the given index

Parameters:

index - IndexCoordinates specifying the index

Returns:

ReactiveIndexOperations implementation

indexOps

public ReactiveIndexOperations indexOps(Class<?> clazz)

Description copied from interface: ReactiveElasticsearchOperations

Creates a ReactiveIndexOperations that is bound to the given class

Parameters:

clazz - the entity clazz specifiying the index information

Returns:

ReactiveIndexOperations implementation

cluster

public ReactiveClusterOperations cluster()

Description copied from interface: ReactiveElasticsearchOperations

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

Returns:

ClusterOperations implementation

matchAllQuery

public Query matchAllQuery()

Description copied from interface: ReactiveSearchOperations

Creates a Query to find 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: ReactiveSearchOperations

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

queryBuilderWithIds

public BaseQueryBuilder queryBuilderWithIds(List<String> ids)

Description copied from interface: ReactiveSearchOperations

Creates a BaseQueryBuilder that has the given ids setto the parameter value. No other properties of the bulder are set.

Parameters:

ids - the list of ids must not be null

Returns:

query returning the documents with the given ids

search

public Mono<SqlResponse> search(SqlQuery query)

Description copied from interface: ReactiveSqlOperations

Execute the sql query against elasticsearch and return result as SqlResponse

Parameters:

query - the query to execute

Returns:

SqlResponse containing the list of found objects

execute

public <T> Publisher<T> execute(ReactiveElasticsearchTemplate.ClientCallback<Publisher<T>> callback)

Execute a callback with the ReactiveElasticsearchClient and provide exception translation.

Type Parameters:

T - the type returned from the callback

Parameters:

callback - the callback to execute, must not be null

Returns:

the callback result