org.springframework.data.cassandra.core

Interface AsyncCassandraOperations

All Known Implementing Classes:

AsyncCassandraTemplate

public interface AsyncCassandraOperations

Interface specifying a basic set of asynchronous Cassandra operations. Implemented by AsyncCassandraTemplate. Not often used directly, but a useful option to enhance testability, as it can easily be mocked or stubbed.

Since:

2.0

Author:

Mark Paluch, John Blum

See Also:

AsyncCassandraTemplate, AsyncCqlOperations, Statement, InsertOptions, UpdateOptions

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

Method Detail

getAsyncCqlOperations

AsyncCqlOperations getAsyncCqlOperations()

Expose the underlying AsyncCqlOperations to allow asynchronous CQL operations.

Returns:

the underlying AsyncCqlOperations.

See Also:

AsyncCqlOperations

getConverter

CassandraConverter getConverter()

Returns the underlying CassandraConverter.

Returns:

the underlying CassandraConverter.

select

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

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

Parameters:

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

select

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

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

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

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

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

Parameters:

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

select

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

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

Parameters:

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.

slice

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

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.

Parameters:

statement - the 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

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

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

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

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

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

Parameters:

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

select

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ListenableFuture<Boolean> delete(Query query,
                                 Class<?> entityClass)
                          throws DataAccessException

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

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

ListenableFuture<Long> count(Class<?> entityClass)
                      throws DataAccessException

Returns the number of rows for the given entity class.

Parameters:

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.

count

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

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.

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.

Since:

2.1

exists

ListenableFuture<Boolean> exists(Object id,
                                 Class<?> entityClass)
                          throws DataAccessException

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

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.

Throws:

DataAccessException - if any problem occurs while executing the query.

exists

ListenableFuture<Boolean> exists(Query query,
                                 Class<?> entityClass)
                          throws DataAccessException

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

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.

Since:

2.1

selectOneById

<T> ListenableFuture<T> selectOneById(Object id,
                                      Class<T> entityClass)
                               throws DataAccessException

Execute the Select by id for the given entityClass.

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.

Throws:

DataAccessException - if there is any problem executing the query.

insert

<T> ListenableFuture<T> insert(T entity)
                        throws DataAccessException

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

Parameters:

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

Returns:

the inserted entity.

Throws:

DataAccessException - if there is any problem executing the query.

insert

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

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

Parameters:

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

options - must not be null.

Returns:

the EntityWriteResult for this operation.

Throws:

DataAccessException - if there is any problem executing the query.

See Also:

InsertOptions.empty()

update

<T> ListenableFuture<T> update(T entity)
                        throws DataAccessException

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

Parameters:

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

Returns:

the updated entity.

Throws:

DataAccessException - if there is any problem executing the query.

update

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

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

Parameters:

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

options - must not be null.

Returns:

the EntityWriteResult for this operation.

Throws:

DataAccessException - if there is any problem executing the query.

See Also:

UpdateOptions.empty()

delete

<T> ListenableFuture<T> delete(T entity)
                        throws DataAccessException

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

Parameters:

entity - must not be null.

Returns:

the deleted entity.

Throws:

DataAccessException - if there is any problem executing the query.

delete

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

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

Parameters:

entity - must not be null.

options - must not be null.

Returns:

the WriteResult for this operation.

Throws:

DataAccessException - if there is any problem executing the query.

See Also:

QueryOptions.empty()

deleteById

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

Remove the given object from the table by id.

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.

Throws:

DataAccessException - if there is any problem executing the query.

truncate

ListenableFuture<Void> truncate(Class<?> entityClass)
                         throws DataAccessException

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

Parameters:

entityClass - The entity type must not be null.

Throws:

DataAccessException - if there is any problem executing the query.