org.springframework.data.cassandra.core

Class ReactiveCassandraTemplate

java.lang.Object

org.springframework.data.cassandra.core.ReactiveCassandraTemplate

All Implemented Interfaces:

Aware, ApplicationEventPublisherAware, ReactiveCassandraOperations, ReactiveDeleteOperation, ReactiveFluentCassandraOperations, ReactiveInsertOperation, ReactiveSelectOperation, ReactiveUpdateOperation

public class ReactiveCassandraTemplate
extends Object
implements ReactiveCassandraOperations, ApplicationEventPublisherAware

Primary implementation of ReactiveCassandraOperations. It simplifies the use of Reactive Cassandra usage and helps to avoid common errors. It executes core Cassandra workflow. This class executes CQL queries or updates, initiating iteration over ReactiveResultSet and catching Cassandra exceptions and translating them to the generic, more informative exception hierarchy defined in the org.springframework.dao package.

Can be used within a service implementation via direct instantiation with a ReactiveSessionFactory reference, or get prepared in an application context and given to services as bean reference.

Note: The ReactiveSessionFactory should always be configured as a bean in the application context, in the first case given to the service directly, in the second case to the prepared template.

Since:

2.0

Author:

Mark Paluch, John Blum, Lukasz Antoniak, Hleb Albau

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.data.cassandra.core.ReactiveSelectOperation

ReactiveSelectOperation.ReactiveSelect<T>, ReactiveSelectOperation.SelectWithProjection<T>, ReactiveSelectOperation.SelectWithQuery<T>, ReactiveSelectOperation.SelectWithTable<T>, ReactiveSelectOperation.TerminatingSelect<T>

Nested classes/interfaces inherited from interface org.springframework.data.cassandra.core.ReactiveInsertOperation

ReactiveInsertOperation.InsertWithOptions<T>, ReactiveInsertOperation.InsertWithTable<T>, ReactiveInsertOperation.ReactiveInsert<T>, ReactiveInsertOperation.TerminatingInsert<T>

Nested classes/interfaces inherited from interface org.springframework.data.cassandra.core.ReactiveUpdateOperation

ReactiveUpdateOperation.ReactiveUpdate, ReactiveUpdateOperation.TerminatingUpdate, ReactiveUpdateOperation.UpdateWithQuery, ReactiveUpdateOperation.UpdateWithTable

Nested classes/interfaces inherited from interface org.springframework.data.cassandra.core.ReactiveDeleteOperation

ReactiveDeleteOperation.DeleteWithQuery, ReactiveDeleteOperation.DeleteWithTable, ReactiveDeleteOperation.ReactiveDelete, ReactiveDeleteOperation.TerminatingDelete

Constructor Summary

Constructors

Constructor and Description
ReactiveCassandraTemplate(ReactiveCqlOperations reactiveCqlOperations, CassandraConverter converter) Create an instance of ReactiveCassandraTemplate initialized with the given ReactiveCqlOperations and CassandraConverter.
ReactiveCassandraTemplate(ReactiveSession session) Creates an instance of ReactiveCassandraTemplate initialized with the given ReactiveSession and a default MappingCassandraConverter.
ReactiveCassandraTemplate(ReactiveSession session, CassandraConverter converter) Create an instance of CassandraTemplate initialized with the given ReactiveSession and CassandraConverter.
ReactiveCassandraTemplate(ReactiveSessionFactory sessionFactory, CassandraConverter converter) Create an instance of ReactiveCassandraTemplate initialized with the given ReactiveSessionFactory and CassandraConverter.

Method Summary

