org.springframework.data.cql.core

Class AsyncCqlTemplate

java.lang.Object

org.springframework.data.cql.support.CassandraAccessor

org.springframework.data.cql.core.CqlTemplateSupport

org.springframework.data.cql.core.AsyncCqlTemplate

All Implemented Interfaces:

InitializingBean, AsyncCqlOperations

public class AsyncCqlTemplate
extends CqlTemplateSupport
implements AsyncCqlOperations

This is the central class in the CQL core package for asynchronous Cassandra data access. It simplifies the use of CQL and helps to avoid common errors. It executes core CQL workflow, leaving application code to provide CQL and extract results. This class executes CQL queries or updates, initiating iteration over ResultSets and catching DriverException exceptions and translating them to the generic, more informative exception hierarchy defined in the org.springframework.dao package.

Code using this class need only implement callback interfaces, giving them a clearly defined contract. The PreparedStatementCreator callback interface creates a prepared statement given a Connection, providing CQL and any necessary parameters. The ResultSetExtractor interface extracts values from a ResultSet. See also PreparedStatementBinder and RowMapper for two popular alternative callback interfaces.

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.

Because this class is parameterizable by the callback interfaces and the PersistenceExceptionTranslator interface, there should be no need to subclass it.

All CQL operations performed by this class are logged at debug level, using "org.springframework.data.cql.core.CqlTemplate" as log category.

NOTE: An instance of this class is thread-safe once configured.

Author:

Mark Paluch, John Blum

See Also:

ListenableFuture, PreparedStatementCreator, PreparedStatementBinder, PreparedStatementCallback, ResultSetExtractor, RowCallbackHandler, RowMapper, PersistenceExceptionTranslator

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.data.cql.core.CqlTemplateSupport

CqlTemplateSupport.RowCallbackHandlerResultSetExtractor

Field Summary

Fields inherited from class org.springframework.data.cql.support.CassandraAccessor

exceptionTranslator, logger

Constructor Summary

Constructors

Constructor and Description
AsyncCqlTemplate() Create a new, uninitialized AsyncCqlTemplate.
AsyncCqlTemplate(com.datastax.driver.core.Session session) Create a new AsyncCqlTemplate with the given Session.
AsyncCqlTemplate(SessionFactory sessionFactory) Constructs a new AsyncCqlTemplate with the given SessionFactory.

Method Summary

Modifier and Type	Method and Description
ListenableFuture<Boolean>	execute(AsyncPreparedStatementCreator preparedStatementCreator) Issue a single CQL execute operation (such as an insert, update or delete statement) using a AsyncPreparedStatementCreator to provide CQL and any required parameters.
<T> ListenableFuture<T>	execute(AsyncPreparedStatementCreator preparedStatementCreator, PreparedStatementCallback<T> action) Execute a CQL data access operation, implemented as callback action working on a CQL PreparedStatement.
<T> ListenableFuture<T>	execute(AsyncSessionCallback<T> action) Execute a CQL data access operation, implemented as callback action working on a Session.
ListenableFuture<Boolean>	execute(com.datastax.driver.core.Statement statement) Issue a single CQL execute, typically a DDL statement, insert, update or delete statement.
ListenableFuture<Boolean>	execute(String cql) Issue a single CQL execute, typically a DDL statement, insert, update or delete statement.
ListenableFuture<Boolean>	execute(String cql, Object... args) Issue a single CQL operation (such as an insert, update or delete statement) via a prepared statement, binding the given arguments.
ListenableFuture<Boolean>	execute(String cql, PreparedStatementBinder preparedStatementBinder) Issue an statement using a PreparedStatementBinder to set bind parameters, with given CQL.
<T> ListenableFuture<T>	execute(String cql, PreparedStatementCallback<T> action) Execute a CQL data access operation, implemented as callback action working on a CQL PreparedStatement.
protected AsyncPreparedStatementCreator	newAsyncPreparedStatementCreator(String cql) Create a new CQL-based AsyncPreparedStatementCreator using the CQL passed in.
<T> ListenableFuture<T>	query(AsyncPreparedStatementCreator preparedStatementCreator, PreparedStatementBinder preparedStatementBinder, ResultSetExtractor<T> resultSetExtractor) Query using a prepared statement and a PreparedStatementBinder implementation that knows how to bind values to the query, reading the ResultSet with a ResultSetExtractor.
ListenableFuture<Void>	query(AsyncPreparedStatementCreator preparedStatementCreator, PreparedStatementBinder preparedStatementBinder, RowCallbackHandler rowCallbackHandler) Query using a prepared statement and a PreparedStatementBinder implementation that knows how to bind values to the query, reading the ResultSet on a per-row basis with a RowCallbackHandler.
<T> ListenableFuture<List<T>>	query(AsyncPreparedStatementCreator preparedStatementCreator, PreparedStatementBinder preparedStatementBinder, RowMapper<T> rowMapper) Query using a prepared statement and a PreparedStatementBinder implementation that knows how to bind values to the query, mapping each row to a Java object via a RowMapper.
<T> ListenableFuture<T>	query(AsyncPreparedStatementCreator preparedStatementCreator, ResultSetExtractor<T> resultSetExtractor) Query using a prepared statement, reading the ResultSet with a ResultSetExtractor.
ListenableFuture<Void>	query(AsyncPreparedStatementCreator preparedStatementCreator, RowCallbackHandler rowCallbackHandler) Query using a prepared statement, reading the ResultSet on a per-row basis with a RowCallbackHandler.
<T> ListenableFuture<List<T>>	query(AsyncPreparedStatementCreator preparedStatementCreator, RowMapper<T> rowMapper) Query using a prepared statement, mapping each row to a Java object via a RowMapper.
<T> ListenableFuture<T>	query(com.datastax.driver.core.Statement statement, ResultSetExtractor<T> resultSetExtractor) Execute a query given static CQL, reading the ResultSet with a ResultSetExtractor.
ListenableFuture<Void>	query(com.datastax.driver.core.Statement statement, RowCallbackHandler rowCallbackHandler) Execute a query given static CQL, reading the ResultSet on a per-row basis with a RowCallbackHandler.
<T> ListenableFuture<List<T>>	query(com.datastax.driver.core.Statement statement, RowMapper<T> rowMapper) Execute a query given static CQL, mapping each row to a Java object via a RowMapper.
<T> ListenableFuture<T>	query(String cql, PreparedStatementBinder preparedStatementBinder, ResultSetExtractor<T> resultSetExtractor) Query using a prepared statement, reading the ResultSet with a ResultSetExtractor.
ListenableFuture<Void>	query(String cql, PreparedStatementBinder preparedStatementBinder, RowCallbackHandler rowCallbackHandler) Query given CQL to create a prepared statement from CQL and a PreparedStatementBinder implementation that knows how to bind values to the query, reading the ResultSet on a per-row basis with a RowCallbackHandler.
<T> ListenableFuture<List<T>>	query(String cql, PreparedStatementBinder preparedStatementBinder, RowMapper<T> rowMapper) Query given CQL to create a prepared statement from CQL and a PreparedStatementBinder implementation that knows how to bind values to the query, mapping each row to a Java object via a RowMapper.
<T> ListenableFuture<T>	query(String cql, ResultSetExtractor<T> resultSetExtractor) Execute a query given static CQL, reading the ResultSet with a ResultSetExtractor.
<T> ListenableFuture<T>	query(String cql, ResultSetExtractor<T> resultSetExtractor, Object... args) Query given CQL to create a prepared statement from CQL and a list of arguments to bind to the query, reading the ResultSet with a ResultSetExtractor.
ListenableFuture<Void>	query(String cql, RowCallbackHandler rowCallbackHandler) Execute a query given static CQL, reading the ResultSet on a per-row basis with a RowCallbackHandler.
ListenableFuture<Void>	query(String cql, RowCallbackHandler rowCallbackHandler, Object... args) Query given CQL to create a prepared statement from CQL and a list of arguments to bind to the query, reading the ResultSet on a per-row basis with a RowCallbackHandler.
<T> ListenableFuture<List<T>>	query(String cql, RowMapper<T> rowMapper) Execute a query given static CQL, mapping each row to a Java object via a RowMapper.
<T> ListenableFuture<List<T>>	query(String cql, RowMapper<T> rowMapper, Object... args) Query given CQL to create a prepared statement from CQL and a list of arguments to bind to the query, mapping each row to a Java object via a RowMapper.
ListenableFuture<List<Map<String,Object>>>	queryForList(com.datastax.driver.core.Statement statement) Execute a query for a result List, given static CQL.
<T> ListenableFuture<List<T>>	queryForList(com.datastax.driver.core.Statement statement, Class<T> elementType) Execute a query for a result List, given static CQL.
ListenableFuture<List<Map<String,Object>>>	queryForList(String cql) Execute a query for a result List, given static CQL.
<T> ListenableFuture<List<T>>	queryForList(String cql, Class<T> elementType) Execute a query for a result List, given static CQL.
<T> ListenableFuture<List<T>>	queryForList(String cql, Class<T> elementType, Object... args) Query given CQL to create a prepared statement from CQL and a list of arguments to bind to the query, expecting a result List.
ListenableFuture<List<Map<String,Object>>>	queryForList(String cql, Object... args) Query given CQL to create a prepared statement from CQL and a list of arguments to bind to the query, expecting a result List.
ListenableFuture<Map<String,Object>>	queryForMap(com.datastax.driver.core.Statement statement) Execute a query for a result Map, given static CQL.
ListenableFuture<Map<String,Object>>	queryForMap(String cql) Execute a query for a result Map, given static CQL.
ListenableFuture<Map<String,Object>>	queryForMap(String cql, Object... args) Query given CQL to create a prepared statement from CQL and a list of arguments to bind to the query, expecting a result Map.
<T> ListenableFuture<T>	queryForObject(com.datastax.driver.core.Statement statement, Class<T> requiredType) Execute a query for a result object, given static CQL.
<T> ListenableFuture<T>	queryForObject(com.datastax.driver.core.Statement statement, RowMapper<T> rowMapper) Execute a query given static CQL, mapping a single result row to a Java object via a RowMapper.
<T> ListenableFuture<T>	queryForObject(String cql, Class<T> requiredType) Execute a query for a result object, given static CQL.
<T> ListenableFuture<T>	queryForObject(String cql, Class<T> requiredType, Object... args) Query given CQL to create a prepared statement from CQL and a list of arguments to bind to the query, expecting a result object.
<T> ListenableFuture<T>	queryForObject(String cql, RowMapper<T> rowMapper) Execute a query given static CQL, mapping a single result row to a Java object via a RowMapper.
<T> ListenableFuture<T>	queryForObject(String cql, RowMapper<T> rowMapper, Object... args) Query given CQL to create a prepared statement from CQL and a list of arguments to bind to the query, mapping a single result row to a Java object via a RowMapper.
ListenableFuture<com.datastax.driver.core.ResultSet>	queryForResultSet(com.datastax.driver.core.Statement statement) Execute a query for a ResultSet, given static CQL.
ListenableFuture<com.datastax.driver.core.ResultSet>	queryForResultSet(String cql) Execute a query for a ResultSet, given static CQL.
ListenableFuture<com.datastax.driver.core.ResultSet>	queryForResultSet(String cql, Object... args) Query given CQL to create a prepared statement from CQL and a list of arguments to bind to the query, expecting a ResultSet.
protected DataAccessException	translateException(String task, String cql, com.datastax.driver.core.exceptions.DriverException ex) Translate the given DriverException into a generic DataAccessException.
protected DataAccessException	translateExceptionIfPossible(String task, String cql, RuntimeException ex) Translate the given DriverException into a generic DataAccessException.

Methods inherited from class org.springframework.data.cql.core.CqlTemplateSupport

newColumnMapRowMapper, newPreparedStatementBinder, newResultSetExtractor, newResultSetExtractor, newResultSetExtractor, newSingleColumnRowMapper, toCql

Methods inherited from class org.springframework.data.cql.support.CassandraAccessor

afterPropertiesSet, applyStatementSettings, applyStatementSettings, getConsistencyLevel, getExceptionTranslator, getFetchSize, getRetryPolicy, getSession, getSessionFactory, setConsistencyLevel, setExceptionTranslator, setFetchSize, setRetryPolicy, setSession, setSessionFactory, translate, translateExceptionIfPossible

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncCqlTemplate

public AsyncCqlTemplate()

Create a new, uninitialized AsyncCqlTemplate. Note: The SessionFactory has to be set before using the instance.

See Also:

CassandraAccessor.setSessionFactory(SessionFactory)

AsyncCqlTemplate

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

Create a new AsyncCqlTemplate with the given Session.

Parameters:

session - the active Cassandra Session, must not be null.

Throws:

IllegalStateException - if Session is null.

See Also:

Session

AsyncCqlTemplate

public AsyncCqlTemplate(SessionFactory sessionFactory)

Constructs a new AsyncCqlTemplate with the given SessionFactory.

Parameters:

sessionFactory - the active Cassandra SessionFactory.

Since:

2.0

See Also:

SessionFactory

Method Detail

execute

public <T> ListenableFuture<T> execute(AsyncSessionCallback<T> action)
                                throws DataAccessException

Description copied from interface: AsyncCqlOperations

Execute a CQL data access operation, implemented as callback action working on a Session. This allows for implementing arbitrary data access operations, within Spring's managed CQL environment: that is, converting CQL DriverExceptions into Spring's DataAccessException hierarchy.

The callback action can return a result object, for example a domain object or a collection of domain objects.

Specified by:

execute in interface AsyncCqlOperations

Parameters:

action - the callback object that specifies the action.

Returns:

a result object returned by the action, or null.

Throws:

DataAccessException - if there is any problem executing the query.

execute

public ListenableFuture<Boolean> execute(String cql)
                                  throws DataAccessException

Description copied from interface: AsyncCqlOperations

Issue a single CQL execute, typically a DDL statement, insert, update or delete statement.

Specified by:

execute in interface AsyncCqlOperations

Parameters:

cql - static CQL to execute, must not be empty or null.

Returns:

boolean value whether the statement was applied.

Throws:

DataAccessException - if there is any problem executing the query.

query

public <T> ListenableFuture<T> query(String cql,
                                     ResultSetExtractor<T> resultSetExtractor)
                              throws DataAccessException

Description copied from interface: AsyncCqlOperations

Execute a query given static CQL, reading the ResultSet with a ResultSetExtractor.

Uses a CQL Statement, not a PreparedStatement. If you want to execute a static query with a PreparedStatement, use the overloaded query method with null as argument array.

Specified by:

query in interface AsyncCqlOperations

Parameters:

cql - static CQL to execute, must not be empty or null.

resultSetExtractor - object that will extract all rows of results, must not be null.

Returns:

an arbitrary result object, as returned by the ResultSetExtractor.

Throws:

DataAccessException - if there is any problem executing the query.

See Also:

AsyncCqlOperations.query(String, ResultSetExtractor, Object...)

query

public ListenableFuture<Void> query(String cql,
                                    RowCallbackHandler rowCallbackHandler)
                             throws DataAccessException

Description copied from interface: AsyncCqlOperations

Execute a query given static CQL, reading the ResultSet on a per-row basis with a RowCallbackHandler.

Uses a CQL Statement, not a PreparedStatement. If you want to execute a static query with a PreparedStatement, use the overloaded query method with null as argument array.

Specified by:

query in interface AsyncCqlOperations

Parameters:

cql - static CQL to execute, must not be empty or null.

rowCallbackHandler - object that will extract results, one row at a time, must not be null.

Throws:

DataAccessException - if there is any problem executing the query

See Also:

AsyncCqlOperations.query(String, RowCallbackHandler, Object[])

query

public <T> ListenableFuture<List<T>> query(String cql,
                                           RowMapper<T> rowMapper)
                                    throws DataAccessException

Description copied from interface: AsyncCqlOperations

Execute a query given static CQL, mapping each row to a Java object via a RowMapper.

Uses a CQL Statement, not a PreparedStatement. If you want to execute a static query with a PreparedStatement, use the overloaded query method with null as argument array.

Specified by:

query in interface AsyncCqlOperations

Parameters:

cql - static CQL to execute, must not be empty or null.

rowMapper - object that will map one object per row, must not be null.

Returns:

the result List, containing mapped objects.

Throws:

DataAccessException - if there is any problem executing the query

See Also:

AsyncCqlOperations.query(String, RowMapper, Object[])

queryForList

public ListenableFuture<List<Map<String,Object>>> queryForList(String cql)
                                                        throws DataAccessException

Description copied from interface: AsyncCqlOperations

Execute a query for a result List, given static CQL.

Uses a CQL Statement, not a PreparedStatement. If you want to execute a static query with a PreparedStatement, use the overloaded queryForList method with null as argument array.

The results will be mapped to a List (one item for each row) of Maps (one entry for each column using the column name as the key). Each item in the List will be of the form returned by this interface's queryForMap() methods.

Specified by:

queryForList in interface AsyncCqlOperations

Parameters:

cql - static CQL to execute, must not be empty or null.

Returns:

a List that contains a Map per row.

Throws:

DataAccessException - if there is any problem executing the query.

See Also:

AsyncCqlOperations.queryForList(String, Object[])

queryForList

public <T> ListenableFuture<List<T>> queryForList(String cql,
                                                  Class<T> elementType)
                                           throws DataAccessException

Description copied from interface: AsyncCqlOperations

Execute a query for a result List, given static CQL.

Uses a CQL Statement, not a PreparedStatement. If you want to execute a static query with a PreparedStatement, use the overloaded queryForList method with null as argument array.

The results will be mapped to a List (one item for each row) of result objects, each of them matching the specified element type.

Specified by:

queryForList in interface AsyncCqlOperations

Parameters:

cql - static CQL to execute, must not be empty or null.

elementType - the required type of element in the result List (for example, Integer.class), must not be null.

Returns:

a List of objects that match the specified element type.

Throws:

DataAccessException - if there is any problem executing the query.

See Also:

AsyncCqlOperations.queryForList(String, Class, Object[]), SingleColumnRowMapper

queryForMap

public ListenableFuture<Map<String,Object>> queryForMap(String cql)
                                                 throws DataAccessException

Description copied from interface: AsyncCqlOperations

Execute a query for a result Map, given static CQL.

Uses a CQL Statement, not a PreparedStatement. If you want to execute a static query with a PreparedStatement, use the overloaded AsyncCqlOperations.queryForMap(String, Object...) method with null as argument array.

The query is expected to be a single row query; the result row will be mapped to a Map (one entry for each column, using the column name as the key).

Specified by:

queryForMap in interface AsyncCqlOperations

Parameters:

cql - static CQL to execute, must not be empty or null.

Returns:

the result Map (one entry for each column, using the column name as the key), must not be null.

Throws:

IncorrectResultSizeDataAccessException - if the query does not return exactly one row.

DataAccessException - if there is any problem executing the query.

See Also:

AsyncCqlOperations.queryForMap(String, Object[]), ColumnMapRowMapper

queryForObject

public <T> ListenableFuture<T> queryForObject(String cql,
                                              Class<T> requiredType)
                                       throws DataAccessException

Description copied from interface: AsyncCqlOperations

Execute a query for a result object, given static CQL.

Uses a CQL Statement, not a PreparedStatement. If you want to execute a static query with a PreparedStatement, use the overloaded AsyncCqlOperations.queryForObject(String, Class, Object...) method with null as argument array.

This method is useful for running static CQL with a known outcome. The query is expected to be a single row/single column query; the returned result will be directly mapped to the corresponding object type.

Specified by:

queryForObject in interface AsyncCqlOperations

Parameters:

cql - static CQL to execute, must not be empty or null.

requiredType - the type that the result object is expected to match, must not be null.

Returns:

the result object of the required type, or Mono.empty() in case of CQL NULL.

Throws:

IncorrectResultSizeDataAccessException - if the query does not return exactly one row, or does not return exactly one column in that row.

DataAccessException - if there is any problem executing the query.

See Also:

AsyncCqlOperations.queryForObject(String, Class, Object[])

queryForObject

public <T> ListenableFuture<T> queryForObject(String cql,
                                              RowMapper<T> rowMapper)
                                       throws DataAccessException

Description copied from interface: AsyncCqlOperations

Execute a query given static CQL, mapping a single result row to a Java object via a RowMapper.

Uses a CQL Statement, not a PreparedStatement. If you want to execute a static query with a PreparedStatement, use the overloaded AsyncCqlOperations.queryForObject(String, RowMapper, Object...) method with null as argument array.

Specified by:

queryForObject in interface AsyncCqlOperations

Parameters:

cql - static CQL to execute, must not be empty or null.

rowMapper - object that will map one object per row, must not be null.

Returns:

the single mapped object.

Throws:

IncorrectResultSizeDataAccessException - if the query does not return exactly one row.

DataAccessException - if there is any problem executing the query.

See Also:

AsyncCqlOperations.queryForObject(String, RowMapper, Object[])

queryForResultSet

public ListenableFuture<com.datastax.driver.core.ResultSet> queryForResultSet(String cql)
                                                                       throws DataAccessException

Description copied from interface: AsyncCqlOperations

Execute a query for a ResultSet, given static CQL.

Uses a CQL Statement, not a PreparedStatement. If you want to execute a static query with a PreparedStatement, use the overloaded queryForResultSet method with null as argument array.

The results will be mapped to an ResultSet.

Specified by:

queryForResultSet in interface AsyncCqlOperations

Parameters:

cql - static CQL to execute, must not be empty or null.

Returns:

a ResultSet representation.

Throws:

DataAccessException - if there is any problem executing the query.

See Also:

AsyncCqlOperations.queryForResultSet(String, Object[])

execute

public ListenableFuture<Boolean> execute(com.datastax.driver.core.Statement statement)
                                  throws DataAccessException

Description copied from interface: AsyncCqlOperations

Issue a single CQL execute, typically a DDL statement, insert, update or delete statement.

Specified by:

execute in interface AsyncCqlOperations

Parameters:

statement - static CQL Statement, must not be null.

Returns:

boolean value whether the statement was applied.

Throws:

DataAccessException - if there is any problem executing the query.

query

public <T> ListenableFuture<T> query(com.datastax.driver.core.Statement statement,
                                     ResultSetExtractor<T> resultSetExtractor)
                              throws DataAccessException

Description copied from interface: AsyncCqlOperations

Execute a query given static CQL, reading the ResultSet with a ResultSetExtractor.

Uses a CQL Statement, not a PreparedStatement. If you want to execute a static query with a PreparedStatement, use the overloaded query method with null as argument array.

Specified by:

query in interface AsyncCqlOperations

Parameters:

statement - static CQL Statement, must not be null.

resultSetExtractor - object that will extract all rows of results, must not be null.

Returns:

an arbitrary result object, as returned by the ResultSetExtractor.

Throws:

DataAccessException - if there is any problem executing the query.

See Also:

AsyncCqlOperations.query(String, ResultSetExtractor, Object...)

query

public ListenableFuture<Void> query(com.datastax.driver.core.Statement statement,
                                    RowCallbackHandler rowCallbackHandler)
                             throws DataAccessException

Description copied from interface: AsyncCqlOperations

Execute a query given static CQL, reading the ResultSet on a per-row basis with a RowCallbackHandler.

Uses a CQL Statement, not a PreparedStatement. If you want to execute a static query with a PreparedStatement, use the overloaded query method with null as argument array.

Specified by:

query in interface AsyncCqlOperations

Parameters:

statement - static CQL Statement, must not be null.

rowCallbackHandler - object that will extract results, one row at a time, must not be null.

Throws:

DataAccessException - if there is any problem executing the query

See Also:

AsyncCqlOperations.query(String, RowCallbackHandler, Object[])

query

public <T> ListenableFuture<List<T>> query(com.datastax.driver.core.Statement statement,
                                           RowMapper<T> rowMapper)
                                    throws DataAccessException

Description copied from interface: AsyncCqlOperations

Execute a query given static CQL, mapping each row to a Java object via a RowMapper.

Uses a CQL Statement, not a PreparedStatement. If you want to execute a static query with a PreparedStatement, use the overloaded query method with null as argument array.

Specified by:

query in interface AsyncCqlOperations

Parameters:

statement - static CQL Statement, must not be null.

rowMapper - object that will map one object per row, must not be null.

Returns:

the result List, containing mapped objects.

Throws:

DataAccessException - if there is any problem executing the query

See Also:

AsyncCqlOperations.query(String, RowMapper, Object[])

queryForList

public ListenableFuture<List<Map<String,Object>>> queryForList(com.datastax.driver.core.Statement statement)
                                                        throws DataAccessException

Description copied from interface: AsyncCqlOperations

Execute a query for a result List, given static CQL.

Uses a CQL Statement, not a PreparedStatement. If you want to execute a static query with a PreparedStatement, use the overloaded queryForList method with null as argument array.

The results will be mapped to a List (one item for each row) of Maps (one entry for each column using the column name as the key). Each item in the List will be of the form returned by this interface's queryForMap() methods.

Specified by:

queryForList in interface AsyncCqlOperations

Parameters:

statement - static CQL Statement to execute, must not be empty or null.

Returns:

a List that contains a Map per row.

Throws:

DataAccessException - if there is any problem executing the query.

See Also:

AsyncCqlOperations.queryForList(String, Object[])

queryForList

public <T> ListenableFuture<List<T>> queryForList(com.datastax.driver.core.Statement statement,
                                                  Class<T> elementType)
                                           throws DataAccessException

Description copied from interface: AsyncCqlOperations

Execute a query for a result List, given static CQL.

Uses a CQL Statement, not a PreparedStatement. If you want to execute a static query with a PreparedStatement, use the overloaded queryForList method with null as argument array.

The results will be mapped to a List (one item for each row) of result objects, each of them matching the specified element type.

Specified by:

queryForList in interface AsyncCqlOperations

Parameters:

statement - static CQL Statement, must not be null.

elementType - the required type of element in the result List (for example, Integer.class), must not be null.

Returns:

a List of objects that match the specified element type.

Throws:

DataAccessException - if there is any problem executing the query.

See Also:

AsyncCqlOperations.queryForList(String, Class, Object[]), SingleColumnRowMapper

queryForMap

public ListenableFuture<Map<String,Object>> queryForMap(com.datastax.driver.core.Statement statement)
                                                 throws DataAccessException

Description copied from interface: AsyncCqlOperations

Execute a query for a result Map, given static CQL.

Uses a CQL Statement, not a PreparedStatement. If you want to execute a static query with a PreparedStatement, use the overloaded AsyncCqlOperations.queryForMap(String, Object...) method with null as argument array.

The query is expected to be a single row query; the result row will be mapped to a Map (one entry for each column, using the column name as the key).

Specified by:

queryForMap in interface AsyncCqlOperations

Parameters:

statement - static CQL Statement, must not be null.

Returns:

the result Map (one entry for each column, using the column name as the key), must not be null.

Throws:

IncorrectResultSizeDataAccessException - if the query does not return exactly one row.

DataAccessException - if there is any problem executing the query.

See Also:

AsyncCqlOperations.queryForMap(String, Object[]), ColumnMapRowMapper

queryForObject

public <T> ListenableFuture<T> queryForObject(com.datastax.driver.core.Statement statement,
                                              Class<T> requiredType)
                                       throws DataAccessException

Description copied from interface: AsyncCqlOperations

Execute a query for a result object, given static CQL.

Uses a CQL Statement, not a PreparedStatement. If you want to execute a static query with a PreparedStatement, use the overloaded AsyncCqlOperations.queryForObject(String, Class, Object...) method with null as argument array.

This method is useful for running static CQL with a known outcome. The query is expected to be a single row/single column query; the returned result will be directly mapped to the corresponding object type.

Specified by:

queryForObject in interface AsyncCqlOperations

Parameters:

statement - static CQL Statement, must not be null.

requiredType - the type that the result object is expected to match, must not be null.

Returns:

the result object of the required type, or Mono.empty() in case of CQL NULL.

Throws:

IncorrectResultSizeDataAccessException - if the query does not return exactly one row, or does not return exactly one column in that row.

DataAccessException - if there is any problem executing the query.

See Also:

AsyncCqlOperations.queryForObject(String, Class, Object[])

queryForObject

public <T> ListenableFuture<T> queryForObject(com.datastax.driver.core.Statement statement,
                                              RowMapper<T> rowMapper)
                                       throws DataAccessException

Description copied from interface: AsyncCqlOperations

Execute a query given static CQL, mapping a single result row to a Java object via a RowMapper.

Uses a CQL Statement, not a PreparedStatement. If you want to execute a static query with a PreparedStatement, use the overloaded AsyncCqlOperations.queryForObject(String, RowMapper, Object...) method with null as argument array.

Specified by:

queryForObject in interface AsyncCqlOperations

Parameters:

statement - static CQL Statement, must not be null.

rowMapper - object that will map one object per row, must not be null.

Returns:

the single mapped object.

Throws:

IncorrectResultSizeDataAccessException - if the query does not return exactly one row.

DataAccessException - if there is any problem executing the query.

See Also:

AsyncCqlOperations.queryForObject(String, RowMapper, Object[])

queryForResultSet

public ListenableFuture<com.datastax.driver.core.ResultSet> queryForResultSet(com.datastax.driver.core.Statement statement)
                                                                       throws DataAccessException

Description copied from interface: AsyncCqlOperations

Execute a query for a ResultSet, given static CQL.

Uses a CQL Statement, not a PreparedStatement. If you want to execute a static query with a PreparedStatement, use the overloaded queryForResultSet method with null as argument array.

The results will be mapped to an ResultSet.

Specified by:

queryForResultSet in interface AsyncCqlOperations

Parameters:

statement - static CQL Statement, must not be null.

Returns:

a ResultSet representation.

Throws:

DataAccessException - if there is any problem executing the query.

See Also:

AsyncCqlOperations.queryForResultSet(String, Object[])

execute

public ListenableFuture<Boolean> execute(AsyncPreparedStatementCreator preparedStatementCreator)
                                  throws DataAccessException

Description copied from interface: AsyncCqlOperations

Issue a single CQL execute operation (such as an insert, update or delete statement) using a AsyncPreparedStatementCreator to provide CQL and any required parameters.

Specified by:

execute in interface AsyncCqlOperations

Parameters:

preparedStatementCreator - object that provides CQL and any necessary parameters, must not be null.

Returns:

boolean value whether the statement was applied.

Throws:

DataAccessException - if there is any problem issuing the execution.

execute

public ListenableFuture<Boolean> execute(String cql,
                                         Object... args)
                                  throws DataAccessException

Description copied from interface: AsyncCqlOperations

Issue a single CQL operation (such as an insert, update or delete statement) via a prepared statement, binding the given arguments.

Specified by:

execute in interface AsyncCqlOperations

Parameters:

cql - static CQL to execute, must not be empty or null.

args - arguments to bind to the query (leaving it to the PreparedStatement to guess the corresponding CQL type).

Returns:

boolean value whether the statement was applied.

Throws:

DataAccessException - if there is any problem issuing the execution.

execute

public ListenableFuture<Boolean> execute(String cql,
                                         PreparedStatementBinder preparedStatementBinder)
                                  throws DataAccessException

Description copied from interface: AsyncCqlOperations

Issue an statement using a PreparedStatementBinder to set bind parameters, with given CQL. Simpler than using a AsyncPreparedStatementCreator as this method will create the PreparedStatement: The PreparedStatementBinder just needs to set parameters.

Specified by:

execute in interface AsyncCqlOperations

Parameters:

cql - static CQL to execute, must not be empty or null.

preparedStatementBinder - object that knows how to set values on the prepared statement. If this is null, the CQL will be assumed to contain no bind parameters. Even if there are no bind parameters, this object may be used to set fetch size and other performance options.

Returns:

boolean value whether the statement was applied.

Throws:

DataAccessException - if there is any problem issuing the execution.

execute

public <T> ListenableFuture<T> execute(String cql,
                                       PreparedStatementCallback<T> action)
                                throws DataAccessException

Description copied from interface: AsyncCqlOperations

Execute a CQL data access operation, implemented as callback action working on a CQL PreparedStatement. This allows for implementing arbitrary data access operations on a single Statement, within Spring's managed CQL environment: that is, participating in Spring-managed transactions and converting CQL DriverExceptions into Spring's DataAccessException hierarchy.

The callback action can return a result object, for example a domain object or a collection of domain objects.

Specified by:

execute in interface AsyncCqlOperations

Parameters:

cql - static CQL to execute, must not be empty or null.

action - callback object that specifies the action, must not be null.

Returns:

a result object returned by the action, or null

Throws:

DataAccessException - if there is any problem TODO: Lambda-usage clashes with execute(cql, PreparedStatementBinder)

execute

public <T> ListenableFuture<T> execute(AsyncPreparedStatementCreator preparedStatementCreator,
                                       PreparedStatementCallback<T> action)
                                throws DataAccessException

Description copied from interface: AsyncCqlOperations

Execute a CQL data access operation, implemented as callback action working on a CQL PreparedStatement. This allows for implementing arbitrary data access operations on a single PreparedStatement, within Spring's managed CQL environment: that is, participating in Spring-managed transactions and converting CQL DriverExceptions into Spring's DataAccessException hierarchy.

The callback action can return a result object, for example a domain object or a collection of domain objects.

Specified by:

execute in interface AsyncCqlOperations

Parameters:

preparedStatementCreator - object that can create a PreparedStatement given a Session, must not be null.

action - callback object that specifies the action, must not be null.

Returns:

a result object returned by the action, or null.

Throws:

DataAccessException - if there is any problem

query

public <T> ListenableFuture<T> query(AsyncPreparedStatementCreator preparedStatementCreator,
                                     ResultSetExtractor<T> resultSetExtractor)
                              throws DataAccessException

Description copied from interface: AsyncCqlOperations

Query using a prepared statement, reading the ResultSet with a ResultSetExtractor.

Specified by:

query in interface AsyncCqlOperations

Parameters:

preparedStatementCreator - object that can create a PreparedStatement given a Session, must not be null.

resultSetExtractor - object that will extract results, must not be null.

Returns:

an arbitrary result object, as returned by the ResultSetExtractor

Throws:

DataAccessException - if there is any problem

query

public ListenableFuture<Void> query(AsyncPreparedStatementCreator preparedStatementCreator,
                                    RowCallbackHandler rowCallbackHandler)
                             throws DataAccessException

Description copied from interface: AsyncCqlOperations

Query using a prepared statement, reading the ResultSet on a per-row basis with a RowCallbackHandler.

Specified by:

query in interface AsyncCqlOperations

Parameters:

preparedStatementCreator - object that can create a PreparedStatement given a Session, must not be null.

rowCallbackHandler - object that will extract results, one row at a time, must not be null.

Throws:

DataAccessException - if there is any problem executing the query.

query

public <T> ListenableFuture<List<T>> query(AsyncPreparedStatementCreator preparedStatementCreator,
                                           RowMapper<T> rowMapper)
                                    throws DataAccessException

Description copied from interface: AsyncCqlOperations

Query using a prepared statement, mapping each row to a Java object via a RowMapper.

Specified by:

query in interface AsyncCqlOperations

Parameters:

preparedStatementCreator - object that can create a PreparedStatement given a Session, must not be null.

rowMapper - object that will map one object per row, must not be null.

Returns:

the result List, containing mapped objects.

Throws:

DataAccessException - if there is any problem executing the query.

query

public <T> ListenableFuture<T> query(AsyncPreparedStatementCreator preparedStatementCreator,
                                     PreparedStatementBinder preparedStatementBinder,
                                     ResultSetExtractor<T> resultSetExtractor)
                              throws DataAccessException

Description copied from interface: AsyncCqlOperations

Query using a prepared statement and a PreparedStatementBinder implementation that knows how to bind values to the query, reading the ResultSet with a ResultSetExtractor.

Specified by:

query in interface AsyncCqlOperations

Parameters:

preparedStatementCreator - object that can create a PreparedStatement given a Session, must not be null.

preparedStatementBinder - object that knows how to set values on the prepared statement. If this is null, the CQL will be assumed to contain no bind parameters. Even if there are no bind parameters, this object may be used to set fetch size and other performance options.

resultSetExtractor - object that will extract results, must not be null.

Returns:

an arbitrary result object, as returned by the ResultSetExtractor.

Throws:

DataAccessException - if there is any problem

query

public ListenableFuture<Void> query(AsyncPreparedStatementCreator preparedStatementCreator,
                                    PreparedStatementBinder preparedStatementBinder,
                                    RowCallbackHandler rowCallbackHandler)
                             throws DataAccessException

Description copied from interface: AsyncCqlOperations

Query using a prepared statement and a PreparedStatementBinder implementation that knows how to bind values to the query, reading the ResultSet on a per-row basis with a RowCallbackHandler.

Specified by:

query in interface AsyncCqlOperations

Parameters:

preparedStatementCreator - object that can create a PreparedStatement given a Session, must not be null.

preparedStatementBinder - object that knows how to set values on the prepared statement. If this is null, the CQL will be assumed to contain no bind parameters. Even if there are no bind parameters, this object may be used to set fetch size and other performance options.

rowCallbackHandler - object that will extract results, one row at a time, must not be null.

Throws:

DataAccessException - if there is any problem executing the query.

query

public <T> ListenableFuture<List<T>> query(AsyncPreparedStatementCreator preparedStatementCreator,
                                           PreparedStatementBinder preparedStatementBinder,
                                           RowMapper<T> rowMapper)
                                    throws DataAccessException

Description copied from interface: AsyncCqlOperations

Query using a prepared statement and a PreparedStatementBinder implementation that knows how to bind values to the query, mapping each row to a Java object via a RowMapper.

Specified by:

query in interface AsyncCqlOperations

Parameters:

preparedStatementCreator - object that can create a PreparedStatement given a Session, must not be null.

preparedStatementBinder - object that knows how to set values on the prepared statement. If this is null, the CQL will be assumed to contain no bind parameters. Even if there are no bind parameters, this object may be used to set fetch size and other performance options.

rowMapper - object that will map one object per row, must not be null.

Returns:

the result List, containing mapped objects.

Throws:

DataAccessException - if there is any problem executing the query.

query

public <T> ListenableFuture<T> query(String cql,
                                     ResultSetExtractor<T> resultSetExtractor,
                                     Object... args)
                              throws DataAccessException

Description copied from interface: AsyncCqlOperations

Query given CQL to create a prepared statement from CQL and a list of arguments to bind to the query, reading the ResultSet with a ResultSetExtractor.

Specified by:

query in interface AsyncCqlOperations

Parameters:

cql - static CQL to execute, must not be empty or null.

resultSetExtractor - object that will extract results, must not be null.

args - arguments to bind to the query (leaving it to the PreparedStatement to guess the corresponding CQL type).

Returns:

an arbitrary result object, as returned by the ResultSetExtractor

Throws:

DataAccessException - if there is any problem executing the query.

query

public ListenableFuture<Void> query(String cql,
                                    RowCallbackHandler rowCallbackHandler,
                                    Object... args)
                             throws DataAccessException

Description copied from interface: AsyncCqlOperations

Query given CQL to create a prepared statement from CQL and a list of arguments to bind to the query, reading the ResultSet on a per-row basis with a RowCallbackHandler.

Specified by:

query in interface AsyncCqlOperations

Parameters:

cql - static CQL to execute, must not be empty or null.

rowCallbackHandler - object that will extract results, one row at a time, must not be null.

args - arguments to bind to the query (leaving it to the PreparedStatement to guess the corresponding CQL type)

Throws:

DataAccessException - if there is any problem executing the query.

query

public <T> ListenableFuture<List<T>> query(String cql,
                                           RowMapper<T> rowMapper,
                                           Object... args)
                                    throws DataAccessException

Description copied from interface: AsyncCqlOperations

Query given CQL to create a prepared statement from CQL and a list of arguments to bind to the query, mapping each row to a Java object via a RowMapper.

Specified by:

query in interface AsyncCqlOperations

Parameters:

cql - static CQL to execute, must not be empty or null.

rowMapper - object that will map one object per row

args - arguments to bind to the query (leaving it to the PreparedStatement to guess the corresponding CQL type)

Returns:

the result List, containing mapped objects

Throws:

DataAccessException - if there is any problem executing the query.

query

public <T> ListenableFuture<T> query(String cql,
                                     PreparedStatementBinder preparedStatementBinder,
                                     ResultSetExtractor<T> resultSetExtractor)
                              throws DataAccessException

Description copied from interface: AsyncCqlOperations

Query using a prepared statement, reading the ResultSet with a ResultSetExtractor.

Specified by:

query in interface AsyncCqlOperations

Parameters:

cql - static CQL to execute, must not be empty or null.

preparedStatementBinder - object that knows how to set values on the prepared statement. If this is null, the CQL will be assumed to contain no bind parameters. Even if there are no bind parameters, this object may be used to set fetch size and other performance options.

resultSetExtractor - object that will extract results, must not be null.

Returns:

an arbitrary result object, as returned by the ResultSetExtractor.

Throws:

DataAccessException - if there is any problem

query

public ListenableFuture<Void> query(String cql,
                                    PreparedStatementBinder preparedStatementBinder,
                                    RowCallbackHandler rowCallbackHandler)
                             throws DataAccessException

Description copied from interface: AsyncCqlOperations

Query given CQL to create a prepared statement from CQL and a PreparedStatementBinder implementation that knows how to bind values to the query, reading the ResultSet on a per-row basis with a RowCallbackHandler.

Specified by:

query in interface AsyncCqlOperations

Parameters:

cql - static CQL to execute, must not be empty or null.

preparedStatementBinder - object that knows how to set values on the prepared statement. If this is null, the CQL will be assumed to contain no bind parameters. Even if there are no bind parameters, this object may be used to set fetch size and other performance options.

rowCallbackHandler - object that will extract results, one row at a time, must not be null.

Throws:

DataAccessException - if there is any problem executing the query.

query

public <T> ListenableFuture<List<T>> query(String cql,
                                           PreparedStatementBinder preparedStatementBinder,
                                           RowMapper<T> rowMapper)
                                    throws DataAccessException

Description copied from interface: AsyncCqlOperations

Query given CQL to create a prepared statement from CQL and a PreparedStatementBinder implementation that knows how to bind values to the query, mapping each row to a Java object via a RowMapper.

Specified by:

query in interface AsyncCqlOperations

Parameters:

cql - static CQL to execute, must not be empty or null.

preparedStatementBinder - object that knows how to set values on the prepared statement. If this is null, the CQL will be assumed to contain no bind parameters. Even if there are no bind parameters, this object may be used to set fetch size and other performance options.

rowMapper - object that will map one object per row, must not be null.

Returns:

the result List, containing mapped objects.

Throws:

DataAccessException - if there is any problem executing the query.

queryForList

public ListenableFuture<List<Map<String,Object>>> queryForList(String cql,
                                                               Object... args)
                                                        throws DataAccessException

Description copied from interface: AsyncCqlOperations

Query given CQL to create a prepared statement from CQL and a list of arguments to bind to the query, expecting a result List.

