Package org.springframework.data.cassandra.core.cql.legacy

Class AsyncCqlTemplate

java.lang.Object
org.springframework.data.cassandra.core.cql.CassandraAccessor
org.springframework.data.cassandra.core.cql.legacy.AsyncCqlTemplate
All Implemented Interfaces:
InitializingBean, AsyncCqlOperations
@Deprecated(since="4.0", forRemoval=true) public class AsyncCqlTemplate extends CassandraAccessor implements AsyncCqlOperations
Deprecated, for removal: This API element is subject to removal in a future version.
since 4.0, use the CompletableFuture-based variant AsyncCqlTemplate.
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 AsyncResultSetExtractor 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 CqlSession reference, or get prepared in an application context and given to services as bean reference. Note: The CqlSession 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.cassandra.core.cqlTemplate" as log category.

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

Since:
4.0
Author:
Mark Paluch, John Blum
See Also:

  • Constructor Details

    • AsyncCqlTemplate

      public AsyncCqlTemplate()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create a new, uninitialized AsyncCqlTemplate. Note: The SessionFactory has to be set before using the instance.
      See Also:

    • AsyncCqlTemplate

      public AsyncCqlTemplate(com.datastax.oss.driver.api.core.CqlSession session)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create a new AsyncCqlTemplate with the given CqlSession.
      Parameters:
      session - the active Cassandra CqlSession, must not be null.
      Throws:
      IllegalStateException - if CqlSession is null.

    • AsyncCqlTemplate

      public AsyncCqlTemplate(SessionFactory sessionFactory)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Constructs a new AsyncCqlTemplate with the given SessionFactory.
      Parameters:
      sessionFactory - the active Cassandra SessionFactory.
      Since:
      2.0
      See Also:

  • Method Details

    • execute

      public <T> ListenableFuture<T> execute(AsyncSessionCallback<T> action) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: AsyncCqlOperations
      Execute a CQL data access operation, implemented as callback action working on a CqlSession. 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
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 null or empty.
      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, AsyncResultSetExtractor<T> resultSetExtractor) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: AsyncCqlOperations
      Execute a query given static CQL, reading the ResultSet with a AsyncResultSetExtractor.

      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 null or empty.
      resultSetExtractor - object that will extract all rows of results, must not be null.
      Returns:
      an arbitrary result object, as returned by the AsyncResultSetExtractor.
      Throws:
      DataAccessException - if there is any problem executing the query.
      See Also:

    • query

      public ListenableFuture<Void> query(String cql, RowCallbackHandler rowCallbackHandler) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 null or empty.
      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:

    • query

      public <T> ListenableFuture<List<T>> query(String cql, RowMapper<T> rowMapper) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 null or empty.
      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:

    • queryForList

      public ListenableFuture<List<Map<String,Object>>> queryForList(String cql) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 null or empty.
      Returns:
      a List that contains a Map per row.
      Throws:
      DataAccessException - if there is any problem executing the query.
      See Also:

    • queryForList

      public <T> ListenableFuture<List<T>> queryForList(String cql, Class<T> elementType) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 null or empty.
      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:

    • queryForMap

      public ListenableFuture<Map<String,Object>> queryForMap(String cql) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 null or empty.
      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:

    • queryForObject

      public <T> ListenableFuture<T> queryForObject(String cql, Class<T> requiredType) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 null or empty.
      requiredType - the type that the result object is expected to match, must not be null.
      Returns:
      the result object of the required type, or null 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:

    • queryForObject

      public <T> ListenableFuture<T> queryForObject(String cql, RowMapper<T> rowMapper) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 null or empty.
      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:

    • queryForResultSet

      public ListenableFuture<com.datastax.oss.driver.api.core.cql.AsyncResultSet> queryForResultSet(String cql) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 null or empty.
      Returns:
      a ResultSet representation.
      Throws:
      DataAccessException - if there is any problem executing the query.
      See Also:

    • execute

      public ListenableFuture<Boolean> execute(com.datastax.oss.driver.api.core.cql.Statement<?> statement) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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.oss.driver.api.core.cql.Statement<?> statement, AsyncResultSetExtractor<T> resultSetExtractor) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: AsyncCqlOperations
      Execute a query given static CQL, reading the ResultSet with a AsyncResultSetExtractor.

      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 AsyncResultSetExtractor.
      Throws:
      DataAccessException - if there is any problem executing the query.
      See Also:

    • query

      public ListenableFuture<Void> query(com.datastax.oss.driver.api.core.cql.Statement<?> statement, RowCallbackHandler rowCallbackHandler) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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:

    • query

      public <T> ListenableFuture<List<T>> query(com.datastax.oss.driver.api.core.cql.Statement<?> statement, RowMapper<T> rowMapper) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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:

    • queryForList

      public ListenableFuture<List<Map<String,Object>>> queryForList(com.datastax.oss.driver.api.core.cql.Statement<?> statement) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 null or empty.
      Returns:
      a List that contains a Map per row.
      Throws:
      DataAccessException - if there is any problem executing the query.
      See Also:

    • queryForList

      public <T> ListenableFuture<List<T>> queryForList(com.datastax.oss.driver.api.core.cql.Statement<?> statement, Class<T> elementType) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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:

    • queryForMap

      public ListenableFuture<Map<String,Object>> queryForMap(com.datastax.oss.driver.api.core.cql.Statement<?> statement) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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:

    • queryForObject

      public <T> ListenableFuture<T> queryForObject(com.datastax.oss.driver.api.core.cql.Statement<?> statement, Class<T> requiredType) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 null 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:

    • queryForObject

      public <T> ListenableFuture<T> queryForObject(com.datastax.oss.driver.api.core.cql.Statement<?> statement, RowMapper<T> rowMapper) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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:

    • queryForResultSet

      public ListenableFuture<com.datastax.oss.driver.api.core.cql.AsyncResultSet> queryForResultSet(com.datastax.oss.driver.api.core.cql.Statement<?> statement) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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:

    • execute

      public ListenableFuture<Boolean> execute(AsyncPreparedStatementCreator preparedStatementCreator) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 executing the query.

    • execute

      public ListenableFuture<Boolean> execute(String cql, Object... args) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 null or empty.
      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 executing the query.

    • execute

      public ListenableFuture<Boolean> execute(String cql, @Nullable PreparedStatementBinder psb) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 null or empty.
      psb - 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 executing the query.

    • execute

      public <T> ListenableFuture<T> execute(String cql, PreparedStatementCallback<T> action) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 null or empty.
      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 executing the query.

    • execute

      public <T> ListenableFuture<T> execute(AsyncPreparedStatementCreator preparedStatementCreator, PreparedStatementCallback<T> action) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 CqlSession, 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 executing the query.

    • query

      public <T> ListenableFuture<T> query(AsyncPreparedStatementCreator preparedStatementCreator, AsyncResultSetExtractor<T> resultSetExtractor) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: AsyncCqlOperations
      Query using a prepared statement, reading the ResultSet with a AsyncResultSetExtractor.
      Specified by:
      query in interface AsyncCqlOperations
      Parameters:
      preparedStatementCreator - object that can create a PreparedStatement given a CqlSession, must not be null.
      resultSetExtractor - object that will extract results, must not be null.
      Returns:
      an arbitrary result object, as returned by the AsyncResultSetExtractor
      Throws:
      DataAccessException - if there is any problem executing the query.

    • query

      public ListenableFuture<Void> query(AsyncPreparedStatementCreator preparedStatementCreator, RowCallbackHandler rowCallbackHandler) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 CqlSession, 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
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 CqlSession, 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, @Nullable PreparedStatementBinder psb, AsyncResultSetExtractor<T> resultSetExtractor) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 AsyncResultSetExtractor.
      Specified by:
      query in interface AsyncCqlOperations
      Parameters:
      preparedStatementCreator - object that can create a PreparedStatement given a CqlSession, must not be null.
      psb - 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 AsyncResultSetExtractor.
      Throws:
      DataAccessException - if there is any problem executing the query.

    • query

      public ListenableFuture<Void> query(AsyncPreparedStatementCreator preparedStatementCreator, @Nullable PreparedStatementBinder psb, RowCallbackHandler rowCallbackHandler) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 CqlSession, must not be null.
      psb - 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, @Nullable PreparedStatementBinder psb, RowMapper<T> rowMapper) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 CqlSession, must not be null.
      psb - 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, AsyncResultSetExtractor<T> resultSetExtractor, Object... args) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 AsyncResultSetExtractor.
      Specified by:
      query in interface AsyncCqlOperations
      Parameters:
      cql - static CQL to execute, must not be null or empty.
      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 AsyncResultSetExtractor
      Throws:
      DataAccessException - if there is any problem executing the query.

    • query

      public ListenableFuture<Void> query(String cql, RowCallbackHandler rowCallbackHandler, Object... args) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 null or empty.
      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
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 null or empty.
      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, @Nullable PreparedStatementBinder psb, AsyncResultSetExtractor<T> resultSetExtractor) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: AsyncCqlOperations
      Query using a prepared statement, reading the ResultSet with a AsyncResultSetExtractor.
      Specified by:
      query in interface AsyncCqlOperations
      Parameters:
      cql - static CQL to execute, must not be null or empty.
      psb - 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 AsyncResultSetExtractor.
      Throws:
      DataAccessException - if there is any problem executing the query.

    • query

      public ListenableFuture<Void> query(String cql, @Nullable PreparedStatementBinder psb, RowCallbackHandler rowCallbackHandler) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 null or empty.
      psb - 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, @Nullable PreparedStatementBinder psb, RowMapper<T> rowMapper) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 null or empty.
      psb - 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
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 null or empty.
      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:

    • queryForList

      public <T> ListenableFuture<List<T>> queryForList(String cql, Class<T> elementType, Object... args) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 null or empty.
      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:

    • queryForMap

      public ListenableFuture<Map<String,Object>> queryForMap(String cql, Object... args) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 null or empty.
      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:

    • queryForObject

      public <T> ListenableFuture<T> queryForObject(String cql, Class<T> requiredType, Object... args) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 null or empty.
      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 null 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:

    • queryForObject

      public <T> ListenableFuture<T> queryForObject(String cql, RowMapper<T> rowMapper, Object... args) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 null or empty.
      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.oss.driver.api.core.cql.AsyncResultSet> queryForResultSet(String cql, Object... args) throws DataAccessException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 null or empty.
      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:

    • translateException

      protected DataAccessException translateException(String task, @Nullable String cql, com.datastax.oss.driver.api.core.DriverException ex)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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:

    • translateExceptionIfPossible

      @Nullable protected DataAccessException translateExceptionIfPossible(String task, @Nullable String cql, RuntimeException ex)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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:

    • newAsyncPreparedStatementCreator

      protected AsyncPreparedStatementCreator newAsyncPreparedStatementCreator(String cql)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create a new CQL-based AsyncPreparedStatementCreator using the CQL passed in. By default, we'll create an AsyncCqlTemplate.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

    • newAsyncResultSetExtractor

      protected AsyncCqlTemplate.AsyncRowCallbackHandlerResultSetExtractor newAsyncResultSetExtractor(RowCallbackHandler rowCallbackHandler)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Constructs a new instance of the ResultSetExtractor adapting the given RowCallbackHandler.
      Parameters:
      rowCallbackHandler - RowCallbackHandler to adapt as a ResultSetExtractor.
      Returns:
      a ResultSetExtractor implementation adapting an instance of the RowCallbackHandler.
      See Also:

    • newAsyncResultSetExtractor

      protected <T> AsyncRowMapperResultSetExtractor<T> newAsyncResultSetExtractor(RowMapper<T> rowMapper)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Constructs a new instance of the ResultSetExtractor adapting the given RowMapper.
      Parameters:
      rowMapper - RowMapper to adapt as a ResultSetExtractor.
      Returns:
      a ResultSetExtractor implementation adapting an instance of the RowMapper.
      See Also: