Package org.springframework.data.couchbase.core

Class ReactiveCouchbaseTemplate

java.lang.Object

org.springframework.data.couchbase.core.ReactiveCouchbaseTemplate

All Implemented Interfaces:

Aware, ApplicationContextAware, ReactiveCouchbaseOperations, ReactiveExistsByIdOperation, ReactiveFindByAnalyticsOperation, ReactiveFindByIdOperation, ReactiveFindByQueryOperation, ReactiveFindFromReplicasByIdOperation, ReactiveFluentCouchbaseOperations, ReactiveInsertByIdOperation, ReactiveMutateInByIdOperation, ReactiveRangeScanOperation, ReactiveRemoveByIdOperation, ReactiveRemoveByQueryOperation, ReactiveReplaceByIdOperation, ReactiveUpsertByIdOperation

public class ReactiveCouchbaseTemplate
extends Object
implements ReactiveCouchbaseOperations, ApplicationContextAware

template class for Reactive Couchbase operations

Author:

Michael Nitschinger, Michael Reiche, Jorge Rodriguez Martin, Carlos Espinaco, Tigran Babloyan, Andy Toone

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.data.couchbase.core.ReactiveExistsByIdOperation

ReactiveExistsByIdOperation.ExistsByIdInCollection, ReactiveExistsByIdOperation.ExistsByIdInScope, ReactiveExistsByIdOperation.ExistsByIdWithOptions, ReactiveExistsByIdOperation.ReactiveExistsById, ReactiveExistsByIdOperation.TerminatingExistsById

Nested classes/interfaces inherited from interface org.springframework.data.couchbase.core.ReactiveFindByAnalyticsOperation

ReactiveFindByAnalyticsOperation.FindByAnalyticsConsistentWith<T>, ReactiveFindByAnalyticsOperation.FindByAnalyticsInCollection<T>, ReactiveFindByAnalyticsOperation.FindByAnalyticsInScope<T>, ReactiveFindByAnalyticsOperation.FindByAnalyticsWithConsistency<T>, ReactiveFindByAnalyticsOperation.FindByAnalyticsWithOptions<T>, ReactiveFindByAnalyticsOperation.FindByAnalyticsWithProjection<T>, ReactiveFindByAnalyticsOperation.FindByAnalyticsWithQuery<T>, ReactiveFindByAnalyticsOperation.ReactiveFindByAnalytics<T>, ReactiveFindByAnalyticsOperation.TerminatingFindByAnalytics<T>

Nested classes/interfaces inherited from interface org.springframework.data.couchbase.core.ReactiveFindByIdOperation

ReactiveFindByIdOperation.FindByIdInCollection<T>, ReactiveFindByIdOperation.FindByIdInScope<T>, ReactiveFindByIdOperation.FindByIdWithExpiry<T>, ReactiveFindByIdOperation.FindByIdWithLock<T>, ReactiveFindByIdOperation.FindByIdWithOptions<T>, ReactiveFindByIdOperation.FindByIdWithProjection<T>, ReactiveFindByIdOperation.ReactiveFindById<T>, ReactiveFindByIdOperation.TerminatingFindById<T>

Nested classes/interfaces inherited from interface org.springframework.data.couchbase.core.ReactiveFindByQueryOperation

ReactiveFindByQueryOperation.FindByQueryConsistentWith<T>, ReactiveFindByQueryOperation.FindByQueryInCollection<T>, ReactiveFindByQueryOperation.FindByQueryInScope<T>, ReactiveFindByQueryOperation.FindByQueryWithConsistency<T>, ReactiveFindByQueryOperation.FindByQueryWithDistinct<T>, ReactiveFindByQueryOperation.FindByQueryWithOptions<T>, ReactiveFindByQueryOperation.FindByQueryWithProjecting<T>, ReactiveFindByQueryOperation.FindByQueryWithProjection<T>, ReactiveFindByQueryOperation.FindByQueryWithQuery<T>, ReactiveFindByQueryOperation.ReactiveFindByQuery<T>, ReactiveFindByQueryOperation.TerminatingFindByQuery<T>

Nested classes/interfaces inherited from interface org.springframework.data.couchbase.core.ReactiveFindFromReplicasByIdOperation

ReactiveFindFromReplicasByIdOperation.FindFromReplicasByIdInCollection<T>, ReactiveFindFromReplicasByIdOperation.FindFromReplicasByIdInScope<T>, ReactiveFindFromReplicasByIdOperation.FindFromReplicasByIdWithOptions<T>, ReactiveFindFromReplicasByIdOperation.ReactiveFindFromReplicasById<T>, ReactiveFindFromReplicasByIdOperation.TerminatingFindFromReplicasById<T>

Nested classes/interfaces inherited from interface org.springframework.data.couchbase.core.ReactiveInsertByIdOperation

ReactiveInsertByIdOperation.InsertByIdInCollection<T>, ReactiveInsertByIdOperation.InsertByIdInScope<T>, ReactiveInsertByIdOperation.InsertByIdWithDurability<T>, ReactiveInsertByIdOperation.InsertByIdWithExpiry<T>, ReactiveInsertByIdOperation.InsertByIdWithOptions<T>, ReactiveInsertByIdOperation.ReactiveInsertById<T>, ReactiveInsertByIdOperation.TerminatingInsertById<T>

Nested classes/interfaces inherited from interface org.springframework.data.couchbase.core.ReactiveMutateInByIdOperation

ReactiveMutateInByIdOperation.MutateInByIdInCollection<T>, ReactiveMutateInByIdOperation.MutateInByIdInScope<T>, ReactiveMutateInByIdOperation.MutateInByIdWithDurability<T>, ReactiveMutateInByIdOperation.MutateInByIdWithExpiry<T>, ReactiveMutateInByIdOperation.MutateInByIdWithOptions<T>, ReactiveMutateInByIdOperation.MutateInByIdWithPaths<T>, ReactiveMutateInByIdOperation.ReactiveMutateInById<T>, ReactiveMutateInByIdOperation.TerminatingMutateInById<T>

Nested classes/interfaces inherited from interface org.springframework.data.couchbase.core.ReactiveRangeScanOperation

ReactiveRangeScanOperation.RangeScanConsistentWith<T>, ReactiveRangeScanOperation.RangeScanInCollection<T>, ReactiveRangeScanOperation.RangeScanInScope<T>, ReactiveRangeScanOperation.RangeScanWithBatchByteLimit<T>, ReactiveRangeScanOperation.RangeScanWithBatchItemLimit<T>, ReactiveRangeScanOperation.RangeScanWithOptions<T>, ReactiveRangeScanOperation.RangeScanWithProjection<T>, ReactiveRangeScanOperation.RangeScanWithSort<T>, ReactiveRangeScanOperation.ReactiveRangeScan<T>, ReactiveRangeScanOperation.TerminatingRangeScan<T>

Nested classes/interfaces inherited from interface org.springframework.data.couchbase.core.ReactiveRemoveByIdOperation

ReactiveRemoveByIdOperation.ReactiveRemoveById, ReactiveRemoveByIdOperation.RemoveByIdInCollection, ReactiveRemoveByIdOperation.RemoveByIdInScope, ReactiveRemoveByIdOperation.RemoveByIdWithCas, ReactiveRemoveByIdOperation.RemoveByIdWithDurability, ReactiveRemoveByIdOperation.RemoveByIdWithOptions, ReactiveRemoveByIdOperation.TerminatingRemoveById

Nested classes/interfaces inherited from interface org.springframework.data.couchbase.core.ReactiveRemoveByQueryOperation

ReactiveRemoveByQueryOperation.ReactiveRemoveByQuery<T>, ReactiveRemoveByQueryOperation.RemoveByQueryConsistentWith<T>, ReactiveRemoveByQueryOperation.RemoveByQueryInCollection<T>, ReactiveRemoveByQueryOperation.RemoveByQueryInScope<T>, ReactiveRemoveByQueryOperation.RemoveByQueryWithConsistency<T>, ReactiveRemoveByQueryOperation.RemoveByQueryWithOptions<T>, ReactiveRemoveByQueryOperation.RemoveByQueryWithQuery<T>, ReactiveRemoveByQueryOperation.TerminatingRemoveByQuery<T>

Nested classes/interfaces inherited from interface org.springframework.data.couchbase.core.ReactiveReplaceByIdOperation