The results will be mapped to a List (one item for each row) of Maps (one entry for each column, using the column name as the key). Each item in the List will be of the form returned by this interface's queryForMap() methods.

Specified by:

queryForList in interface AsyncCqlOperations

Parameters:

cql - static CQL to execute, must not be empty or null.

args - arguments to bind to the query (leaving it to the PreparedStatement to guess the corresponding CQL type).

Returns:

a List that contains a Map per row

Throws:

DataAccessException - if there is any problem executing the query.

See Also:

AsyncCqlOperations.queryForList(String)

queryForList

public <T> ListenableFuture<List<T>> queryForList(String cql,
                                                  Class<T> elementType,
                                                  Object... args)
                                           throws DataAccessException

Description copied from interface: AsyncCqlOperations

Query given CQL to create a prepared statement from CQL and a list of arguments to bind to the query, expecting a result List.

The results will be mapped to a List (one item for each row) of result objects, each of them matching the specified element type.

Specified by:

queryForList in interface AsyncCqlOperations

Parameters:

cql - static CQL to execute, must not be empty or null.

elementType - the required type of element in the result List (for example, Integer.class), must not be null.

args - arguments to bind to the query (leaving it to the PreparedStatement to guess the corresponding CQL type).

Returns:

a List of objects that match the specified element type.

Throws:

DataAccessException - if there is any problem executing the query.

See Also:

AsyncCqlOperations.queryForList(String, Class), SingleColumnRowMapper

queryForMap

public ListenableFuture<Map<String,Object>> queryForMap(String cql,
                                                        Object... args)
                                                 throws DataAccessException

Description copied from interface: AsyncCqlOperations

Query given CQL to create a prepared statement from CQL and a list of arguments to bind to the query, expecting a result Map. The queryForMap() methods defined by this interface are appropriate when you don't have a domain model. Otherwise, consider using one of the queryForObject() methods.

The query is expected to be a single row query; the result row will be mapped to a Map (one entry for each column, using the column name as the key).

Specified by:

queryForMap in interface AsyncCqlOperations

Parameters:

cql - static CQL to execute, must not be empty or null.

args - arguments to bind to the query (leaving it to the PreparedStatement to guess the corresponding CQL type).

Returns:

the result Map (one entry for each column, using the column name as the key).

Throws:

IncorrectResultSizeDataAccessException - if the query does not return exactly one row

DataAccessException - if there is any problem executing the query.

See Also:

AsyncCqlOperations.queryForMap(String), ColumnMapRowMapper

queryForObject

public <T> ListenableFuture<T> queryForObject(String cql,
                                              Class<T> requiredType,
                                              Object... args)
                                       throws DataAccessException

Description copied from interface: AsyncCqlOperations

Query given CQL to create a prepared statement from CQL and a list of arguments to bind to the query, expecting a result object.

The query is expected to be a single row/single column query; the returned result will be directly mapped to the corresponding object type.

Specified by:

queryForObject in interface AsyncCqlOperations

Parameters:

cql - static CQL to execute, must not be empty or null.

requiredType - the type that the result object is expected to match, must not be null.

args - arguments to bind to the query (leaving it to the PreparedStatement to guess the corresponding CQL type)

Returns:

the result object of the required type, or Mono.empty() in case of CQL NULL.

Throws:

IncorrectResultSizeDataAccessException - if the query does not return exactly one row, or does not return exactly one column in that row.

DataAccessException - if there is any problem executing the query.

See Also:

AsyncCqlOperations.queryForObject(String, Class)

queryForObject

public <T> ListenableFuture<T> queryForObject(String cql,
                                              RowMapper<T> rowMapper,
                                              Object... args)
                                       throws DataAccessException

Description copied from interface: AsyncCqlOperations

Query given CQL to create a prepared statement from CQL and a list of arguments to bind to the query, mapping a single result row to a Java object via a RowMapper.

Specified by:

queryForObject in interface AsyncCqlOperations

Parameters:

cql - static CQL to execute, must not be empty or null.

rowMapper - object that will map one object per row, must not be null.

args - arguments to bind to the query (leaving it to the PreparedStatement to guess the corresponding CQL type)

Returns:

the single mapped object

Throws:

IncorrectResultSizeDataAccessException - if the query does not return exactly one row.

DataAccessException - if there is any problem executing the query.

queryForResultSet

public ListenableFuture<com.datastax.driver.core.ResultSet> queryForResultSet(String cql,
                                                                              Object... args)
                                                                       throws DataAccessException

Description copied from interface: AsyncCqlOperations

Query given CQL to create a prepared statement from CQL and a list of arguments to bind to the query, expecting a ResultSet.

The results will be mapped to an ResultSet.

Specified by:

queryForResultSet in interface AsyncCqlOperations

Parameters:

cql - static CQL to execute, must not be empty or null.

args - arguments to bind to the query (leaving it to the PreparedStatement to guess the corresponding CQL type).

Returns:

a ResultSet representation.

Throws:

DataAccessException - if there is any problem executing the query.

See Also:

AsyncCqlOperations.queryForResultSet(String)

newAsyncPreparedStatementCreator

protected AsyncPreparedStatementCreator newAsyncPreparedStatementCreator(String cql)

Create a new CQL-based AsyncPreparedStatementCreator using the CQL passed in. By default, we'll create an SimpleAsyncPreparedStatementCreator. This method allows for the creation to be overridden by subclasses.

Parameters:

cql - static CQL to execute, must not be empty or null.

Returns:

the new AsyncPreparedStatementCreator to use

translateException

protected DataAccessException translateException(String task,
                                                 String cql,
                                                 com.datastax.driver.core.exceptions.DriverException ex)

Translate the given DriverException into a generic DataAccessException.

Parameters:

task - readable text describing the task being attempted

cql - CQL query or update that caused the problem (may be null)

ex - the offending RuntimeException.

Returns:

the exception translation Function

See Also:

CqlProvider

translateExceptionIfPossible

protected DataAccessException translateExceptionIfPossible(String task,
                                                           String cql,
                                                           RuntimeException ex)

Translate the given DriverException into a generic DataAccessException.

Parameters:

task - readable text describing the task being attempted

cql - CQL query or update that caused the problem (may be null)

ex - the offending RuntimeException.

Returns:

the translated DataAccessException or null if translation not possible.

See Also:

CqlProvider