org.springframework.data.elasticsearch.core

Class ReactiveElasticsearchTemplate

java.lang.Object

org.springframework.data.elasticsearch.core.ReactiveElasticsearchTemplate

All Implemented Interfaces:

ReactiveElasticsearchOperations

public class ReactiveElasticsearchTemplate
extends Object
implements ReactiveElasticsearchOperations

Since:

3.2

Author:

Christoph Strobl, Mark Paluch, Farid Azaza, Martin Choraine, Peter-Josef Meisch, Mathias Teier

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.data.elasticsearch.core.ReactiveElasticsearchOperations

ReactiveElasticsearchOperations.ClientCallback<T extends org.reactivestreams.Publisher<?>>

Constructor Summary

Constructors

Constructor and Description
ReactiveElasticsearchTemplate(ReactiveElasticsearchClient client)
ReactiveElasticsearchTemplate(ReactiveElasticsearchClient client, ElasticsearchConverter converter)
ReactiveElasticsearchTemplate(ReactiveElasticsearchClient client, ElasticsearchConverter converter, ResultsMapper resultsMapper)

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<Long>	count(Query query, Class<?> entityType, String index, String type) Count the number of documents matching the given Query.
reactor.core.publisher.Mono<String>	delete(Object entity, String index, String type) Delete the given entity extracting index and type from entity metadata.
reactor.core.publisher.Mono<Long>	deleteBy(Query query, Class<?> entityType, String index, String type) Delete the documents matching the given Query extracting index and type from entity metadata.
reactor.core.publisher.Mono<String>	deleteById(String id, Class<?> entityType, String index, String type) Delete the entity with given id extracting index and type from entity metadata.
protected reactor.core.publisher.Mono<Long>	doCount(org.elasticsearch.client.core.CountRequest request) Customization hook on the actual execution result Publisher.
protected reactor.core.publisher.Mono<String>	doDelete(org.elasticsearch.action.delete.DeleteRequest request) Customization hook on the actual execution result Publisher.
protected reactor.core.publisher.Mono<org.elasticsearch.index.reindex.BulkByScrollResponse>	doDeleteBy(org.elasticsearch.index.reindex.DeleteByQueryRequest request) Customization hook on the actual execution result Publisher.
protected reactor.core.publisher.Mono<Boolean>	doExists(org.elasticsearch.action.get.GetRequest request) Customization hook on the actual execution result Publisher.
protected reactor.core.publisher.Flux<org.elasticsearch.search.SearchHit>	doFind(org.elasticsearch.action.search.SearchRequest request) Customization hook on the actual execution result Publisher.
protected reactor.core.publisher.Mono<org.elasticsearch.index.get.GetResult>	doFindById(org.elasticsearch.action.get.GetRequest request) Customization hook on the actual execution result Publisher.
protected reactor.core.publisher.Mono<org.elasticsearch.action.index.IndexResponse>	doIndex(org.elasticsearch.action.index.IndexRequest request) Customization hook on the actual execution result Publisher.
protected reactor.core.publisher.Flux<org.elasticsearch.search.SearchHit>	doScroll(org.elasticsearch.action.search.SearchRequest request) Customization hook on the actual execution result Publisher.
<T> org.reactivestreams.Publisher<T>	execute(ReactiveElasticsearchOperations.ClientCallback<org.reactivestreams.Publisher<T>> callback) Execute within a ReactiveElasticsearchOperations.ClientCallback managing resources and translating errors.
reactor.core.publisher.Mono<Boolean>	exists(String id, Class<?> entityType, String index, String type) Check if an entity with given id exists.
<T> reactor.core.publisher.Flux<T>	find(Query query, Class<?> entityType, String index, String type, Class<T> resultType) Search the index for entities matching the given query.
<T> reactor.core.publisher.Mono<T>	findById(String id, Class<T> entityType, String index, String type) Fetch the entity with given id.
protected ReactiveElasticsearchClient	getClient() Obtain the ReactiveElasticsearchClient to operate upon.
ElasticsearchConverter	getElasticsearchConverter() Get the ElasticsearchConverter used.
protected org.elasticsearch.client.core.CountRequest	prepareCountRequest(org.elasticsearch.client.core.CountRequest request) Customization hook to modify a generated SearchRequest prior to its execution.
protected org.elasticsearch.index.reindex.DeleteByQueryRequest	prepareDeleteByRequest(org.elasticsearch.index.reindex.DeleteByQueryRequest request) Customization hook to modify a generated DeleteByQueryRequest prior to its execution.
protected org.elasticsearch.action.delete.DeleteRequest	prepareDeleteRequest(Object source, org.elasticsearch.action.delete.DeleteRequest request) Customization hook to modify a generated DeleteRequest prior to its execution.
protected org.elasticsearch.action.index.IndexRequest	prepareIndexRequest(Object source, org.elasticsearch.action.index.IndexRequest request) Customization hook to modify a generated IndexRequest prior to its execution.
protected org.elasticsearch.action.search.SearchRequest	prepareSearchRequest(org.elasticsearch.action.search.SearchRequest request) Customization hook to modify a generated SearchRequest prior to its execution.
protected <R extends org.elasticsearch.action.support.WriteRequest<R>> R	prepareWriteRequest(R request) Pre process the write request before it is sent to the server, eg. by setting the refresh policy if applicable.
<T> reactor.core.publisher.Mono<T>	save(T entity, String index, String type) Index the entity under the given type in the given index.
void	setIndicesOptions(org.elasticsearch.action.support.IndicesOptions indicesOptions) Set the default IndicesOptions for search requests.
void	setRefreshPolicy(org.elasticsearch.action.support.WriteRequest.RefreshPolicy refreshPolicy) Set the default WriteRequest.RefreshPolicy to apply when writing to Elasticsearch.

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.ReactiveElasticsearchOperations