ReactiveReplaceByIdOperation.ReactiveReplaceById<T>, ReactiveReplaceByIdOperation.ReplaceByIdInCollection<T>, ReactiveReplaceByIdOperation.ReplaceByIdInScope<T>, ReactiveReplaceByIdOperation.ReplaceByIdWithDurability<T>, ReactiveReplaceByIdOperation.ReplaceByIdWithExpiry<T>, ReactiveReplaceByIdOperation.ReplaceByIdWithOptions<T>, ReactiveReplaceByIdOperation.TerminatingReplaceById<T>

Nested classes/interfaces inherited from interface org.springframework.data.couchbase.core.ReactiveUpsertByIdOperation

ReactiveUpsertByIdOperation.ReactiveUpsertById<T>, ReactiveUpsertByIdOperation.TerminatingUpsertById<T>, ReactiveUpsertByIdOperation.UpsertByIdInCollection<T>, ReactiveUpsertByIdOperation.UpsertByIdInScope<T>, ReactiveUpsertByIdOperation.UpsertByIdWithDurability<T>, ReactiveUpsertByIdOperation.UpsertByIdWithExpiry<T>, ReactiveUpsertByIdOperation.UpsertByIdWithOptions<T>

Constructor Summary

Constructors

Constructor	Description
ReactiveCouchbaseTemplate(CouchbaseClientFactory clientFactory, CouchbaseConverter converter)
ReactiveCouchbaseTemplate(CouchbaseClientFactory clientFactory, CouchbaseConverter converter, TranslationService translationService)
ReactiveCouchbaseTemplate(CouchbaseClientFactory clientFactory, CouchbaseConverter converter, TranslationService translationService, com.couchbase.client.java.query.QueryScanConsistency scanConsistency)

Method Summary

Modifier and Type	Method	Description
<T> reactor.core.publisher.Mono<Long>	count(Query query, Class<T> domainType)	Returns the count of documents found by the query.
ReactiveExistsByIdOperation.ReactiveExistsById	existsById()	Checks if the document exists in the bucket.
ReactiveExistsByIdOperation.ReactiveExistsById	existsById(Class<?> domainType)	Checks if the document exists in the bucket.
<T> ReactiveFindByAnalyticsOperation.ReactiveFindByAnalytics<T>	findByAnalytics(Class<T> domainType)	Queries the analytics service.
<T> ReactiveFindByIdOperation.ReactiveFindById<T>	findById(Class<T> domainType)	Loads a document from a bucket.
<T> ReactiveFindByQueryOperation.ReactiveFindByQuery<T>	findByQuery(Class<T> domainType)	Create the operation for the domainType
<T> ReactiveFindFromReplicasByIdOperation.ReactiveFindFromReplicasById<T>	findFromReplicasById(Class<T> domainType)	Loads a document from a replica.
String	getBucketName()	The name of the bucket used.
com.couchbase.client.java.Collection	getCollection(String collectionName)	Provides access to a Collection on the configured CouchbaseClientFactory.
com.couchbase.client.java.query.QueryScanConsistency	getConsistency()
CouchbaseConverter	getConverter()	Returns the converter used for this template/operations.
CouchbaseClientFactory	getCouchbaseClientFactory()	Returns the underlying client factory.
PseudoArgs<?>	getPseudoArgs()
String	getScopeName()	The name of the scope used, null if the default scope is used.
<T> ReactiveInsertByIdOperation.ReactiveInsertById<T>	insertById(Class<T> domainType)	Insert using the KV service.
<T> ReactiveMutateInByIdOperation.ReactiveMutateInById<T>	mutateInById(Class<T> domainType)	Mutate using the KV service.
protected RuntimeException	potentiallyConvertRuntimeException(RuntimeException ex)	Tries to convert the given RuntimeException into a DataAccessException but returns the original exception if the conversation failed.
<T> ReactiveRangeScanOperation.ReactiveRangeScan<T>	rangeScan(Class<T> domainType)	Loads a document from a bucket.
ReactiveRemoveByIdOperation.ReactiveRemoveById	removeById()	Removes a document.
ReactiveRemoveByIdOperation.ReactiveRemoveById	removeById(Class<?> domainType)	Removes a document.
<T> ReactiveRemoveByQueryOperation.ReactiveRemoveByQuery<T>	removeByQuery(Class<T> domainType)	Remove via the query service.
<T> ReactiveReplaceByIdOperation.ReactiveReplaceById<T>	replaceById(Class<T> domainType)	Replace using the KV service.
<T> reactor.core.publisher.Mono<T>	save(T entity, String... scopeAndCollection)	Save the entity to couchbase. If there is no version property on the entity class, and this is in a transaction, use insert.
void	setApplicationContext(ApplicationContext applicationContext)
void	setPseudoArgs(PseudoArgs<?> threadLocalArgs)	set the ThreadLocal field
ReactiveTemplateSupport	support()
<T> ReactiveUpsertByIdOperation.ReactiveUpsertById<T>	upsertById(Class<T> domainType)	Upsert using the KV service.

