org.springframework.data.elasticsearch.core

Interface ReactiveSearchOperations

All Known Subinterfaces:

ReactiveElasticsearchOperations

All Known Implementing Classes:

ReactiveElasticsearchTemplate

public interface ReactiveSearchOperations

The reactive operations for the Elasticsearch Document APIs.

Since:

4.0

Author:

Peter-Josef Meisch, Russell Parry, Thomas Geese

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Flux<org.elasticsearch.search.aggregations.Aggregation>	aggregate(Query query, Class<?> entityType) Perform an aggregation specified by the given query.
reactor.core.publisher.Flux<org.elasticsearch.search.aggregations.Aggregation>	aggregate(Query query, Class<?> entityType, IndexCoordinates index) Perform an aggregation specified by the given query.
default reactor.core.publisher.Mono<Long>	count(Class<?> entityType) Count the number of documents matching the given Query.
reactor.core.publisher.Mono<Long>	count(Query query, Class<?> entityType) Count the number of documents matching the given Query.
reactor.core.publisher.Mono<Long>	count(Query query, Class<?> entityType, IndexCoordinates index) Count the number of documents matching the given Query.
default <T> reactor.core.publisher.Flux<T>	find(Query query, Class<?> entityType, Class<T> returnType) Deprecated. since 4.0, use search(Query, Class, Class).
default <T> reactor.core.publisher.Flux<T>	find(Query query, Class<?> entityType, Class<T> resultType, IndexCoordinates index) Deprecated. since 4.0, use search(Query, Class, Class, IndexCoordinates).
default <T> reactor.core.publisher.Flux<T>	find(Query query, Class<T> entityType) Deprecated. since 4.0, use search(Query, Class).
default <T> reactor.core.publisher.Flux<T>	find(Query query, Class<T> entityType, IndexCoordinates index) Deprecated. since 4.0, use search(Query, Class, IndexCoordinates)
<T> reactor.core.publisher.Flux<SearchHit<T>>	search(Query query, Class<?> entityType, Class<T> returnType) Search the index for entities matching the given query.
<T> reactor.core.publisher.Flux<SearchHit<T>>	search(Query query, Class<?> entityType, Class<T> resultType, IndexCoordinates index) Search the index for entities matching the given query.
default <T> reactor.core.publisher.Flux<SearchHit<T>>	search(Query query, Class<T> entityType) Search the index for entities matching the given query.
default <T> reactor.core.publisher.Flux<SearchHit<T>>	search(Query query, Class<T> entityType, IndexCoordinates index) Search the index for entities matching the given query.
<T> reactor.core.publisher.Mono<SearchPage<T>>	searchForPage(Query query, Class<?> entityType, Class<T> resultType) Search the index for entities matching the given query.
<T> reactor.core.publisher.Mono<SearchPage<T>>	searchForPage(Query query, Class<?> entityType, Class<T> resultType, IndexCoordinates index) Search the index for entities matching the given query.
default <T> reactor.core.publisher.Mono<SearchPage<T>>	searchForPage(Query query, Class<T> entityType) Search the index for entities matching the given query.
default <T> reactor.core.publisher.Mono<SearchPage<T>>	searchForPage(Query query, Class<T> entityType, IndexCoordinates index) Search the index for entities matching the given query.
reactor.core.publisher.Flux<org.elasticsearch.search.suggest.Suggest>	suggest(org.elasticsearch.search.suggest.SuggestBuilder suggestion, Class<?> entityType) Does a suggest query
reactor.core.publisher.Flux<org.elasticsearch.search.suggest.Suggest>	suggest(org.elasticsearch.search.suggest.SuggestBuilder suggestion, IndexCoordinates index) Does a suggest query

Method Detail

find

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

Deprecated. since 4.0, use search(Query, Class).

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 wrapped in a SearchHit.

find

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

Deprecated. since 4.0, use search(Query, Class, Class).

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 wrapped in a SearchHit.

find

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