Modifier and Type	Method and Description
ReactiveCassandraBatchOperations	batchOps() Returns a new ReactiveCassandraBatchOperations.
reactor.core.publisher.Mono<Long>	count(Class<?> entityClass) Returns the number of rows for the given entity class.
reactor.core.publisher.Mono<Long>	count(Query query, Class<?> entityClass) Returns the number of rows for the given entity class applying Query.
ReactiveDeleteOperation.ReactiveDelete	delete(Class<?> domainType) Begin creating a DELETE operation for the given domainType.
reactor.core.publisher.Mono<WriteResult>	delete(Object entity, QueryOptions options) Delete the given entity applying QueryOptions and emit the entity if the delete was applied.
reactor.core.publisher.Mono<Boolean>	delete(Query query, Class<?> entityClass) Remove entities (rows)/columns from the table by Query.
<T> reactor.core.publisher.Mono<T>	delete(T entity) Delete the given entity and emit the entity if the delete was applied.
reactor.core.publisher.Mono<Boolean>	deleteById(Object id, Class<?> entityClass) Remove the given object from the table by id.
reactor.core.publisher.Mono<Boolean>	exists(Object id, Class<?> entityClass) Determine whether a row of entityClass with the given id exists.
reactor.core.publisher.Mono<Boolean>	exists(Query query, Class<?> entityClass) Determine whether the result for entityClass Query yields at least one row.
CassandraConverter	getConverter() Returns the underlying CassandraConverter.
protected MappingContext<? extends CassandraPersistentEntity<?>,CassandraPersistentProperty>	getMappingContext() Returns the CassandraMappingContext used by this template to access mapping meta-data in order to store (map) object to Cassandra tables.
protected SpelAwareProxyProjectionFactory	getProjectionFactory() Returns a reference to the configured ProjectionFactory used by this template to process CQL query projections.
ReactiveCqlOperations	getReactiveCqlOperations() Expose the underlying ReactiveCqlOperations to allow CQL operations.
protected StatementFactory	getStatementFactory() Returns the StatementFactory used by this template to construct and run Cassandra CQL statements.
<T> ReactiveInsertOperation.ReactiveInsert<T>	insert(Class<T> domainType) Begin creating an INSERT operation for given domainType.
<T> reactor.core.publisher.Mono<T>	insert(T entity) Insert the given entity and emit the entity if the insert was applied.
<T> reactor.core.publisher.Mono<EntityWriteResult<T>>	insert(T entity, InsertOptions options) Insert the given entity applying WriteOptions and emit the entity if the insert was applied.
<T> ReactiveSelectOperation.ReactiveSelect<T>	query(Class<T> domainType) Begin creating a SELECT operation for the given domainType.
<T> reactor.core.publisher.Flux<T>	select(Query query, Class<T> entityClass) Execute a SELECT query and convert the resulting items to a stream of entities.
<T> reactor.core.publisher.Flux<T>	select(com.datastax.driver.core.Statement cql, Class<T> entityClass) Execute a SELECT query and convert the resulting items to a stream of entities.
<T> reactor.core.publisher.Flux<T>	select(String cql, Class<T> entityClass) Execute a SELECT query and convert the resulting items to a stream of entities.
<T> reactor.core.publisher.Mono<T>	selectOne(Query query, Class<T> entityClass) Execute a SELECT query and convert the resulting item to an entity.
<T> reactor.core.publisher.Mono<T>	selectOne(com.datastax.driver.core.Statement statement, Class<T> entityClass) Execute a SELECT query and convert the resulting item to an entity.
<T> reactor.core.publisher.Mono<T>	selectOne(String cql, Class<T> entityClass) Execute a SELECT query and convert the resulting item to an entity.
<T> reactor.core.publisher.Mono<T>	selectOneById(Object id, Class<T> entityClass) Execute the Select by id for the given entityClass.
void	setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)
<T> reactor.core.publisher.Mono<Slice<T>>	slice(Query query, Class<T> entityClass) Execute a SELECT query with paging and convert the result set to a Slice of entities.
<T> reactor.core.publisher.Mono<Slice<T>>	slice(com.datastax.driver.core.Statement statement, Class<T> entityClass) Execute a SELECT query with paging and convert the result set to a Slice of entities.
reactor.core.publisher.Mono<Void>	truncate(Class<?> entityClass) Execute a TRUNCATE query to remove all entities of a given class.
ReactiveUpdateOperation.ReactiveUpdate	update(Class<?> domainType) Begin creating an UPDATE operation for the given domainType.
reactor.core.publisher.Mono<Boolean>	update(Query query, Update update, Class<?> entityClass) Update the queried entities and return true if the update was applied.
<T> reactor.core.publisher.Mono<T>	update(T entity) Update the given entity and emit the entity if the update was applied.
<T> reactor.core.publisher.Mono<EntityWriteResult<T>>	update(T entity, UpdateOptions options) Update the given entity applying WriteOptions and emit the entity if the update was applied.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReactiveCassandraTemplate

public ReactiveCassandraTemplate(ReactiveSession session)

Creates an instance of ReactiveCassandraTemplate initialized with the given ReactiveSession and a default MappingCassandraConverter.

Parameters:

session - ReactiveSession used to interact with Cassandra; must not be null.

See Also:

CassandraConverter, Session

ReactiveCassandraTemplate

public ReactiveCassandraTemplate(ReactiveSession session,
                                 CassandraConverter converter)

Create an instance of CassandraTemplate initialized with the given ReactiveSession and CassandraConverter.

Parameters:

session - ReactiveSession used to interact with Cassandra; must not be null.

converter - CassandraConverter used to convert between Java and Cassandra types; must not be null.

See Also:

CassandraConverter, Session

ReactiveCassandraTemplate

public ReactiveCassandraTemplate(ReactiveSessionFactory sessionFactory,
                                 CassandraConverter converter)

Create an instance of ReactiveCassandraTemplate initialized with the given ReactiveSessionFactory and CassandraConverter.

Parameters:

sessionFactory - ReactiveSessionFactory used to interact with Cassandra; must not be null.

converter - CassandraConverter used to convert between Java and Cassandra types; must not be null.

See Also:

CassandraConverter, Session

ReactiveCassandraTemplate

public ReactiveCassandraTemplate(ReactiveCqlOperations reactiveCqlOperations,
                                 CassandraConverter converter)

Create an instance of ReactiveCassandraTemplate initialized with the given ReactiveCqlOperations and CassandraConverter.

Parameters:

reactiveCqlOperations - ReactiveCqlOperations used to interact with Cassandra; must not be null.

converter - CassandraConverter used to convert between Java and Cassandra types; must not be null.

See Also:

CassandraConverter, Session

Method Detail

batchOps

public ReactiveCassandraBatchOperations batchOps()

Description copied from interface: ReactiveCassandraOperations

Returns a new ReactiveCassandraBatchOperations. Each ReactiveCassandraBatchOperations instance can be executed only once so you might want to obtain new ReactiveCassandraBatchOperations instances for each batch.

Specified by:

batchOps in interface ReactiveCassandraOperations

Returns:

a new ReactiveCassandraBatchOperations associated with the given entity class.

getConverter

public CassandraConverter getConverter()

Description copied from interface: ReactiveCassandraOperations

Returns the underlying CassandraConverter.

Specified by:

getConverter in interface ReactiveCassandraOperations

Returns:

the underlying CassandraConverter.

getReactiveCqlOperations

public ReactiveCqlOperations getReactiveCqlOperations()

Description copied from interface: ReactiveCassandraOperations

Expose the underlying ReactiveCqlOperations to allow CQL operations.

Specified by:

getReactiveCqlOperations in interface ReactiveCassandraOperations

Returns:

the underlying ReactiveCqlOperations.

See Also:

ReactiveCqlOperations

setApplicationEventPublisher

public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)

Specified by:

setApplicationEventPublisher in interface ApplicationEventPublisherAware

select

public <T> reactor.core.publisher.Flux<T> select(String cql,
                                                 Class<T> entityClass)

Description copied from interface: ReactiveCassandraOperations

Execute a SELECT query and convert the resulting items to a stream of entities.

Specified by:

select in interface ReactiveCassandraOperations

Parameters:

cql - must not be null.

entityClass - The entity type must not be null.

Returns:

the converted results

selectOne

public <T> reactor.core.publisher.Mono<T> selectOne(String cql,
                                                    Class<T> entityClass)

Description copied from interface: ReactiveCassandraOperations

Execute a SELECT query and convert the resulting item to an entity.

Specified by:

selectOne in interface ReactiveCassandraOperations

Parameters:

cql - must not be null.

entityClass - The entity type must not be null.

Returns:

