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

Interface CqlOperations

All Known Implementing Classes:
CqlTemplate
public interface CqlOperations
Interface specifying a basic set of CQL operations. Implemented by CqlTemplate. Not often used directly, but a useful option to enhance testability, as it can easily be mocked or stubbed.
Since:
2.0
Author:
Mark Paluch, John Blum
See Also:

  • Method Details

    • execute

      @Nullable <T> T execute(SessionCallback<T> action) throws DataAccessException
      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.

      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

      boolean execute(String cql) throws DataAccessException
      Issue a single CQL execute, typically a DDL statement, insert, update or delete statement.
      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.

    • execute

      boolean execute(String cql, Object... args) throws DataAccessException
      Issue a single CQL operation (such as an insert, update or delete statement) via a prepared statement, binding the given arguments.
      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 executing the query.

    • execute

      boolean execute(String cql, @Nullable PreparedStatementBinder psb) throws DataAccessException
      Issue an statement using a PreparedStatementBinder to set bind parameters, with given CQL. Simpler than using a PreparedStatementCreator as this method will create the PreparedStatement: The PreparedStatementBinder just needs to set parameters.
      Parameters:
      cql - static CQL to execute, must not be empty or 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.
      Returns:
      boolean value whether the statement was applied.
      Throws:
      DataAccessException - if there is any problem executing the query.

    • execute

      @Nullable <T> T execute(String cql, PreparedStatementCallback<T> action) throws DataAccessException
      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.

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

    • query

      @Nullable <T> T query(String cql, ResultSetExtractor<T> resultSetExtractor) throws DataAccessException
      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.

      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:

    • query

      void query(String cql, RowCallbackHandler rowCallbackHandler) throws DataAccessException
      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.

      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:

    • query

      <T> List<T> query(String cql, RowMapper<T> rowMapper) throws DataAccessException
      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.

      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:

    • query

      @Nullable <T> T query(String cql, ResultSetExtractor<T> resultSetExtractor, Object... args) throws DataAccessException
      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.
      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

      void query(String cql, RowCallbackHandler rowCallbackHandler, Object... args) throws DataAccessException
      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.
      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

      <T> List<T> query(String cql, RowMapper<T> rowMapper, Object... args) throws DataAccessException
      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.
      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.

    • queryForStream

      <T> Stream<T> queryForStream(String cql, RowMapper<T> rowMapper, Object... args) throws DataAccessException
      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 and turning it into an iterable Stream.
      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 Stream, containing mapped objects
      Throws:
      DataAccessException - if there is any problem executing the query.
      Since:
      3.1

    • query

      @Nullable <T> T query(String cql, @Nullable PreparedStatementBinder psb, ResultSetExtractor<T> resultSetExtractor) throws DataAccessException
      Query using a prepared statement, reading the ResultSet with a ResultSetExtractor.
      Parameters:
      cql - static CQL to execute, must not be empty or 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 ResultSetExtractor.
      Throws:
      DataAccessException - if there is any problem executing the query.

    • query

      void query(String cql, @Nullable PreparedStatementBinder psb, RowCallbackHandler rowCallbackHandler) throws DataAccessException
      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.
      Parameters:
      cql - static CQL to execute, must not be empty or 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

      <T> List<T> query(String cql, @Nullable PreparedStatementBinder psb, RowMapper<T> rowMapper) throws DataAccessException
      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.
      Parameters:
      cql - static CQL to execute, must not be empty or 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.

    • queryForList

      List<Map<String,Object>> queryForList(String cql) throws DataAccessException
      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.

      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:

    • queryForList

      List<Map<String,Object>> queryForList(String cql, Object... args) throws DataAccessException
      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.

      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:

    • queryForList

      <T> List<T> queryForList(String cql, Class<T> elementType) throws DataAccessException
      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.

      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:

    • queryForList

      <T> List<T> queryForList(String cql, Class<T> elementType, Object... args) throws DataAccessException
      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.

      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:

    • queryForMap

      Map<String,Object> queryForMap(String cql) throws DataAccessException
      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 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).

      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:

    • queryForMap

      Map<String,Object> queryForMap(String cql, Object... args) throws DataAccessException
      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).

      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:

    • queryForObject

      <T> T queryForObject(String cql, Class<T> requiredType) throws DataAccessException
      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 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.

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

      <T> T queryForObject(String cql, Class<T> requiredType, Object... args) throws DataAccessException
      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.

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

      <T> T queryForObject(String cql, RowMapper<T> rowMapper) throws DataAccessException
      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 queryForObject(String, RowMapper, Object...) method with null as argument array.

      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:

    • queryForObject

      <T> T queryForObject(String cql, RowMapper<T> rowMapper, Object... args) throws DataAccessException
      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.
      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

      com.datastax.oss.driver.api.core.cql.ResultSet queryForResultSet(String cql) throws DataAccessException
      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.

      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:

    • queryForResultSet

      com.datastax.oss.driver.api.core.cql.ResultSet queryForResultSet(String cql, Object... args) throws DataAccessException
      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.

      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:

    • queryForRows

      Iterable<com.datastax.oss.driver.api.core.cql.Row> queryForRows(String cql) throws DataAccessException
      Execute a query for Rows, 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 Rows.

      Parameters:
      cql - static CQL to execute, must not be empty or null.
      Returns:
      a Row representation.
      Throws:
      DataAccessException - if there is any problem executing the query.
      See Also:

    • queryForRows

      Iterable<com.datastax.oss.driver.api.core.cql.Row> queryForRows(String cql, Object... args) throws DataAccessException
      Query given CQL to create a prepared statement from CQL and a list of arguments to bind to the query, expecting Rows.

      The results will be mapped to Rows.

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

    • execute

      boolean execute(com.datastax.oss.driver.api.core.cql.Statement<?> statement) throws DataAccessException
      Issue a single CQL execute, typically a DDL statement, insert, update or delete statement.
      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

      @Nullable <T> T query(com.datastax.oss.driver.api.core.cql.Statement<?> statement, ResultSetExtractor<T> resultSetExtractor) throws DataAccessException
      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.

      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:

    • query

      void query(com.datastax.oss.driver.api.core.cql.Statement<?> statement, RowCallbackHandler rowCallbackHandler) throws DataAccessException
      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.

      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

      <T> List<T> query(com.datastax.oss.driver.api.core.cql.Statement<?> statement, RowMapper<T> rowMapper) throws DataAccessException
      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.

      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:

    • queryForStream

      <T> Stream<T> queryForStream(com.datastax.oss.driver.api.core.cql.Statement<?> statement, RowMapper<T> rowMapper) throws DataAccessException
      Execute a query given static CQL, mapping each row to a Java object via a RowMapper and turning it into an iterable Stream.

      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.

      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 Stream, containing mapped objects.
      Throws:
      DataAccessException - if there is any problem executing the query.
      Since:
      3.1
      See Also:

    • queryForList

      List<Map<String,Object>> queryForList(com.datastax.oss.driver.api.core.cql.Statement<?> statement) throws DataAccessException
      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.

      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:

    • queryForList

      <T> List<T> queryForList(com.datastax.oss.driver.api.core.cql.Statement<?> statement, Class<T> elementType) throws DataAccessException
      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.

      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

      Map<String,Object> queryForMap(com.datastax.oss.driver.api.core.cql.Statement<?> statement) throws DataAccessException
      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 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).

      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

      <T> T queryForObject(com.datastax.oss.driver.api.core.cql.Statement<?> statement, Class<T> requiredType) throws DataAccessException
      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 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.

      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

      <T> T queryForObject(com.datastax.oss.driver.api.core.cql.Statement<?> statement, RowMapper<T> rowMapper) throws DataAccessException
      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 queryForObject(String, RowMapper, Object...) method with null as argument array.

      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

      com.datastax.oss.driver.api.core.cql.ResultSet queryForResultSet(com.datastax.oss.driver.api.core.cql.Statement<?> statement) throws DataAccessException
      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.

      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:

    • queryForRows

      Iterable<com.datastax.oss.driver.api.core.cql.Row> queryForRows(com.datastax.oss.driver.api.core.cql.Statement<?> statement) throws DataAccessException
      Execute a query for Rows, 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 Rows.

      Parameters:
      statement - static CQL Statement, must not be null.
      Returns:
      a Row representation.
      Throws:
      DataAccessException - if there is any problem executing the query.
      See Also:

    • execute

      boolean execute(PreparedStatementCreator psc) throws DataAccessException
      Issue a single CQL execute operation (such as an insert, update or delete statement) using a PreparedStatementCreator to provide CQL and any required parameters.
      Parameters:
      psc - 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

      @Nullable <T> T execute(PreparedStatementCreator preparedStatementCreator, PreparedStatementCallback<T> action) throws DataAccessException
      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.

      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

      @Nullable <T> T query(PreparedStatementCreator preparedStatementCreator, ResultSetExtractor<T> resultSetExtractor) throws DataAccessException
      Query using a prepared statement, reading the ResultSet with a ResultSetExtractor.
      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 ResultSetExtractor
      Throws:
      DataAccessException - if there is any problem executing the query.

    • query

      void query(PreparedStatementCreator preparedStatementCreator, RowCallbackHandler rowCallbackHandler) throws DataAccessException
      Query using a prepared statement, reading the ResultSet on a per-row basis with a RowCallbackHandler.
      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

      <T> List<T> query(PreparedStatementCreator preparedStatementCreator, RowMapper<T> rowMapper) throws DataAccessException
      Query using a prepared statement, mapping each row to a Java object via a RowMapper.
      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.

    • queryForStream

      <T> Stream<T> queryForStream(PreparedStatementCreator preparedStatementCreator, RowMapper<T> rowMapper) throws DataAccessException
      Query using a prepared statement, mapping each row to a Java object via a RowMapper and turning it into an iterable Stream.
      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 Stream, containing mapped objects.
      Throws:
      DataAccessException - if there is any problem executing the query.
      Since:
      3.1

    • query

      @Nullable <T> T query(PreparedStatementCreator preparedStatementCreator, @Nullable PreparedStatementBinder psb, ResultSetExtractor<T> resultSetExtractor) throws DataAccessException
      Query using a prepared statement and a PreparedStatementBinder implementation that knows how to bind values to the query, reading the ResultSet with a ResultSetExtractor.
      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 ResultSetExtractor.
      Throws:
      DataAccessException - if there is any problem executing the query.

    • query

      void query(PreparedStatementCreator preparedStatementCreator, @Nullable PreparedStatementBinder psb, RowCallbackHandler rowCallbackHandler) throws DataAccessException
      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.
      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

      <T> List<T> query(PreparedStatementCreator preparedStatementCreator, @Nullable PreparedStatementBinder psb, RowMapper<T> rowMapper) throws DataAccessException
      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.
      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.

    • queryForStream

      <T> Stream<T> queryForStream(PreparedStatementCreator preparedStatementCreator, @Nullable PreparedStatementBinder psb, RowMapper<T> rowMapper) throws DataAccessException
      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 and turning it into an iterable Stream.
      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 Stream, containing mapped objects.
      Throws:
      DataAccessException - if there is any problem executing the query.
      Since:
      3.1

    • describeRing

      List<RingMember> describeRing() throws DataAccessException
      Describe the current Ring. This uses the provided RingMemberHostMapper to provide the basics of the Cassandra Ring topology.
      Returns:
      The list of ring tokens that are active in the cluster
      Throws:
      DataAccessException - if there is any problem executing the query.

    • describeRing

      <T> Collection<T> describeRing(HostMapper<T> hostMapper) throws DataAccessException
      Describe the current Ring. Application code must provide its own HostMapper implementation to process the lists of hosts returned by the Cassandra Cluster Metadata.
      Parameters:
      hostMapper - The implementation to use for host mapping.
      Returns:
      Collection generated by the provided HostMapper.
      Throws:
      DataAccessException - if there is any problem executing the query.