Deprecated. since 4.0, use search(Query, Class, IndexCoordinates)

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 target index, must not be null

Returns:

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

find

@Deprecated
default <T> reactor.core.publisher.Flux<T> find(Query query,
                                                            Class<?> entityType,
                                                            Class<T> resultType,
                                                            IndexCoordinates index)

Deprecated. since 4.0, use search(Query, Class, Class, IndexCoordinates).

Search the index for entities matching the given query.

Type Parameters:

T -

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

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

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

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

Count the number of documents matching the given Query.

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.

search

default <T> reactor.core.publisher.Flux<SearchHit<T>> search(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 wrapped in a SearchHit.

search

<T> reactor.core.publisher.Flux<SearchHit<T>> search(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 wrapped in a SearchHit.

search

default <T> reactor.core.publisher.Flux<SearchHit<T>> search(Query query,
                                                             Class<T> entityType,
                                                             IndexCoordinates index)

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 target index, must not be null

Returns:

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

search

<T> reactor.core.publisher.Flux<SearchHit<T>> search(Query query,
                                                     Class<?> entityType,
                                                     Class<T> resultType,
                                                     IndexCoordinates index)

Search the index for entities matching the given query.

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.

searchForPage

default <T> reactor.core.publisher.Mono<SearchPage<T>> searchForPage(Query query,
                                                                     Class<T> entityType)

Search the index for entities matching the given query.

Type Parameters:

T -

T -

Parameters:

query - must not be null.

entityType - must not be null.

Returns:

a Mono emitting matching entities in a SearchHits.

Since:

4.1

searchForPage

<T> reactor.core.publisher.Mono<SearchPage<T>> searchForPage(Query query,
                                                             Class<?> entityType,
                                                             Class<T> resultType)

Search the index for entities matching the given query.

Type Parameters:

T -

T -

Parameters:

query - must not be null.

entityType - must not be null.

resultType - the projection result type.

Returns:

a Mono emitting matching entities in a SearchHits.

Since:

4.1

searchForPage

default <T> reactor.core.publisher.Mono<SearchPage<T>> searchForPage(Query query,
                                                                     Class<T> entityType,
                                                                     IndexCoordinates index)

Search the index for entities matching the given query.

Type Parameters:

T -

T -

Parameters:

query - must not be null.

entityType - must not be null.

index - the target index, must not be null

Returns:

a Mono emitting matching entities in a SearchHits.

Since:

4.1

searchForPage

<T> reactor.core.publisher.Mono<SearchPage<T>> searchForPage(Query query,
                                                             Class<?> entityType,
                                                             Class<T> resultType,
                                                             IndexCoordinates index)

Search the index for entities matching the given query.

Type Parameters:

T -

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 Mono emitting matching entities in a SearchHits.

Since:

4.1

aggregate

reactor.core.publisher.Flux<org.elasticsearch.search.aggregations.Aggregation> aggregate(Query query,
                                                                                         Class<?> entityType)

Perform an aggregation specified by the given query.

Parameters:

query - must not be null.

entityType - must not be null.

Returns:

a Flux emitting matching aggregations one by one.

Since:

4.0

aggregate

reactor.core.publisher.Flux<org.elasticsearch.search.aggregations.Aggregation> aggregate(Query query,
                                                                                         Class<?> entityType,
                                                                                         IndexCoordinates index)

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.

Since:

4.0

suggest

reactor.core.publisher.Flux<org.elasticsearch.search.suggest.Suggest> suggest(org.elasticsearch.search.suggest.SuggestBuilder suggestion,
                                                                              Class<?> entityType)

Does a suggest query

Parameters:

suggestion - the query

entityType - must not be null.

Returns:

the suggest response

suggest

reactor.core.publisher.Flux<org.elasticsearch.search.suggest.Suggest> suggest(org.elasticsearch.search.suggest.SuggestBuilder suggestion,
                                                                              IndexCoordinates index)

Does a suggest query

Parameters:

suggestion - the query

index - the index to run the query against

Returns:

the suggest response