the result object returned by the action or Mono.empty()

select

public <T> reactor.core.publisher.Flux<T> select(com.datastax.driver.core.Statement cql,
                                                 Class<T> entityClass)

Description copied from interface: ReactiveCassandraOperations

Execute a SELECT query and convert the resulting items to a stream of entities.

Specified by:

select in interface ReactiveCassandraOperations

Parameters:

cql - must not be null.

entityClass - The entity type must not be null.

Returns:

the result objects returned by the action.

slice

public <T> reactor.core.publisher.Mono<Slice<T>> slice(com.datastax.driver.core.Statement statement,
                                                       Class<T> entityClass)

Description copied from interface: ReactiveCassandraOperations

Execute a SELECT query with paging and convert the result set to a Slice of entities. A sliced query translates the effective fetch size to the page size.

Specified by:

slice in interface ReactiveCassandraOperations

Parameters:

statement - the CQL statement, must not be null.

entityClass - The entity type must not be null.

Returns:

the result object returned by the action or Mono.just(Object) of an empty Slice.

selectOne

public <T> reactor.core.publisher.Mono<T> selectOne(com.datastax.driver.core.Statement statement,
                                                    Class<T> entityClass)

Description copied from interface: ReactiveCassandraOperations

Execute a SELECT query and convert the resulting item to an entity.

Specified by:

selectOne in interface ReactiveCassandraOperations

Parameters:

statement - must not be null.

entityClass - The entity type must not be null.

Returns:

the result object returned by the action or Mono.empty()

select

public <T> reactor.core.publisher.Flux<T> select(Query query,
                                                 Class<T> entityClass)
                                          throws DataAccessException

Description copied from interface: ReactiveCassandraOperations

Execute a SELECT query and convert the resulting items to a stream of entities.

Specified by:

select in interface ReactiveCassandraOperations

Parameters:

query - must not be null.

entityClass - The entity type must not be null.

Returns:

the result objects returned by the action.

Throws:

DataAccessException - if there is any problem issuing the execution.

slice

public <T> reactor.core.publisher.Mono<Slice<T>> slice(Query query,
                                                       Class<T> entityClass)
                                                throws DataAccessException

Description copied from interface: ReactiveCassandraOperations

Execute a SELECT query with paging and convert the result set to a Slice of entities.

Specified by:

slice in interface ReactiveCassandraOperations

Parameters:

query - the query object used to create a CQL statement, must not be null.

entityClass - The entity type must not be null.

Returns:

the result object returned by the action or Mono.just(Object) of an empty Slice.

Throws:

DataAccessException - if there is any problem executing the query.

See Also:

CassandraPageRequest

selectOne

public <T> reactor.core.publisher.Mono<T> selectOne(Query query,
                                                    Class<T> entityClass)
                                             throws DataAccessException

Description copied from interface: ReactiveCassandraOperations

Execute a SELECT query and convert the resulting item to an entity.

Specified by:

selectOne in interface ReactiveCassandraOperations

Parameters:

query - must not be null.

entityClass - The entity type must not be null.

Returns:

the result object returned by the action or Mono.empty().

Throws:

DataAccessException - if there is any problem issuing the execution.

update

public reactor.core.publisher.Mono<Boolean> update(Query query,
                                                   Update update,
                                                   Class<?> entityClass)
                                            throws DataAccessException

Description copied from interface: ReactiveCassandraOperations

Update the queried entities and return true if the update was applied.

Specified by:

update in interface ReactiveCassandraOperations

Parameters:

query - must not be null.

update - must not be null.

entityClass - The entity type must not be null.

Throws:

DataAccessException - if there is any problem executing the query.

delete

public reactor.core.publisher.Mono<Boolean> delete(Query query,
                                                   Class<?> entityClass)
                                            throws DataAccessException

Description copied from interface: ReactiveCassandraOperations

Remove entities (rows)/columns from the table by Query.

Specified by:

delete in interface ReactiveCassandraOperations

Parameters:

query - must not be null.

entityClass - The entity type must not be null.

Returns:

true if the deletion was applied.

Throws:

DataAccessException - if there is any problem issuing the execution.