count, count, count, delete, delete, deleteBy, deleteBy, deleteById, deleteById, deleteById, exists, exists, find, find, find, find, findById, findById, save, save, save, save, save

Constructor Detail

ReactiveElasticsearchTemplate

public ReactiveElasticsearchTemplate(ReactiveElasticsearchClient client)

ReactiveElasticsearchTemplate

public ReactiveElasticsearchTemplate(ReactiveElasticsearchClient client,
                                     ElasticsearchConverter converter)

ReactiveElasticsearchTemplate

public ReactiveElasticsearchTemplate(ReactiveElasticsearchClient client,
                                     ElasticsearchConverter converter,
                                     ResultsMapper resultsMapper)

Method Detail

execute

public <T> org.reactivestreams.Publisher<T> execute(ReactiveElasticsearchOperations.ClientCallback<org.reactivestreams.Publisher<T>> callback)

Description copied from interface: ReactiveElasticsearchOperations

Execute within a ReactiveElasticsearchOperations.ClientCallback managing resources and translating errors.

Specified by:

execute in interface ReactiveElasticsearchOperations

Parameters:

callback - must not be null.

Returns:

the Publisher emitting results.

save

public <T> reactor.core.publisher.Mono<T> save(T entity,
                                               @Nullable
                                               String index,
                                               @Nullable
                                               String type)

Description copied from interface: ReactiveElasticsearchOperations

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 ReactiveElasticsearchOperations

Parameters:

entity - must not be null.

index - the name of the target index. Can be null.

type - the name of the type within the index. Can be null.

Returns:

a Mono emitting the saved entity.

findById

public <T> reactor.core.publisher.Mono<T> findById(String id,
                                                   Class<T> entityType,
                                                   @Nullable
                                                   String index,
                                                   @Nullable
                                                   String type)

Description copied from interface: ReactiveElasticsearchOperations

Fetch the entity with given id.

Specified by:

findById in interface ReactiveElasticsearchOperations

Parameters:

id - must not be null.

index - the name of the target index. Overwrites document metadata from entityType if not null.

type - the name of the target type. Overwrites document metadata from entityType if not null.

Returns:

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

exists

public reactor.core.publisher.Mono<Boolean> exists(String id,
                                                   Class<?> entityType,
                                                   String index,
                                                   String type)

Description copied from interface: ReactiveElasticsearchOperations

Check if an entity with given id exists.

Specified by:

exists in interface ReactiveElasticsearchOperations

Parameters:

id - the _id of the document to look for.

index - the name of the target index. Overwrites document metadata from entityType if not null.

type - the name of the target type. Overwrites document metadata from entityType if not null.

Returns:

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

find

public <T> reactor.core.publisher.Flux<T> find(Query query,
                                               Class<?> entityType,
                                               @Nullable
                                               String index,
                                               @Nullable
                                               String type,
                                               Class<T> resultType)

