Package org.springframework.data.elasticsearch.core

Class AbstractReactiveElasticsearchTemplate

java.lang.Object

org.springframework.data.elasticsearch.core.AbstractReactiveElasticsearchTemplate

All Implemented Interfaces:

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

Direct Known Subclasses:

ReactiveElasticsearchTemplate

public abstract class AbstractReactiveElasticsearchTemplate
extends Object
implements ReactiveElasticsearchOperations, ApplicationContextAware

Base class keeping common code for implementations of the ReactiveElasticsearchOperations interface independent of the used client.

Since:

4.4

Author:

Peter-Josef Meisch

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	AbstractReactiveElasticsearchTemplate.DocumentCallback<T>	Callback to convert Document into an entity of type T
protected class	AbstractReactiveElasticsearchTemplate.Entities<T>
static final record	AbstractReactiveElasticsearchTemplate.IndexResponseMetaData	Value class to capture client independent information from a response to an index request.
protected class	AbstractReactiveElasticsearchTemplate.ReadDocumentCallback<T>
protected class	AbstractReactiveElasticsearchTemplate.ReadSearchDocumentCallback<T>
protected static interface	AbstractReactiveElasticsearchTemplate.SearchDocumentCallback<T>	Callback to convert a SearchDocument into different other classes

Field Summary

Fields

Modifier and Type	Field	Description
protected final ElasticsearchConverter	converter
protected ReactiveEntityCallbacks	entityCallbacks
protected final EntityOperations	entityOperations
protected final SimpleElasticsearchMappingContext	mappingContext
protected RefreshPolicy	refreshPolicy
protected RoutingResolver	routingResolver

Fields inherited from interface org.springframework.data.elasticsearch.core.ReactiveDocumentOperations

FLUX_SAVE_BULK_SIZE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractReactiveElasticsearchTemplate(ElasticsearchConverter converter)

Method Summary