count

public reactor.core.publisher.Mono<Long> count(Class<?> entityClass)

Description copied from interface: ReactiveCassandraOperations

Returns the number of rows for the given entity class.

Specified by:

count in interface ReactiveCassandraOperations

Parameters:

entityClass - type of the entity; must not be null.

Returns:

the number of existing entities.

count

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

Description copied from interface: ReactiveCassandraOperations

Returns the number of rows for the given entity class applying Query. This overridden method allows users to further refine the selection criteria using a Query predicate to determine how many entities of the given type match the criteria.

Specified by:

count in interface ReactiveCassandraOperations

Parameters:

query - user-defined count Query to execute; must not be null.

entityClass - type of the entity; must not be null.

Returns:

the number of existing entities.

Throws:

DataAccessException - if any problem occurs while executing the query.

exists

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

Description copied from interface: ReactiveCassandraOperations

Determine whether a row of entityClass with the given id exists.

Specified by:

exists in interface ReactiveCassandraOperations

Parameters:

id - Id value. For single primary keys it's the plain value. For composite primary keys either, it's an instance of either PrimaryKeyClass or MapId. Must not be null.

entityClass - type of the entity; must not be null.

Returns:

true if the object exists.

exists

public reactor.core.publisher.Mono<Boolean> exists(Query query,
                                                   Class<?> entityClass)
                                            throws DataAccessException

Description copied from interface: ReactiveCassandraOperations

Determine whether the result for entityClass Query yields at least one row.

Specified by:

exists in interface ReactiveCassandraOperations

Parameters:

query - user-defined exists Query to execute; must not be null.

entityClass - type of the entity; must not be null.

Returns:

true if the object exists.

Throws:

DataAccessException - if any problem occurs while executing the query.

selectOneById

public <T> reactor.core.publisher.Mono<T> selectOneById(Object id,
                                                        Class<T> entityClass)

Description copied from interface: ReactiveCassandraOperations

Execute the Select by id for the given entityClass.

Specified by:

selectOneById in interface ReactiveCassandraOperations

Parameters:

id - the Id value. For single primary keys it's the plain value. For composite primary keys either the PrimaryKeyClass or MapId. Must not be null.

entityClass - The entity type must not be null.

Returns:

the result object returned by the action or Mono.empty()

insert

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

Description copied from interface: ReactiveCassandraOperations

Insert the given entity and emit the entity if the insert was applied.

Specified by:

insert in interface ReactiveCassandraOperations

Parameters:

entity - The entity to insert, must not be null.

Returns:

the inserted entity.

insert

public <T> reactor.core.publisher.Mono<EntityWriteResult<T>> insert(T entity,
                                                                    InsertOptions options)

Description copied from interface: ReactiveCassandraOperations

Insert the given entity applying WriteOptions and emit the entity if the insert was applied.

Specified by:

insert in interface ReactiveCassandraOperations

Parameters:

entity - The entity to insert, must not be null.

options - must not be null.

Returns:

the EntityWriteResult for this operation.

See Also:

InsertOptions.empty()

update

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

Description copied from interface: ReactiveCassandraOperations

Update the given entity and emit the entity if the update was applied.

Specified by:

update in interface ReactiveCassandraOperations

Parameters:

entity - The entity to update, must not be null.

Returns:

the updated entity.

update

public <T> reactor.core.publisher.Mono<EntityWriteResult<T>> update(T entity,
                                                                    UpdateOptions options)

Description copied from interface: ReactiveCassandraOperations

Update the given entity applying WriteOptions and emit the entity if the update was applied.

Specified by:

update in interface ReactiveCassandraOperations

Parameters:

entity - The entity to update, must not be null.

options - must not be null.

Returns:

the EntityWriteResult for this operation.

See Also:

UpdateOptions.empty()

delete

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

Description copied from interface: ReactiveCassandraOperations

Delete the given entity and emit the entity if the delete was applied.

Specified by:

delete in interface ReactiveCassandraOperations

Parameters:

entity - must not be null.

Returns:

the deleted entity.

delete

public reactor.core.publisher.Mono<WriteResult> delete(Object entity,
                                                       QueryOptions options)