Description copied from interface: ReactiveElasticsearchOperations

Search the index for entities matching the given query.

Specified by:

find in interface ReactiveElasticsearchOperations

Parameters:

query - must not be null.

entityType - must not be null.

index - the name of the target index. Overwrites document metadata from entityType if not null.

type - the name of the target type. Overwrites document metadata from entityType if not null.

resultType - the projection result type.

Returns:

a Flux emitting matching entities one by one.

count

public reactor.core.publisher.Mono<Long> count(Query query,
                                               Class<?> entityType,
                                               String index,
                                               String type)

Description copied from interface: ReactiveElasticsearchOperations

Count the number of documents matching the given Query.

Specified by:

count in interface ReactiveElasticsearchOperations

Parameters:

query - must not be null.

entityType - must not be null.

index - the name of the target index. Overwrites document metadata from entityType if not null.

type - the name of the target type. Overwrites document metadata from entityType if not null.

Returns:

a Mono emitting the nr of matching documents.

delete

public reactor.core.publisher.Mono<String> delete(Object entity,
                                                  @Nullable
                                                  String index,
                                                  @Nullable
                                                  String type)

Description copied from interface: ReactiveElasticsearchOperations

Delete the given entity extracting index and type from entity metadata.

Specified by:

delete in interface ReactiveElasticsearchOperations

Parameters:

entity - must not be null.

index - the name of the target index. Overwrites document metadata from entityType if not null.

type - the name of the target type. Overwrites document metadata from entityType if not null.

Returns:

a Mono emitting the id of the removed document.

deleteById

public reactor.core.publisher.Mono<String> deleteById(String id,
                                                      Class<?> entityType,
                                                      @Nullable
                                                      String index,
                                                      @Nullable
                                                      String type)

Description copied from interface: ReactiveElasticsearchOperations

Delete the entity with given id extracting index and type from entity metadata.

Specified by:

deleteById in interface ReactiveElasticsearchOperations

Parameters:

id - must not be null.

entityType - must not be null.

index - the name of the target index. Overwrites document metadata from entityType if not null.

type - the name of the target type. Overwrites document metadata from entityType if not null.

Returns:

a Mono emitting the id of the removed document.

deleteBy

public reactor.core.publisher.Mono<Long> deleteBy(Query query,
                                                  Class<?> entityType,
                                                  String index,
                                                  String type)

Description copied from interface: ReactiveElasticsearchOperations

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

Specified by:

deleteBy in interface ReactiveElasticsearchOperations

Parameters:

query - must not be null.

entityType - must not be null.

index - the name of the target index. Overwrites document metadata from entityType if not null.

type - the name of the target type. Overwrites document metadata from entityType if not null.

Returns:

a Mono emitting the number of the removed documents.

setRefreshPolicy

public void setRefreshPolicy(@Nullable
                             org.elasticsearch.action.support.WriteRequest.RefreshPolicy refreshPolicy)

Set the default WriteRequest.RefreshPolicy to apply when writing to Elasticsearch.

Parameters:

refreshPolicy - can be null.

setIndicesOptions

public void setIndicesOptions(@Nullable
                              org.elasticsearch.action.support.IndicesOptions indicesOptions)

Set the default IndicesOptions for search requests.

Parameters:

indicesOptions - can be null.

getElasticsearchConverter

public ElasticsearchConverter getElasticsearchConverter()

Description copied from interface: ReactiveElasticsearchOperations

Get the ElasticsearchConverter used.

Specified by:

getElasticsearchConverter in interface ReactiveElasticsearchOperations

Returns:

never null

getClient

protected ReactiveElasticsearchClient getClient()

Obtain the ReactiveElasticsearchClient to operate upon.

Returns:

never null.

prepareWriteRequest

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

Pre process the write request before it is sent to the server, eg. by setting the refresh policy if applicable.

Type Parameters:

R -

Parameters:

request - must not be null.

Returns:

the processed WriteRequest.

prepareIndexRequest

protected org.elasticsearch.action.index.IndexRequest prepareIndexRequest(Object source,
                                                                          org.elasticsearch.action.index.IndexRequest request)

Customization hook to modify a generated IndexRequest prior to its execution. Eg. by setting the refresh policy if applicable.

Parameters:

source - the source object the IndexRequest was derived from.

request - the generated IndexRequest.

Returns:

never null.

prepareCountRequest

protected org.elasticsearch.client.core.CountRequest prepareCountRequest(org.elasticsearch.client.core.CountRequest request)

Customization hook to modify a generated SearchRequest prior to its execution. Eg. by setting the indices options if applicable.

Parameters:

request - the generated CountRequest.

Returns:

never null.

prepareSearchRequest

protected org.elasticsearch.action.search.SearchRequest prepareSearchRequest(org.elasticsearch.action.search.SearchRequest request)

Customization hook to modify a generated SearchRequest prior to its execution. Eg. by setting the indices options if applicable.

Parameters:

request - the generated SearchRequest.

Returns:

never null.

prepareDeleteRequest

protected org.elasticsearch.action.delete.DeleteRequest prepareDeleteRequest(@Nullable
                                                                             Object source,
                                                                             org.elasticsearch.action.delete.DeleteRequest request)

Customization hook to modify a generated DeleteRequest prior to its execution. Eg. by setting the refresh policy if applicable.

Parameters:

source - the source object the DeleteRequest was derived from. My be null if using the id directly.

request - the generated DeleteRequest.

Returns:

never null.

prepareDeleteByRequest

protected org.elasticsearch.index.reindex.DeleteByQueryRequest prepareDeleteByRequest(org.elasticsearch.index.reindex.DeleteByQueryRequest request)

Customization hook to modify a generated DeleteByQueryRequest prior to its execution. Eg. by setting the refresh policy if applicable.

Parameters:

request - the generated DeleteByQueryRequest.

Returns:

never null.

doIndex

protected reactor.core.publisher.Mono<org.elasticsearch.action.index.IndexResponse> doIndex(org.elasticsearch.action.index.IndexRequest request)

Customization hook on the actual execution result Publisher.
You know what you're doing here? Well fair enough, go ahead on your own risk.

Parameters:

request - the already prepared IndexRequest ready to be executed.

Returns:

a Mono emitting the result of the operation.

doFindById

protected reactor.core.publisher.Mono<org.elasticsearch.index.get.GetResult> doFindById(org.elasticsearch.action.get.GetRequest request)

Customization hook on the actual execution result Publisher.

Parameters:

request - the already prepared GetRequest ready to be executed.

Returns:

a Mono emitting the result of the operation.

doExists

protected reactor.core.publisher.Mono<Boolean> doExists(org.elasticsearch.action.get.GetRequest request)

Customization hook on the actual execution result Publisher.

Parameters:

request - the already prepared GetRequest ready to be executed.

Returns:

a Mono emitting the result of the operation.

doFind

protected reactor.core.publisher.Flux<org.elasticsearch.search.SearchHit> doFind(org.elasticsearch.action.search.SearchRequest request)

Customization hook on the actual execution result Publisher.

Parameters:

request - the already prepared SearchRequest ready to be executed.

Returns:

a Flux emitting the result of the operation.

doCount

protected reactor.core.publisher.Mono<Long> doCount(org.elasticsearch.client.core.CountRequest request)

Customization hook on the actual execution result Publisher.

Parameters:

request - the already prepared CountRequest ready to be executed.

Returns:

a Mono emitting the result of the operation.

doScroll

protected reactor.core.publisher.Flux<org.elasticsearch.search.SearchHit> doScroll(org.elasticsearch.action.search.SearchRequest request)

Customization hook on the actual execution result Publisher.

Parameters:

request - the already prepared SearchRequest ready to be executed.

Returns:

a Flux emitting the result of the operation.

doDelete

protected reactor.core.publisher.Mono<String> doDelete(org.elasticsearch.action.delete.DeleteRequest request)

Customization hook on the actual execution result Publisher.

Parameters:

request - the already prepared DeleteRequest ready to be executed.

Returns:

a Mono emitting the result of the operation.

doDeleteBy

protected reactor.core.publisher.Mono<org.elasticsearch.index.reindex.BulkByScrollResponse> doDeleteBy(org.elasticsearch.index.reindex.DeleteByQueryRequest request)

Customization hook on the actual execution result Publisher.

Parameters:

request - the already prepared DeleteByQueryRequest ready to be executed.

Returns:

a Mono emitting the result of the operation.