org.springframework.data.cassandra.core

Class AsyncCassandraTemplate

java.lang.Object

org.springframework.data.cassandra.core.AsyncCassandraTemplate

All Implemented Interfaces:

Aware, ApplicationEventPublisherAware, AsyncCassandraOperations

public class AsyncCassandraTemplate
extends Object
implements AsyncCassandraOperations, ApplicationEventPublisherAware

Primary implementation of AsyncCassandraOperations. It simplifies the use of asynchronous Cassandra usage and helps to avoid common errors. It executes core Cassandra workflow. This class executes CQL queries or updates, initiating iteration over ResultSet 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 Session reference, or get prepared in an application context and given to services as bean reference.

Note: The Session 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

See Also:

AsyncCassandraOperations

Constructor Summary

Constructors

Constructor and Description
AsyncCassandraTemplate(AsyncCqlTemplate asyncCqlTemplate, CassandraConverter converter) Creates an instance of AsyncCassandraTemplate initialized with the given AsyncCqlTemplate and CassandraConverter.
AsyncCassandraTemplate(com.datastax.driver.core.Session session) Creates an instance of AsyncCassandraTemplate initialized with the given Session and a default MappingCassandraConverter.
AsyncCassandraTemplate(com.datastax.driver.core.Session session, CassandraConverter converter) Creates an instance of AsyncCassandraTemplate initialized with the given Session and CassandraConverter.
AsyncCassandraTemplate(SessionFactory sessionFactory, CassandraConverter converter) Creates an instance of AsyncCassandraTemplate initialized with the given SessionFactory and CassandraConverter.

Method Summary

Modifier and Type	Method and Description
ListenableFuture<Long>	count(Class<?> entityClass) Returns the number of rows for the given entity class.
ListenableFuture<Long>	count(Query query, Class<?> entityClass) Returns the number of rows for the given entity class applying Query.
ListenableFuture<WriteResult>	delete(Object entity, QueryOptions options) Delete the given entity applying QueryOptions and return the entity if the delete was applied.
ListenableFuture<Boolean>	delete(Query query, Class<?> entityClass) Remove entities (rows)/columns from the table by Query.
<T> ListenableFuture<T>	delete(T entity) Delete the given entity and return the entity if the delete was applied.
ListenableFuture<Boolean>	deleteById(Object id, Class<?> entityClass) Remove the given object from the table by id.
ListenableFuture<Boolean>	exists(Object id, Class<?> entityClass) Determine whether a row of entityClass with the given id exists.
ListenableFuture<Boolean>	exists(Query query, Class<?> entityClass) Determine whether the result for entityClass Query yields at least one row.
AsyncCqlOperations	getAsyncCqlOperations() Expose the underlying AsyncCqlOperations to allow asynchronous CQL operations.
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.
protected StatementFactory	getStatementFactory() Returns the StatementFactory used by this template to construct and run Cassandra CQL statements.
<T> ListenableFuture<T>	insert(T entity) Insert the given entity and return the entity if the insert was applied.
<T> ListenableFuture<EntityWriteResult<T>>	insert(T entity, InsertOptions options) Insert the given entity applying WriteOptions and return the entity if the insert was applied.
<T> ListenableFuture<List<T>>	select(Query query, Class<T> entityClass) Execute a SELECT query and convert the resulting items to a List of entities.
<T> ListenableFuture<Void>	select(Query query, Consumer<T> entityConsumer, Class<T> entityClass) Execute a SELECT query and convert the resulting items notifying Consumer for each entity.
<T> ListenableFuture<List<T>>	select(com.datastax.driver.core.Statement statement, Class<T> entityClass) Execute a SELECT query and convert the resulting items to a List of entities.
<T> ListenableFuture<Void>	select(com.datastax.driver.core.Statement statement, Consumer<T> entityConsumer, Class<T> entityClass) Execute a SELECT query and convert the resulting items notifying Consumer for each entity.
<T> ListenableFuture<List<T>>	select(String cql, Class<T> entityClass) Execute a SELECT query and convert the resulting items to a List of entities.
<T> ListenableFuture<Void>	select(String cql, Consumer<T> entityConsumer, Class<T> entityClass) Execute a SELECT query and convert the resulting items notifying Consumer for each entity.
<T> ListenableFuture<T>	selectOne(Query query, Class<T> entityClass) Execute a SELECT query and convert the resulting item to an entity.
<T> ListenableFuture<T>	selectOne(com.datastax.driver.core.Statement statement, Class<T> entityClass) Execute a SELECT query and convert the resulting item to an entity.
<T> ListenableFuture<T>	selectOne(String cql, Class<T> entityClass) Execute a SELECT query and convert the resulting item to an entity.
<T> ListenableFuture<T>	selectOneById(Object id, Class<T> entityClass) Execute the Select by id for the given entityClass.
void	setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)
<T> ListenableFuture<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> ListenableFuture<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.
ListenableFuture<Void>	truncate(Class<?> entityClass) Execute a TRUNCATE query to remove all entities of a given class.
ListenableFuture<Boolean>	update(Query query, Update update, Class<?> entityClass) Update the queried entities and return true if the update was applied.
<T> ListenableFuture<T>	update(T entity) Update the given entity and return the entity if the update was applied.
<T> ListenableFuture<EntityWriteResult<T>>	update(T entity, UpdateOptions options) Update the given entity applying WriteOptions and return 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

AsyncCassandraTemplate

public AsyncCassandraTemplate(com.datastax.driver.core.Session session)

Creates an instance of AsyncCassandraTemplate initialized with the given Session and a default MappingCassandraConverter.

Parameters:

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

See Also:

CassandraConverter, Session

AsyncCassandraTemplate

public AsyncCassandraTemplate(com.datastax.driver.core.Session session,
                              CassandraConverter converter)

Creates an instance of AsyncCassandraTemplate initialized with the given Session and CassandraConverter.

Parameters:

session - Session 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

AsyncCassandraTemplate

public AsyncCassandraTemplate(SessionFactory sessionFactory,
                              CassandraConverter converter)

Creates an instance of AsyncCassandraTemplate initialized with the given SessionFactory and CassandraConverter.

Parameters:

sessionFactory - SessionFactory 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

AsyncCassandraTemplate

public AsyncCassandraTemplate(AsyncCqlTemplate asyncCqlTemplate,
                              CassandraConverter converter)

Creates an instance of AsyncCassandraTemplate initialized with the given AsyncCqlTemplate and CassandraConverter.

Parameters:

asyncCqlTemplate - AsyncCqlTemplate 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

getAsyncCqlOperations

public AsyncCqlOperations getAsyncCqlOperations()

Description copied from interface: AsyncCassandraOperations

Expose the underlying AsyncCqlOperations to allow asynchronous CQL operations.

Specified by:

getAsyncCqlOperations in interface AsyncCassandraOperations

Returns:

the underlying AsyncCqlOperations.

See Also:

AsyncCqlOperations

getConverter

public CassandraConverter getConverter()

Description copied from interface: AsyncCassandraOperations

Returns the underlying CassandraConverter.

Specified by:

getConverter in interface AsyncCassandraOperations

Returns:

the underlying CassandraConverter.

setApplicationEventPublisher

public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)

Specified by:

setApplicationEventPublisher in interface ApplicationEventPublisherAware

select

public <T> ListenableFuture<List<T>> select(String cql,
                                            Class<T> entityClass)

Description copied from interface: AsyncCassandraOperations

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

Specified by:

select in interface AsyncCassandraOperations

Parameters:

cql - must not be null.

entityClass - The entity type must not be null.

Returns:

the converted results

select

public <T> ListenableFuture<Void> select(String cql,
                                         Consumer<T> entityConsumer,
                                         Class<T> entityClass)
                                  throws DataAccessException

Description copied from interface: AsyncCassandraOperations

Execute a SELECT query and convert the resulting items notifying Consumer for each entity.

Specified by:

select in interface AsyncCassandraOperations

Parameters:

cql - must not be null.

entityConsumer - object that will be notified on each entity, one object at a time, must not be null.

entityClass - The entity type must not be null.

Returns:

the completion handle

Throws:

DataAccessException - if there is any problem executing the query.

selectOne

public <T> ListenableFuture<T> selectOne(String cql,
                                         Class<T> entityClass)

Description copied from interface: AsyncCassandraOperations

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

Specified by:

selectOne in interface AsyncCassandraOperations

Parameters:

cql - must not be null.

entityClass - The entity type must not be null.

Returns:

the converted object or null.

select

public <T> ListenableFuture<List<T>> select(com.datastax.driver.core.Statement statement,
                                            Class<T> entityClass)

Description copied from interface: AsyncCassandraOperations

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

Specified by:

select in interface AsyncCassandraOperations

Parameters:

statement - must not be null.

entityClass - The entity type must not be null.

Returns:

the converted results

slice

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

Description copied from interface: AsyncCassandraOperations

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 AsyncCassandraOperations

Parameters:

statement - the CQL statement, must not be null.

entityClass - The entity type must not be null.

Returns:

the converted results

See Also:

CassandraPageRequest

select

public <T> ListenableFuture<Void> select(com.datastax.driver.core.Statement statement,
                                         Consumer<T> entityConsumer,
                                         Class<T> entityClass)
                                  throws DataAccessException

Description copied from interface: AsyncCassandraOperations

Execute a SELECT query and convert the resulting items notifying Consumer for each entity.

Specified by:

select in interface AsyncCassandraOperations

Parameters:

statement - must not be null.

entityConsumer - object that will be notified on each entity, one object at a time, must not be null.

entityClass - The entity type must not be null.

Returns:

the completion handle

Throws:

DataAccessException - if there is any problem executing the query.

selectOne

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

Description copied from interface: AsyncCassandraOperations

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

Specified by:

selectOne in interface AsyncCassandraOperations

Parameters:

statement - must not be null.

entityClass - The entity type must not be null.

Returns:

the converted object or null.

select

public <T> ListenableFuture<List<T>> select(Query query,
                                            Class<T> entityClass)
                                     throws DataAccessException

Description copied from interface: AsyncCassandraOperations

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

Specified by:

select in interface AsyncCassandraOperations

Parameters:

query - must not be null.

entityClass - The entity type must not be null.

Returns:

the converted results

Throws:

DataAccessException - if there is any problem executing the query.

slice

public <T> ListenableFuture<Slice<T>> slice(Query query,
                                            Class<T> entityClass)
                                     throws DataAccessException

Description copied from interface: AsyncCassandraOperations

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

Specified by:

slice in interface AsyncCassandraOperations

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 converted results

Throws:

DataAccessException - if there is any problem executing the query.

See Also:

CassandraPageRequest

select

public <T> ListenableFuture<Void> select(Query query,
                                         Consumer<T> entityConsumer,
                                         Class<T> entityClass)
                                  throws DataAccessException

Description copied from interface: AsyncCassandraOperations

Execute a SELECT query and convert the resulting items notifying Consumer for each entity.

Specified by:

select in interface AsyncCassandraOperations

Parameters:

query - must not be null.

entityConsumer - object that will be notified on each entity, one object at a time, must not be null.

entityClass - The entity type must not be null.

Returns:

the completion handle

Throws:

DataAccessException - if there is any problem executing the query.

selectOne

public <T> ListenableFuture<T> selectOne(Query query,
                                         Class<T> entityClass)
                                  throws DataAccessException

Description copied from interface: AsyncCassandraOperations

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

Specified by:

selectOne in interface AsyncCassandraOperations

Parameters:

query - must not be null.

entityClass - The entity type must not be null.

Returns:

the converted object or null.

Throws:

DataAccessException - if there is any problem executing the query.

update

public ListenableFuture<Boolean> update(Query query,
                                        Update update,
                                        Class<?> entityClass)
                                 throws DataAccessException

Description copied from interface: AsyncCassandraOperations

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

Specified by:

update in interface AsyncCassandraOperations

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 ListenableFuture<Boolean> delete(Query query,
                                        Class<?> entityClass)
                                 throws DataAccessException

Description copied from interface: AsyncCassandraOperations

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

Specified by:

delete in interface AsyncCassandraOperations

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 executing the query.

count

public ListenableFuture<Long> count(Class<?> entityClass)

Description copied from interface: AsyncCassandraOperations

Returns the number of rows for the given entity class.

Specified by:

count in interface AsyncCassandraOperations

Parameters:

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

Returns:

the number of existing entities.

count

public ListenableFuture<Long> count(Query query,
                                    Class<?> entityClass)
                             throws DataAccessException

Description copied from interface: AsyncCassandraOperations

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 AsyncCassandraOperations

Parameters:

query - user-provided 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 ListenableFuture<Boolean> exists(Object id,
                                        Class<?> entityClass)

Description copied from interface: AsyncCassandraOperations

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

Specified by:

exists in interface AsyncCassandraOperations

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 ListenableFuture<Boolean> exists(Query query,
                                        Class<?> entityClass)
                                 throws DataAccessException

Description copied from interface: AsyncCassandraOperations

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

Specified by:

exists in interface AsyncCassandraOperations

Parameters:

query - user-provided 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> ListenableFuture<T> selectOneById(Object id,
                                             Class<T> entityClass)

Description copied from interface: AsyncCassandraOperations

Execute the Select by id for the given entityClass.

Specified by:

selectOneById in interface AsyncCassandraOperations

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 converted object or null.

insert

public <T> ListenableFuture<T> insert(T entity)

Description copied from interface: AsyncCassandraOperations

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

Specified by:

insert in interface AsyncCassandraOperations

Parameters:

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

Returns:

the inserted entity.

insert

public <T> ListenableFuture<EntityWriteResult<T>> insert(T entity,
                                                         InsertOptions options)

Description copied from interface: AsyncCassandraOperations

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

Specified by:

insert in interface AsyncCassandraOperations

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> ListenableFuture<T> update(T entity)

Description copied from interface: AsyncCassandraOperations

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

Specified by:

update in interface AsyncCassandraOperations

Parameters:

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

Returns:

the updated entity.

update

public <T> ListenableFuture<EntityWriteResult<T>> update(T entity,
                                                         UpdateOptions options)

Description copied from interface: AsyncCassandraOperations

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

Specified by:

update in interface AsyncCassandraOperations

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> ListenableFuture<T> delete(T entity)

Description copied from interface: AsyncCassandraOperations

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

Specified by:

delete in interface AsyncCassandraOperations

Parameters:

entity - must not be null.

Returns:

the deleted entity.

delete

public ListenableFuture<WriteResult> delete(Object entity,
                                            QueryOptions options)

Description copied from interface: AsyncCassandraOperations

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

Specified by:

delete in interface AsyncCassandraOperations

Parameters:

entity - must not be null.

options - must not be null.

Returns:

the WriteResult for this operation.

See Also:

QueryOptions.empty()

deleteById

public ListenableFuture<Boolean> deleteById(Object id,
                                            Class<?> entityClass)

Description copied from interface: AsyncCassandraOperations

Remove the given object from the table by id.

Specified by:

deleteById in interface AsyncCassandraOperations

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 ListenableFuture<Void> truncate(Class<?> entityClass)

Description copied from interface: AsyncCassandraOperations

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

Specified by:

truncate in interface AsyncCassandraOperations

Parameters:

entityClass - The entity type must not be null.

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