Description copied from interface: ReactiveCassandraOperations

Delete the given entity applying QueryOptions and emit the entity if the delete was applied.

Specified by:

delete in interface ReactiveCassandraOperations

Parameters:

entity - must not be null.

options - must not be null.

Returns:

the WriteResult for this operation.

See Also:

QueryOptions.empty()

deleteById

public reactor.core.publisher.Mono<Boolean> deleteById(Object id,
                                                       Class<?> entityClass)

Description copied from interface: ReactiveCassandraOperations

Remove the given object from the table by id.

Specified by:

deleteById in interface ReactiveCassandraOperations

Parameters:

id - the Id value. For single primary keys it's the plain value. For composite primary keys either the PrimaryKeyClass or MapId. Must not be null.

entityClass - The entity type must not be null.

Returns:

true if the deletion was applied.

truncate

public reactor.core.publisher.Mono<Void> truncate(Class<?> entityClass)

Description copied from interface: ReactiveCassandraOperations

Execute a TRUNCATE query to remove all entities of a given class.

Specified by:

truncate in interface ReactiveCassandraOperations

Parameters:

entityClass - The entity type must not be null.

query

public <T> ReactiveSelectOperation.ReactiveSelect<T> query(Class<T> domainType)

Description copied from interface: ReactiveSelectOperation

Begin creating a SELECT operation for the given domainType.

Specified by:

query in interface ReactiveSelectOperation

Type Parameters:

T - type of the application domain object.

Parameters:

domainType - type of the domain object to query; must not be null.

Returns:

new instance of ReactiveSelectOperation.ReactiveSelect.

See Also:

ReactiveSelectOperation.ReactiveSelect

insert

public <T> ReactiveInsertOperation.ReactiveInsert<T> insert(Class<T> domainType)

Description copied from interface: ReactiveInsertOperation

Begin creating an INSERT operation for given domainType.

Specified by:

insert in interface ReactiveInsertOperation

Type Parameters:

T - type of the application domain object.

Parameters:

domainType - type of the domain object to insert; must not be null.

Returns:

new instance of ReactiveInsertOperation.ReactiveInsert.

See Also:

ReactiveInsertOperation.ReactiveInsert

update

public ReactiveUpdateOperation.ReactiveUpdate update(Class<?> domainType)

Description copied from interface: ReactiveUpdateOperation

Begin creating an UPDATE operation for the given domainType.

Specified by:

update in interface ReactiveUpdateOperation

Parameters:

domainType - type of domain object to update; must not be null.

Returns:

new instance of ReactiveUpdateOperation.ReactiveUpdate.

See Also:

ReactiveUpdateOperation.ReactiveUpdate

delete

public ReactiveDeleteOperation.ReactiveDelete delete(Class<?> domainType)

Description copied from interface: ReactiveDeleteOperation

Begin creating a DELETE operation for the given domainType.

Specified by:

delete in interface ReactiveDeleteOperation

Parameters:

domainType - type of domain object to delete; must not be null.

Returns:

new instance of ReactiveDeleteOperation.ReactiveDelete.

See Also:

ReactiveDeleteOperation.ReactiveDelete

getMappingContext

protected MappingContext<? extends CassandraPersistentEntity<?>,CassandraPersistentProperty> getMappingContext()

Returns the CassandraMappingContext used by this template to access mapping meta-data in order to store (map) object to Cassandra tables.

Returns:

the CassandraMappingContext used by this template.

See Also:

CassandraMappingContext

getProjectionFactory

protected SpelAwareProxyProjectionFactory getProjectionFactory()

Returns a reference to the configured ProjectionFactory used by this template to process CQL query projections.

Returns:

a reference to the configured ProjectionFactory used by this template to process CQL query projections.

Since:

2.1

See Also:

SpelAwareProxyProjectionFactory

getStatementFactory

protected StatementFactory getStatementFactory()

Returns the StatementFactory used by this template to construct and run Cassandra CQL statements.

Returns:

the StatementFactory used by this template to construct and run Cassandra CQL statements.

Since:

2.1

See Also:

StatementFactory