org.springframework.data.elasticsearch.core

Interface ReactiveElasticsearchOperations

All Known Implementing Classes:

ReactiveElasticsearchTemplate

public interface ReactiveElasticsearchOperations

Interface that specifies a basic set of Elasticsearch operations executed in a reactive way.

Implemented by ReactiveElasticsearchTemplate. Not often used but a useful option for extensibility and testability (as it can be easily mocked, stubbed, or be the target of a JDK proxy). Command execution using ReactiveElasticsearchOperations is deferred until a Subscriber subscribes to the Publisher.

Since:

3.2

Author:

Christoph Strobl

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ReactiveElasticsearchOperations.ClientCallback<T extends org.reactivestreams.Publisher<?>> Callback interface to be used with execute(ClientCallback) for operating directly on ReactiveElasticsearchClient.

Method Summary

Modifier and Type	Method and Description
default reactor.core.publisher.Mono<Long>	count(Class<?> entityType) Count the number of documents matching the given Query.
default reactor.core.publisher.Mono<Long>	count(Query query, Class<?> entityType) Count the number of documents matching the given Query.
default reactor.core.publisher.Mono<Long>	count(Query query, Class<?> entityType, String index) Count the number of documents matching the given Query.
reactor.core.publisher.Mono<Long>	count(Query query, Class<?> entityType, String index, String type) Count the number of documents matching the given Query.
default reactor.core.publisher.Mono<String>	delete(Object entity) Delete the given entity extracting index and type from entity metadata.
default reactor.core.publisher.Mono<String>	delete(Object entity, String index) Delete the given entity extracting index and type from entity metadata.
reactor.core.publisher.Mono<String>	delete(Object entity, String index, String type) Delete the given entity extracting index and type from entity metadata.
default reactor.core.publisher.Mono<Long>	deleteBy(Query query, Class<?> entityType) Delete the documents matching the given Query extracting index and type from entity metadata.
default reactor.core.publisher.Mono<Long>	deleteBy(Query query, Class<?> entityType, String index) Delete the documents matching the given Query 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.
default reactor.core.publisher.Mono<String>	deleteById(String id, Class<?> entityType) Delete the entity with given id extracting index and type from entity metadata.
default reactor.core.publisher.Mono<String>	deleteById(String id, Class<?> entityType, String index) Delete the entity with given id 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.
default reactor.core.publisher.Mono<String>	deleteById(String id, String index, String type) Delete the entity with given id.
<T> org.reactivestreams.Publisher<T>	execute(ReactiveElasticsearchOperations.ClientCallback<org.reactivestreams.Publisher<T>> callback) Execute within a ReactiveElasticsearchOperations.ClientCallback managing resources and translating errors.
default reactor.core.publisher.Mono<Boolean>	exists(String id, Class<?> entityType) Check if an entity with given id exists.
default reactor.core.publisher.Mono<Boolean>	exists(String id, Class<?> entityType, String index) Check if an entity with given id exists.
reactor.core.publisher.Mono<Boolean>	exists(String id, Class<?> entityType, String index, String type) Check if an entity with given id exists.
default <T> reactor.core.publisher.Flux<T>	find(Query query, Class<?> entityType, Class<T> returnType) Search the index for entities matching the given query.
<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.
default <T> reactor.core.publisher.Flux<T>	find(Query query, Class<T> entityType) Search the index for entities matching the given query.
default <T> reactor.core.publisher.Flux<T>	find(Query query, Class<T> entityType, String index) Search the index for entities matching the given query.
default <T> reactor.core.publisher.Flux<T>	find(Query query, Class<T> entityType, String index, String type) Search the index for entities matching the given query.
default <T> reactor.core.publisher.Mono<T>	findById(String id, Class<T> entityType) Find the document with the given id mapped onto the given entityType.
default <T> reactor.core.publisher.Mono<T>	findById(String id, Class<T> entityType, String index) Fetch the entity with given id.
<T> reactor.core.publisher.Mono<T>	findById(String id, Class<T> entityType, String index, String type) Fetch the entity with given id.
ElasticsearchConverter	getElasticsearchConverter() Get the ElasticsearchConverter used.
default <T> reactor.core.publisher.Mono<T>	save(reactor.core.publisher.Mono<? extends T> entityPublisher) Index the given entity, once available, extracting index and type from entity metadata.
default <T> reactor.core.publisher.Mono<T>	save(reactor.core.publisher.Mono<? extends T> entityPublisher, String index) Index the entity, once available, in the given index.
default <T> reactor.core.publisher.Mono<T>	save(reactor.core.publisher.Mono<? extends T> entityPublisher, String index, String type) Index the entity, once available, under the given type in the given index.
default <T> reactor.core.publisher.Mono<T>	save(T entity) Index the given entity extracting index and type from entity metadata.
default <T> reactor.core.publisher.Mono<T>	save(T entity, String index) Index the entity in the given index.
<T> reactor.core.publisher.Mono<T>	save(T entity, String index, String type) Index the entity under the given type in the given index.

Method Detail

execute

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

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

Type Parameters:

T -

Parameters:

callback - must not be null.

Returns:

the Publisher emitting results.

save

default <T> reactor.core.publisher.Mono<T> save(reactor.core.publisher.Mono<? extends T> entityPublisher)

Index the given entity, once available, extracting index and type from entity metadata.

Type Parameters:

T -

Parameters:

entityPublisher - must not be null.

Returns:

a Mono emitting the saved entity.

save

default <T> reactor.core.publisher.Mono<T> save(T entity)

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