Methods inherited from class java.lang.Object

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

Constructor Details

ReactiveCouchbaseTemplate

public ReactiveCouchbaseTemplate(CouchbaseClientFactory clientFactory,
 CouchbaseConverter converter)

ReactiveCouchbaseTemplate

public ReactiveCouchbaseTemplate(CouchbaseClientFactory clientFactory,
 CouchbaseConverter converter,
 TranslationService translationService)

ReactiveCouchbaseTemplate

public ReactiveCouchbaseTemplate(CouchbaseClientFactory clientFactory,
 CouchbaseConverter converter,
 TranslationService translationService,
 com.couchbase.client.java.query.QueryScanConsistency scanConsistency)

Method Details

save

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

Description copied from interface: ReactiveCouchbaseOperations

Save the entity to couchbase.
If there is no version property on the entity class, and this is in a transaction, use insert.
If there is no version property on the entity class, and this is not in a transaction, use upsert.
If there is a version property on the entity class, and it is non-zero, then this is an existing document, use replace.
Otherwise, there is a version property for the entity, but it is zero or null, use insert.

Specified by:

save in interface ReactiveCouchbaseOperations

Type Parameters:

T - the entity class

Parameters:

entity - the entity to save in couchbase

scopeAndCollection - for use by repositories only. these are varargs for the scope and collection.

Returns:

count

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

Description copied from interface: ReactiveCouchbaseOperations

Returns the count of documents found by the query.

Specified by:

count in interface ReactiveCouchbaseOperations

Returns:

findById

public <T>
ReactiveFindByIdOperation.ReactiveFindById<T> findById(Class<T> domainType)

Description copied from interface: ReactiveFindByIdOperation

Loads a document from a bucket.

Specified by:

findById in interface ReactiveFindByIdOperation

Parameters:

domainType - the entity type to use for the results.

existsById

public ReactiveExistsByIdOperation.ReactiveExistsById existsById()

Description copied from interface: ReactiveExistsByIdOperation

Checks if the document exists in the bucket.

Specified by:

existsById in interface ReactiveExistsByIdOperation

existsById

public ReactiveExistsByIdOperation.ReactiveExistsById existsById(Class<?> domainType)

Description copied from interface: ReactiveExistsByIdOperation

Checks if the document exists in the bucket.

Specified by:

existsById in interface ReactiveExistsByIdOperation

findByAnalytics

public <T>
ReactiveFindByAnalyticsOperation.ReactiveFindByAnalytics<T> findByAnalytics(Class<T> domainType)

Description copied from interface: ReactiveFindByAnalyticsOperation

Queries the analytics service.

Specified by:

findByAnalytics in interface ReactiveFindByAnalyticsOperation

Parameters:

domainType - the entity type to use for the results.

findByQuery

public <T>
ReactiveFindByQueryOperation.ReactiveFindByQuery<T> findByQuery(Class<T> domainType)

Description copied from interface: ReactiveFindByQueryOperation

Create the operation for the domainType

Specified by:

findByQuery in interface ReactiveFindByQueryOperation

Parameters:

domainType - the entity type to use for the results.

findFromReplicasById

public <T>
ReactiveFindFromReplicasByIdOperation.ReactiveFindFromReplicasById<T> findFromReplicasById(Class<T> domainType)

Description copied from interface: ReactiveFindFromReplicasByIdOperation

Loads a document from a replica.

Specified by:

findFromReplicasById in interface ReactiveFindFromReplicasByIdOperation

Parameters:

domainType - the entity type to use for the results.

insertById

public <T>
ReactiveInsertByIdOperation.ReactiveInsertById<T> insertById(Class<T> domainType)

Description copied from interface: ReactiveInsertByIdOperation

Insert using the KV service.

Specified by:

insertById in interface ReactiveInsertByIdOperation

Parameters:

domainType - the entity type to insert.

removeById

public ReactiveRemoveByIdOperation.ReactiveRemoveById removeById()

Description copied from interface: ReactiveRemoveByIdOperation

Removes a document.

Specified by:

removeById in interface ReactiveRemoveByIdOperation

removeById

public ReactiveRemoveByIdOperation.ReactiveRemoveById removeById(Class<?> domainType)

Description copied from interface: ReactiveRemoveByIdOperation

Removes a document.

Specified by:

removeById in interface ReactiveRemoveByIdOperation

removeByQuery

public <T>
ReactiveRemoveByQueryOperation.ReactiveRemoveByQuery<T> removeByQuery(Class<T> domainType)

Description copied from interface: ReactiveRemoveByQueryOperation

Remove via the query service.

Specified by:

removeByQuery in interface ReactiveRemoveByQueryOperation

replaceById

public <T>
ReactiveReplaceByIdOperation.ReactiveReplaceById<T> replaceById(Class<T> domainType)

Description copied from interface: ReactiveReplaceByIdOperation

Replace using the KV service.

Specified by:

replaceById in interface ReactiveReplaceByIdOperation

Parameters:

domainType - the entity type to replace.

upsertById

public <T>
ReactiveUpsertByIdOperation.ReactiveUpsertById<T> upsertById(Class<T> domainType)

Description copied from interface: ReactiveUpsertByIdOperation

Upsert using the KV service.

Specified by:

upsertById in interface ReactiveUpsertByIdOperation

Parameters:

domainType - the entity type to upsert.

mutateInById

public <T>
ReactiveMutateInByIdOperation.ReactiveMutateInById<T> mutateInById(Class<T> domainType)

Description copied from interface: ReactiveMutateInByIdOperation

Mutate using the KV service.

Specified by:

mutateInById in interface ReactiveMutateInByIdOperation

Parameters:

domainType - the entity type to mutate.

rangeScan

public <T>
ReactiveRangeScanOperation.ReactiveRangeScan<T> rangeScan(Class<T> domainType)

Description copied from interface: ReactiveRangeScanOperation

Loads a document from a bucket.

Specified by:

rangeScan in interface ReactiveRangeScanOperation

Parameters:

domainType - the entity type to use for the results.

getBucketName

public String getBucketName()

Description copied from interface: ReactiveCouchbaseOperations

The name of the bucket used.

Specified by:

getBucketName in interface ReactiveCouchbaseOperations

getScopeName

public String getScopeName()

Description copied from interface: ReactiveCouchbaseOperations

The name of the scope used, null if the default scope is used.

Specified by:

getScopeName in interface ReactiveCouchbaseOperations

getCouchbaseClientFactory

public CouchbaseClientFactory getCouchbaseClientFactory()

Description copied from interface: ReactiveCouchbaseOperations

Returns the underlying client factory.

Specified by:

getCouchbaseClientFactory in interface ReactiveCouchbaseOperations

getCollection

public com.couchbase.client.java.Collection getCollection(String collectionName)

Provides access to a Collection on the configured CouchbaseClientFactory.

Parameters:

collectionName - the name of the collection, if null is passed in the default collection is assumed.

Returns:

the collection instance.

getConverter

public CouchbaseConverter getConverter()

Description copied from interface: ReactiveCouchbaseOperations

Returns the converter used for this template/operations.

Specified by:

getConverter in interface ReactiveCouchbaseOperations

support

public ReactiveTemplateSupport support()

potentiallyConvertRuntimeException

protected RuntimeException potentiallyConvertRuntimeException(RuntimeException ex)

Tries to convert the given RuntimeException into a DataAccessException but returns the original exception if the conversation failed. Thus allows safe re-throwing of the return value.

Parameters:

ex - the exception to translate

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException

getPseudoArgs

public PseudoArgs<?> getPseudoArgs()

Returns:

the pseudoArgs from the ThreadLocal field

setPseudoArgs

public void setPseudoArgs(PseudoArgs<?> threadLocalArgs)

set the ThreadLocal field

getConsistency

public com.couchbase.client.java.query.QueryScanConsistency getConsistency()

Specified by:

getConsistency in interface ReactiveCouchbaseOperations

Returns:

the default consistency to use for queries