Modifier and Type	Method	Description
reactor.core.publisher.Flux<? extends AggregationContainer<?>>	aggregate(Query query, Class<?> entityType)	Perform an aggregation specified by the given query.
reactor.core.publisher.Mono<Boolean>	closePointInTime(String pit)	Closes a point in time
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.
reactor.core.publisher.Mono<String>	delete(Object entity)	Delete the given entity extracting index from entity metadata.
reactor.core.publisher.Mono<String>	delete(Object entity, IndexCoordinates index)	Delete the given entity extracting index from entity metadata.
reactor.core.publisher.Mono<String>	delete(String id, Class<?> entityType)	Delete the entity with given id extracting index from entity metadata.
reactor.core.publisher.Mono<String>	delete(String id, IndexCoordinates index)	Delete the entity with given id.
reactor.core.publisher.Mono<ByQueryResponse>	delete(DeleteQuery query, Class<?> entityType)	Delete the documents matching the given Query extracting index from entity metadata.
reactor.core.publisher.Mono<ByQueryResponse>	delete(Query query, Class<?> entityType)	Deprecated.
reactor.core.publisher.Mono<Boolean>	deleteScript(String name)	Deletes the script with the given name
protected abstract AbstractReactiveElasticsearchTemplate	doCopy()
protected abstract reactor.core.publisher.Mono<Long>	doCount(Query query, Class<?> entityType, IndexCoordinates index)
protected abstract reactor.core.publisher.Mono<String>	doDeleteById(String id, String routing, IndexCoordinates index)
protected abstract reactor.core.publisher.Mono<Boolean>	doExists(String id, IndexCoordinates index)
protected abstract reactor.core.publisher.Flux<SearchDocument>	doFind(Query query, Class<?> clazz, IndexCoordinates index)
protected abstract <T> reactor.core.publisher.Mono<SearchDocumentResponse>	doFindForResponse(Query query, Class<?> clazz, IndexCoordinates index)
protected abstract <T> reactor.core.publisher.Mono<reactor.util.function.Tuple2<T,AbstractReactiveElasticsearchTemplate.IndexResponseMetaData>>	doIndex(T entity, IndexCoordinates index)
reactor.core.publisher.Mono<Boolean>	exists(String id, Class<?> entityType)	Check if an entity with given id exists.
reactor.core.publisher.Mono<Boolean>	exists(String id, IndexCoordinates index)	Check if an entity with given id exists.
<T> reactor.core.publisher.Mono<T>	get(String id, Class<T> entityType)	Find the document with the given id mapped onto the given entityType.
abstract reactor.core.publisher.Mono<String>	getClusterVersion()
ElasticsearchConverter	getElasticsearchConverter()	Get the ElasticsearchConverter used.
String	getEntityRouting(Object entity)	gets the routing for an entity.
IndexCoordinates	getIndexCoordinatesFor(Class<?> clazz)
protected IndexQuery	getIndexQuery(Object value)
ElasticsearchPersistentEntity<?>	getPersistentEntityFor(Class<?> type)
RefreshPolicy	getRefreshPolicy()
abstract reactor.core.publisher.Mono<String>	getRuntimeLibraryVersion()
reactor.core.publisher.Mono<Script>	getScript(String name)	Gest the script with the given name.
abstract reactor.core.publisher.Mono<String>	getVendor()
reactor.core.publisher.Mono<Void>	logVersions()	logs the versions of the different Elasticsearch components.
protected <T> reactor.core.publisher.Mono<T>	maybeCallbackAfterConvert(T entity, Document document, IndexCoordinates index)
protected <T> reactor.core.publisher.Mono<Document>	maybeCallbackAfterLoad(Document document, Class<T> type, IndexCoordinates index)
protected <T> reactor.core.publisher.Mono<T>	maybeCallbackAfterSave(T entity, IndexCoordinates index)
protected <T> reactor.core.publisher.Mono<T>	maybeCallbackBeforeConvert(T entity, IndexCoordinates index)
<T> reactor.core.publisher.Flux<MultiGetItem<T>>	multiGet(Query query, Class<T> clazz)	Execute a multiGet against elasticsearch for the given ids.
reactor.core.publisher.Mono<String>	openPointInTime(IndexCoordinates index, Duration keepAlive, Boolean ignoreUnavailable)	Opens a point in time (pit) in Elasticsearch.
reactor.core.publisher.Mono<Boolean>	putScript(Script script)	Stores the given script in the Elasticsearch cluster.
<T> reactor.core.publisher.Flux<T>	save(reactor.core.publisher.Flux<T> entities, Class<?> clazz, int bulkSize)	Indexes the entities into the index extracted from entity metadata.
<T> reactor.core.publisher.Flux<T>	save(reactor.core.publisher.Flux<T> entities, IndexCoordinates index, int bulkSize)	Indexes the entities into the given index.
<T> reactor.core.publisher.Mono<T>	save(T entity)	Index the given entity extracting index from entity metadata.
<T> reactor.core.publisher.Mono<T>	save(T entity, IndexCoordinates index)	Index the entity under the given type in the given index.
<T> reactor.core.publisher.Flux<T>	saveAll(reactor.core.publisher.Mono<? extends Collection<? extends T>> entities, Class<T> clazz)	Index entities in the index extracted from entity metadata.
<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.
<T> reactor.core.publisher.Mono<ReactiveSearchHits<T>>	searchForHits(Query query, Class<?> entityType, Class<T> resultType)	Perform a search and return the ReactiveSearchHits which contains information about the search results and which will provide the documents by the ReactiveSearchHits.getSearchHits() method.
<T> reactor.core.publisher.Mono<ReactiveSearchHits<T>>	searchForHits(Query query, Class<?> entityType, Class<T> resultType, IndexCoordinates index)	Perform a search and return the ReactiveSearchHits which contains information about the search results and which will provide the documents by the ReactiveSearchHits.getSearchHits() method.
<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.
void	setApplicationContext(ApplicationContext applicationContext)
void	setEntityCallbacks(ReactiveEntityCallbacks entityCallbacks)	Set the ReactiveEntityCallbacks instance to use when invoking callbacks like the ReactiveBeforeConvertCallback.
void	setRefreshPolicy(RefreshPolicy refreshPolicy)	Set the default RefreshPolicy to apply when writing to Elasticsearch.
reactor.core.publisher.Mono<Suggest>	suggest(Query query, Class<?> entityType)	Does a suggest query.
reactor.core.publisher.Mono<Suggest>	suggest(Query query, Class<?> entityType, IndexCoordinates index)	Does a suggest query.
ReactiveElasticsearchOperations	withRefreshPolicy(RefreshPolicy refreshPolicy)	Returns a copy of this instance with the same configuration, but that uses a different RefreshPolicy.
ReactiveElasticsearchOperations	withRouting(RoutingResolver routingResolver)	Returns a copy of this instance with the same configuration, but that uses a different RoutingResolver to obtain routing information.

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