Type Parameters:

T -

Parameters:

entity - must not be null.

Returns:

a Mono emitting the saved entity.

save

default <T> reactor.core.publisher.Mono<T> save(reactor.core.publisher.Mono<? extends T> entityPublisher,
                                                String index)

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

Type Parameters:

T -

Parameters:

entityPublisher - must not be null.

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

Returns:

a Mono emitting the saved entity.

save

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

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

Type Parameters:

T -

Parameters:

entity - must not be null.

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

Returns:

a Mono emitting the saved entity.

save

default <T> reactor.core.publisher.Mono<T> save(reactor.core.publisher.Mono<? extends T> entityPublisher,
                                                @Nullable
                                                String index,
                                                @Nullable
                                                String type)

Index the entity, once available, 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.

Type Parameters:

T -

Parameters:

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

save

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

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.

Type Parameters:

T -

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

default <T> reactor.core.publisher.Mono<T> findById(String id,
                                                    Class<T> entityType)

Find the document with the given id mapped onto the given entityType.

Type Parameters:

T -

Parameters:

id - the _id of the document to fetch.

entityType - the domain type used for mapping the document.

Returns:

Mono.empty() if not found.

findById

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

Fetch the entity with given id.

Type Parameters:

T -

Parameters:

id - the _id of the document to fetch.

entityType - the domain type used for mapping the document.

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

Returns:

Mono.empty() if not found.

findById

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

Fetch the entity with given id.

Type Parameters:

T -

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

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

Check if an entity with given id exists.

Parameters:

id - the _id of the document to look for.

entityType - the domain type used.

Returns:

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

exists

default reactor.core.publisher.Mono<Boolean> exists(String id,
                                                    Class<?> entityType,
                                                    @Nullable
                                                    String index)

Check if an entity with given id exists.

Parameters:

id - the _id of the document to look for.

entityType - the domain type used.

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

Returns:

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

exists

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

Check if an entity with given id exists.

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

default <T> reactor.core.publisher.Flux<T> find(Query query,
                                                Class<T> entityType)

Search the index for entities matching the given query.
Unpaged queries may overrule elasticsearch server defaults for page size by either delegating to the scroll API or using a max size.

Type Parameters:

T -

Parameters:

query - must not be null.

entityType - must not be null.

Returns:

a Flux emitting matching entities one by one.

find

default <T> reactor.core.publisher.Flux<T> find(Query query,
                                                Class<?> entityType,
                                                Class<T> returnType)

Search the index for entities matching the given query.
Unpaged queries may overrule elasticsearch server defaults for page size by either * delegating to the scroll API or using a max * size.

Type Parameters:

T -

Parameters:

query - must not be null.

entityType - The entity type for mapping the query. Must not be null.

returnType - The mapping target type. Must not be null. Th

Returns:

a Flux emitting matching entities one by one.

find

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

Search the index for entities matching the given query.

Type Parameters:

T -

Parameters:

query - must not be null.

entityType - must not be null.

Returns:

a Flux emitting matching entities one by one.

find

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

Search the index for entities matching the given query.

Type Parameters:

T -

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.

find

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

Search the index for entities matching the given query.

Type Parameters:

T -

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

default reactor.core.publisher.Mono<Long> count(Class<?> entityType)

Count the number of documents matching the given Query.

Parameters:

entityType - must not be null.

Returns:

a Mono emitting the nr of matching documents.

count

default reactor.core.publisher.Mono<Long> count(Query query,
                                                Class<?> entityType)

Count the number of documents matching the given Query.

Parameters:

query - must not be null.

entityType - must not be null.

Returns:

a Mono emitting the nr of matching documents.

count

default reactor.core.publisher.Mono<Long> count(Query query,
                                                Class<?> entityType,
                                                @Nullable
                                                String index)

Count the number of documents matching the given Query.

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.

Returns:

a Mono emitting the nr of matching documents.

count

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

Count the number of documents matching the given Query.

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

default reactor.core.publisher.Mono<String> delete(Object entity)

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

Parameters:

entity - must not be null.

Returns:

a Mono emitting the id of the removed document.

delete

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

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

Parameters:

entity - must not be null.

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

Returns:

a Mono emitting the id of the removed document.

delete

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

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

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

default reactor.core.publisher.Mono<String> deleteById(String id,
                                                       String index,
                                                       String type)

Delete the entity with given id.

Parameters:

id - must not be null.

index - the name of the target index.

type - the name of the target type.

Returns:

a Mono emitting the id of the removed document.

deleteById

default reactor.core.publisher.Mono<String> deleteById(String id,
                                                       Class<?> entityType)

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

Parameters:

id - must not be null.

entityType - must not be null.

Returns:

a Mono emitting the id of the removed document.

deleteById

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

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

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.

Returns:

a Mono emitting the id of the removed document.

deleteById

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

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

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

default reactor.core.publisher.Mono<Long> deleteBy(Query query,
                                                   Class<?> entityType)

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

Parameters:

query - must not be null.

entityType - must not be null.

Returns:

a Mono emitting the number of the removed documents.

deleteBy

default reactor.core.publisher.Mono<Long> deleteBy(Query query,
                                                   Class<?> entityType,
                                                   @Nullable
                                                   String index)

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

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.

Returns:

a Mono emitting the number of the removed documents.

deleteBy

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

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

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.

getElasticsearchConverter

ElasticsearchConverter getElasticsearchConverter()

Get the ElasticsearchConverter used.

Returns:

never null