bulkUpdate, bulkUpdate, delete, delete, get, multiGet, reindex, save, save, save, save, saveAll, saveAll, saveAll, submitReindex, update, updateByQuery

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

cluster, indexOps, indexOps

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

aggregate, count, idsQuery, matchAllQuery, openPointInTime, queryBuilderWithIds, search, search, searchForHits, searchForHits, searchForPage, searchForPage

Methods inherited from interface org.springframework.data.elasticsearch.core.sql.ReactiveSqlOperations

search

Field Details

converter

protected final ElasticsearchConverter converter

mappingContext

protected final SimpleElasticsearchMappingContext mappingContext

entityOperations

protected final EntityOperations entityOperations

refreshPolicy

@Nullable
protected RefreshPolicy refreshPolicy

routingResolver

protected RoutingResolver routingResolver

entityCallbacks

@Nullable
protected ReactiveEntityCallbacks entityCallbacks

Constructor Details

AbstractReactiveElasticsearchTemplate

protected AbstractReactiveElasticsearchTemplate(@Nullable
 ElasticsearchConverter converter)

Method Details

getElasticsearchConverter

public ElasticsearchConverter getElasticsearchConverter()

Description copied from interface: ReactiveElasticsearchOperations

Get the ElasticsearchConverter used.

Specified by:

getElasticsearchConverter in interface ReactiveElasticsearchOperations

Returns:

never null

doCopy

protected abstract AbstractReactiveElasticsearchTemplate doCopy()

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException

setRefreshPolicy

public void setRefreshPolicy(@Nullable
 RefreshPolicy refreshPolicy)

Set the default RefreshPolicy to apply when writing to Elasticsearch.

Parameters:

refreshPolicy - can be null.

getRefreshPolicy

@Nullable
public RefreshPolicy getRefreshPolicy()

Returns:

the current RefreshPolicy.

setEntityCallbacks

public void setEntityCallbacks(ReactiveEntityCallbacks entityCallbacks)

Set the ReactiveEntityCallbacks instance to use when invoking callbacks like the ReactiveBeforeConvertCallback. Overrides potentially existing ReactiveEntityCallbacks.

Parameters:

entityCallbacks - must not be null.

Throws:

IllegalArgumentException - if the given instance is null.

Since:

4.0

logVersions

public reactor.core.publisher.Mono<Void> logVersions()

logs the versions of the different Elasticsearch components.

Returns:

a Mono signalling finished execution

Since:

4.3

withRouting

public ReactiveElasticsearchOperations withRouting(RoutingResolver routingResolver)

Description copied from interface: ReactiveElasticsearchOperations

Returns a copy of this instance with the same configuration, but that uses a different RoutingResolver to obtain routing information.

Specified by:

withRouting in interface ReactiveElasticsearchOperations

Parameters:

routingResolver - the RoutingResolver value, must not be null.

Returns:

DocumentOperations instance

withRefreshPolicy

public ReactiveElasticsearchOperations withRefreshPolicy(@Nullable
 RefreshPolicy refreshPolicy)

Description copied from interface: ReactiveElasticsearchOperations

Returns a copy of this instance with the same configuration, but that uses a different RefreshPolicy.

Specified by:

withRefreshPolicy in interface ReactiveElasticsearchOperations

Parameters:

refreshPolicy - the RefreshPolicy value.

Returns:

ReactiveElasticsearchOperations instance.

save

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

Description copied from interface: ReactiveDocumentOperations

Index the given entity extracting index from entity metadata.

Specified by:

save in interface ReactiveDocumentOperations

Parameters:

entity - must not be null.

Returns:

a Mono emitting the saved entity.

save

public <T> reactor.core.publisher.Flux<T> save(reactor.core.publisher.Flux<T> entities,
 Class<?> clazz,
 int bulkSize)

Description copied from interface: ReactiveDocumentOperations

Indexes the entities into the index extracted from entity metadata. The entities are collected into batches of {bulkSize} with a maximal timeout of 200 ms, see Flux.bufferTimeout(int, java.time.Duration) and then sent in a bulk operation to Elasticsearch.

Specified by:

save in interface ReactiveDocumentOperations

Type Parameters:

T - entity type

clazz - the class to get the index name from

bulkSize - number of entities to put in a bulk request

Returns:

a Flux emitting the saved entities

save

public <T> reactor.core.publisher.Flux<T> save(reactor.core.publisher.Flux<T> entities,
 IndexCoordinates index,
 int bulkSize)

Description copied from interface: ReactiveDocumentOperations

Indexes the entities into the given index. The entities are collected into batches of {bulkSize} with a maximal timeout of 200 ms, see {@link reactor.core.publisher.Flux#bufferTimeout(int, java.time * .Duration)} and then sent in a bulk operation to Elasticsearch.

Specified by:

save in interface ReactiveDocumentOperations

Type Parameters:

T - entity type

Parameters:

entities - the entities to save

index - the index to save to

bulkSize - number of entities to put in a bulk request

Returns:

a Flux emitting the saved entities

saveAll

public <T> reactor.core.publisher.Flux<T> saveAll(reactor.core.publisher.Mono<? extends Collection<? extends T>> entities,
 Class<T> clazz)

Description copied from interface: ReactiveDocumentOperations

Index entities in the index extracted from entity metadata.

Specified by:

saveAll in interface ReactiveDocumentOperations

Parameters:

entities - must not be null.

clazz - the entity class, used to determine the index

Returns:

a Flux emitting saved entities.

getIndexQuery

protected IndexQuery getIndexQuery(Object value)

multiGet

public <T>
reactor.core.publisher.Flux<MultiGetItem<T>> multiGet(Query query,
 Class<T> clazz)

Description copied from interface: ReactiveDocumentOperations

Execute a multiGet against elasticsearch for the given ids.

Specified by:

multiGet in interface ReactiveDocumentOperations

Parameters:

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

clazz - the type of the object to be returned, used to determine the index

Returns:

flux with list of MultiGetItems that contain the entities

See Also:

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

exists

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

Description copied from interface: ReactiveDocumentOperations

Check if an entity with given id exists.

Specified by:

exists in interface ReactiveDocumentOperations

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

public reactor.core.publisher.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

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.

save

public <T> reactor.core.publisher.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

Parameters:

entity - must not be null.

index - the target index, must not be null

Returns:

a Mono emitting the saved entity.

doIndex

protected abstract <T>
reactor.core.publisher.Mono<reactor.util.function.Tuple2<T,AbstractReactiveElasticsearchTemplate.IndexResponseMetaData>> doIndex(T entity,
 IndexCoordinates index)

doExists

protected abstract reactor.core.publisher.Mono<Boolean> doExists(String id,
 IndexCoordinates index)

get

public <T> reactor.core.publisher.Mono<T> get(String id,
 Class<T> entityType)

Description copied from interface: ReactiveDocumentOperations

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

Specified by:

get in interface ReactiveDocumentOperations

Parameters:

id - the _id of the document to fetch.

entityType - the domain type used for mapping the document.

Returns:

Mono.empty() if not found.

delete

public reactor.core.publisher.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

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 reactor.core.publisher.Mono<String> delete(Object entity)

Description copied from interface: ReactiveDocumentOperations

Delete the given entity extracting index from entity metadata.

Specified by:

delete in interface ReactiveDocumentOperations

Parameters:

entity - must not be null.

Returns:

a Mono emitting the id of the removed document.

delete

public reactor.core.publisher.Mono<String> delete(String id,
 Class<?> entityType)

Description copied from interface: ReactiveDocumentOperations

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

Specified by:

delete in interface ReactiveDocumentOperations

Parameters:

id - must not be null.

entityType - must not be null.

Returns:

a Mono emitting the id of the removed document.

delete

public reactor.core.publisher.Mono<String> delete(String id,
 IndexCoordinates index)

Description copied from interface: ReactiveDocumentOperations

Delete the entity with given id.

Specified by:

delete in interface ReactiveDocumentOperations

Parameters:

id - must not be null.

index - the target index, must not be null

Returns:

a Mono emitting the id of the removed document.

doDeleteById

protected abstract reactor.core.publisher.Mono<String> doDeleteById(String id,
 @Nullable
 String routing,
 IndexCoordinates index)

delete

@Deprecated
public reactor.core.publisher.Mono<ByQueryResponse> delete(Query query,
 Class<?> entityType)

Deprecated.

Description copied from interface: ReactiveDocumentOperations

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

Specified by:

delete in interface ReactiveDocumentOperations

Parameters:

query - must not be null.

entityType - must not be null.

Returns:

a Mono emitting the number of the removed documents.

delete

public reactor.core.publisher.Mono<ByQueryResponse> delete(DeleteQuery query,
 Class<?> entityType)

Description copied from interface: ReactiveDocumentOperations

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

Specified by:

delete in interface ReactiveDocumentOperations

Parameters:

query - must not be null.

entityType - must not be null.

Returns:

a Mono emitting the number of the removed documents.

search

public <T>
reactor.core.publisher.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

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.

search

public <T>
reactor.core.publisher.Flux<SearchHit<T>> search(Query query,
 Class<?> entityType,
 Class<T> returnType)

Description copied from interface: ReactiveSearchOperations

Search the index for entities matching the given query.

Specified by:

search in interface ReactiveSearchOperations

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.

searchForPage

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

Description copied from interface: ReactiveSearchOperations

Search the index for entities matching the given query.

Specified by:

searchForPage in interface ReactiveSearchOperations

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.

searchForPage

public <T>
reactor.core.publisher.Mono<SearchPage<T>> searchForPage(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:

searchForPage in interface ReactiveSearchOperations

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.

searchForHits

public <T>
reactor.core.publisher.Mono<ReactiveSearchHits<T>> searchForHits(Query query,
 Class<?> entityType,
 Class<T> resultType)

Description copied from interface: ReactiveSearchOperations

Perform a search and return the ReactiveSearchHits which contains information about the search results and which will provide the documents by the ReactiveSearchHits.getSearchHits() method.

Specified by:

searchForHits in interface ReactiveSearchOperations

Type Parameters:

T - the result type class

Parameters:

query - must not be null.

entityType - must not be null.

resultType - the projection result type.

Returns:

a Mono emitting the ReactiveSearchHits that contains the search result information

searchForHits

public <T>
reactor.core.publisher.Mono<ReactiveSearchHits<T>> searchForHits(Query query,
 Class<?> entityType,
 Class<T> resultType,
 IndexCoordinates index)

Description copied from interface: ReactiveSearchOperations

Perform a search and return the ReactiveSearchHits which contains information about the search results and which will provide the documents by the ReactiveSearchHits.getSearchHits() method.

Specified by:

searchForHits in interface ReactiveSearchOperations

Type Parameters:

T - the result type class

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 the ReactiveSearchHits that contains the search result information

doFind

protected abstract reactor.core.publisher.Flux<SearchDocument> doFind(Query query,
 Class<?> clazz,
 IndexCoordinates index)

doFindForResponse

protected abstract <T>
reactor.core.publisher.Mono<SearchDocumentResponse> doFindForResponse(Query query,
 Class<?> clazz,
 IndexCoordinates index)

aggregate

public reactor.core.publisher.Flux<? extends AggregationContainer<?>> aggregate(Query query,
 Class<?> entityType)

Description copied from interface: ReactiveSearchOperations

Perform an aggregation specified by the given query.

Specified by:

aggregate in interface ReactiveSearchOperations

Parameters:

query - must not be null.

entityType - must not be null.

Returns:

a Flux emitting matching aggregations one by one.

suggest

public reactor.core.publisher.Mono<Suggest> suggest(Query query,
 Class<?> entityType)

Description copied from interface: ReactiveSearchOperations

Does a suggest query.

Specified by:

suggest in interface ReactiveSearchOperations

Parameters:

query - the Query containing the suggest definition. Must not be null.

entityType - the type of the entities that might be returned for a completion suggestion, must not be null.

Returns:

suggest data

suggest

public reactor.core.publisher.Mono<Suggest> suggest(Query query,
 Class<?> entityType,
 IndexCoordinates index)

Description copied from interface: ReactiveSearchOperations

Does a suggest query.

Specified by:

suggest in interface ReactiveSearchOperations

Parameters:

query - the Query containing the suggest definition. Must not be null.

entityType - the type of the entities that might be returned for a completion suggestion, must not be null.

index - the index to run the query against, must not be null.

Returns:

suggest data

count

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

Description copied from interface: ReactiveSearchOperations

Count the number of documents matching the given Query.

Specified by:

count in interface ReactiveSearchOperations

Parameters:

query - must not be null.

entityType - must not be null.

Returns:

a Mono emitting the nr of matching documents.

count

public reactor.core.publisher.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

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.

doCount

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

openPointInTime

public reactor.core.publisher.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

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 reactor.core.publisher.Mono<Boolean> closePointInTime(String pit)

Description copied from interface: ReactiveSearchOperations

Closes a point in time

Specified by:

closePointInTime in interface ReactiveSearchOperations

Parameters:

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

Returns:

true on success

maybeCallbackBeforeConvert

protected <T> reactor.core.publisher.Mono<T> maybeCallbackBeforeConvert(T entity,
 IndexCoordinates index)

maybeCallbackAfterSave

protected <T> reactor.core.publisher.Mono<T> maybeCallbackAfterSave(T entity,
 IndexCoordinates index)

maybeCallbackAfterConvert

protected <T> reactor.core.publisher.Mono<T> maybeCallbackAfterConvert(T entity,
 Document document,
 IndexCoordinates index)

maybeCallbackAfterLoad

protected <T> reactor.core.publisher.Mono<Document> maybeCallbackAfterLoad(Document document,
 Class<T> type,
 IndexCoordinates index)

putScript

public reactor.core.publisher.Mono<Boolean> putScript(Script script)

Description copied from interface: ReactiveScriptOperations

Stores the given script in the Elasticsearch cluster.

Specified by:

putScript in interface ReactiveScriptOperations

Returns:

{true if successful

getScript

public reactor.core.publisher.Mono<Script> getScript(String name)

Description copied from interface: ReactiveScriptOperations

Gest the script with the given name.

Specified by:

getScript in interface ReactiveScriptOperations

Parameters:

name - the name of the script

Returns:

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

deleteScript

public reactor.core.publisher.Mono<Boolean> deleteScript(String name)

Description copied from interface: ReactiveScriptOperations

Deletes the script with the given name

Specified by:

deleteScript in interface ReactiveScriptOperations

Parameters:

name - the name of the script.

Returns:

true if the request was acknowledged by the cluster.

getIndexCoordinatesFor

public IndexCoordinates getIndexCoordinatesFor(Class<?> clazz)

Specified by:

getIndexCoordinatesFor in interface ReactiveElasticsearchOperations

Returns:

the IndexCoordinates defined on the entity.

getPersistentEntityFor

@Nullable
public ElasticsearchPersistentEntity<?> getPersistentEntityFor(@Nullable
 Class<?> type)

Specified by:

getPersistentEntityFor in interface ReactiveElasticsearchOperations

getVendor

public abstract reactor.core.publisher.Mono<String> getVendor()

Returns:

the vendor name of the used cluster and client library

Since:

4.3

getRuntimeLibraryVersion

public abstract reactor.core.publisher.Mono<String> getRuntimeLibraryVersion()

Returns:

the version of the used client runtime library.

Since:

4.3

getClusterVersion

public abstract reactor.core.publisher.Mono<String> getClusterVersion()

getEntityRouting

@Nullable
public String getEntityRouting(Object entity)

Description copied from interface: ReactiveElasticsearchOperations

gets the routing for an entity.

Specified by:

getEntityRouting in interface ReactiveElasticsearchOperations

Parameters:

entity - the entity

Returns:

the routing, may be null if not set.