ReactiveCassandraTemplate (Spring Data for Apache Cassandra Core 2.0.11.RELEASE API)

java.lang.Object
- org.springframework.data.cassandra.core.ReactiveCassandraTemplate

All Implemented Interfaces:

ReactiveCassandraOperations
```
public class ReactiveCassandraTemplate
extends Object
implements ReactiveCassandraOperations
```
Primary implementation of ReactiveCassandraOperations. It simplifies the use of Reactive Cassandra usage and helps to avoid common errors. It executes core Cassandra workflow. This class executes CQL queries or updates, initiating iteration over ReactiveResultSet and catching Cassandra exceptions and translating them to the generic, more informative exception hierarchy defined in the org.springframework.dao package.
Can be used within a service implementation via direct instantiation with a ReactiveSessionFactory reference, or get prepared in an application context and given to services as bean reference.
Note: The ReactiveSessionFactory should always be configured as a bean in the application context, in the first case given to the service directly, in the second case to the prepared template.

Since:

2.0

Author:

Mark Paluch, John Blum

Constructor Summary

Constructors
Constructor and Description
`ReactiveCassandraTemplate(ReactiveCqlOperations reactiveCqlOperations, CassandraConverter converter)` Create an instance of `ReactiveCassandraTemplate` initialized with the given `ReactiveCqlOperations` and `CassandraConverter`.
`ReactiveCassandraTemplate(ReactiveSession session)` Creates an instance of `ReactiveCassandraTemplate` initialized with the given `ReactiveSession` and a default `MappingCassandraConverter`.
`ReactiveCassandraTemplate(ReactiveSession session, CassandraConverter converter)` Create an instance of `CassandraTemplate` initialized with the given `ReactiveSession` and `CassandraConverter`.
`ReactiveCassandraTemplate(ReactiveSessionFactory sessionFactory, CassandraConverter converter)` Create an instance of `ReactiveCassandraTemplate` initialized with the given `ReactiveSessionFactory` and `CassandraConverter`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`reactor.core.publisher.Mono<Long>`	`count(Class<?> entityClass)` Returns the number of rows for the given entity class.
`reactor.core.publisher.Mono<WriteResult>`	`delete(Object entity, QueryOptions options)` Delete the given entity applying `QueryOptions` and emit the entity if the delete was applied.
`reactor.core.publisher.Mono<Boolean>`	`delete(Query query, Class<?> entityClass)` Remove entities (rows)/columns from the table by `Query`.
`<T> reactor.core.publisher.Mono<T>`	`delete(T entity)` Delete the given entity and emit the entity if the delete was applied.
`reactor.core.publisher.Mono<Boolean>`	`deleteById(Object id, Class<?> entityClass)` Remove the given object from the table by id.
`reactor.core.publisher.Mono<Boolean>`	`exists(Object id, Class<?> entityClass)` Determine whether the row `entityClass` with the given `id` exists.
`CassandraConverter`	`getConverter()` Returns the underlying `CassandraConverter`.
`protected MappingContext<? extends CassandraPersistentEntity<?>,CassandraPersistentProperty>`	`getMappingContext()` Returns the `CassandraMappingContext` used by this template to access mapping meta-data used to store (map) objects to Cassandra tables.
`ReactiveCqlOperations`	`getReactiveCqlOperations()` Expose the underlying `ReactiveCqlOperations` to allow CQL operations.
`protected StatementFactory`	`getStatementFactory()` Returns the `StatementFactory` used by this template to construct and run Cassandra CQL statements.
`reactor.core.publisher.Mono<WriteResult>`	`insert(Object entity, InsertOptions options)` Insert the given entity applying `WriteOptions` and emit the entity if the insert was applied.
`<T> reactor.core.publisher.Mono<T>`	`insert(T entity)` Insert the given entity and emit the entity if the insert was applied.
`<T> reactor.core.publisher.Flux<T>`	`select(Query query, Class<T> entityClass)` Execute a `SELECT` query and convert the resulting items to a stream of entities.
`<T> reactor.core.publisher.Flux<T>`	`select(com.datastax.driver.core.Statement cql, Class<T> entityClass)` Execute a `SELECT` query and convert the resulting items to a stream of entities.
`<T> reactor.core.publisher.Flux<T>`	`select(String cql, Class<T> entityClass)` Execute a `SELECT` query and convert the resulting items to a stream of entities.
`<T> reactor.core.publisher.Mono<T>`	`selectOne(Query query, Class<T> entityClass)` Execute a `SELECT` query and convert the resulting item to an entity.
`<T> reactor.core.publisher.Mono<T>`	`selectOne(com.datastax.driver.core.Statement statement, Class<T> entityClass)` Execute a `SELECT` query and convert the resulting item to an entity.
`<T> reactor.core.publisher.Mono<T>`	`selectOne(String cql, Class<T> entityClass)` Execute a `SELECT` query and convert the resulting item to an entity.
`<T> reactor.core.publisher.Mono<T>`	`selectOneById(Object id, Class<T> entityClass)` Execute the Select by `id` for the given `entityClass`.
`reactor.core.publisher.Mono<Void>`	`truncate(Class<?> entityClass)` Execute a `TRUNCATE` query to remove all entities of a given class.
`reactor.core.publisher.Mono<WriteResult>`	`update(Object entity, UpdateOptions options)` Update the given entity applying `WriteOptions` and emit the entity if the update was applied.
`reactor.core.publisher.Mono<Boolean>`	`update(Query query, Update update, Class<?> entityClass)` Update the queried entities and return true if the update was applied.
`<T> reactor.core.publisher.Mono<T>`	`update(T entity)` Update the given entity and emit the entity if the update was applied.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ReactiveCassandraTemplate
```
public ReactiveCassandraTemplate(ReactiveSession session)
```
    Creates an instance of ReactiveCassandraTemplate initialized with the given ReactiveSession and a default MappingCassandraConverter.
    
    Parameters:
    
    session - ReactiveSession used to interact with Cassandra; must not be null.
    
    See Also:
    
    CassandraConverter, Session
  - ReactiveCassandraTemplate
```
public ReactiveCassandraTemplate(ReactiveSession session,
                                 CassandraConverter converter)
```
    Create an instance of CassandraTemplate initialized with the given ReactiveSession and CassandraConverter.
    
    Parameters:
    
    session - ReactiveSession used to interact with Cassandra; must not be null.
    
    converter - CassandraConverter used to convert between Java and Cassandra types; must not be null.
    
    See Also:
    
    CassandraConverter, Session
  - ReactiveCassandraTemplate
```
public ReactiveCassandraTemplate(ReactiveSessionFactory sessionFactory,
                                 CassandraConverter converter)
```
    Create an instance of ReactiveCassandraTemplate initialized with the given ReactiveSessionFactory and CassandraConverter.
    
    Parameters:
    
    sessionFactory - ReactiveSessionFactory used to interact with Cassandra; must not be null.
    
    converter - CassandraConverter used to convert between Java and Cassandra types; must not be null.
    
    See Also:
    
    CassandraConverter, Session
  - ReactiveCassandraTemplate
```
public ReactiveCassandraTemplate(ReactiveCqlOperations reactiveCqlOperations,
                                 CassandraConverter converter)
```
    Create an instance of ReactiveCassandraTemplate initialized with the given ReactiveCqlOperations and CassandraConverter.
    
    Parameters:
    
    reactiveCqlOperations - ReactiveCqlOperations used to interact with Cassandra; must not be null.
    
    converter - CassandraConverter used to convert between Java and Cassandra types; must not be null.
    
    See Also:
    
    CassandraConverter, Session
- Method Detail
  - getConverter
```
public CassandraConverter getConverter()
```
    Description copied from interface: ReactiveCassandraOperations
    
    Returns the underlying CassandraConverter.
    
    Specified by:
    
    getConverter in interface ReactiveCassandraOperations
    
    Returns:
    
    the underlying CassandraConverter.
  - getMappingContext
```
protected MappingContext<? extends CassandraPersistentEntity<?>,CassandraPersistentProperty> getMappingContext()
```
    Returns the CassandraMappingContext used by this template to access mapping meta-data used to store (map) objects to Cassandra tables.
    
    Returns:
    
    the CassandraMappingContext used by this template.
    
    See Also:
    
    CassandraMappingContext
  - getReactiveCqlOperations
```
public ReactiveCqlOperations getReactiveCqlOperations()
```
    Description copied from interface: ReactiveCassandraOperations
    
    Expose the underlying ReactiveCqlOperations to allow CQL operations.
    
    Specified by:
    
    getReactiveCqlOperations in interface ReactiveCassandraOperations
    
    Returns:
    
    the underlying ReactiveCqlOperations.
    
    See Also:
    
    ReactiveCqlOperations
  - getStatementFactory
```
protected StatementFactory getStatementFactory()
```
    Returns the StatementFactory used by this template to construct and run Cassandra CQL statements.
    
    Returns:
    
    the StatementFactory used by this template to construct and run Cassandra CQL statements.
    
    See Also:
    
    StatementFactory
  - select
```
public <T> reactor.core.publisher.Flux<T> select(String cql,
                                                 Class<T> entityClass)
```
    Description copied from interface: ReactiveCassandraOperations
    
    Execute a SELECT query and convert the resulting items to a stream of entities.
    
    Specified by:
    
    select in interface ReactiveCassandraOperations
    
    Parameters:
    
    cql - must not be null.
    
    entityClass - The entity type must not be null.
    
    Returns:
    
    the converted results
  - selectOne
```
public <T> reactor.core.publisher.Mono<T> selectOne(String cql,
                                                    Class<T> entityClass)
```
    Description copied from interface: ReactiveCassandraOperations
    
    Execute a SELECT query and convert the resulting item to an entity.
    
    Specified by:
    
    selectOne in interface ReactiveCassandraOperations
    
    Parameters:
    
    cql - must not be null.
    
    entityClass - The entity type must not be null.
    
    Returns:
    
    the result object returned by the action or Mono.empty()
  - select
```
public <T> reactor.core.publisher.Flux<T> select(com.datastax.driver.core.Statement cql,
                                                 Class<T> entityClass)
```
    Description copied from interface: ReactiveCassandraOperations
    
    Execute a SELECT query and convert the resulting items to a stream of entities.
    
    Specified by:
    
    select in interface ReactiveCassandraOperations
    
    Parameters:
    
    cql - must not be null.
    
    entityClass - The entity type must not be null.
    
    Returns:
    
    the result objects returned by the action.
  - selectOne
```
public <T> reactor.core.publisher.Mono<T> selectOne(com.datastax.driver.core.Statement statement,
                                                    Class<T> entityClass)
```
    Description copied from interface: ReactiveCassandraOperations
    
    Execute a SELECT query and convert the resulting item to an entity.
    
    Specified by:
    
    selectOne in interface ReactiveCassandraOperations
    
    Parameters:
    
    statement - must not be null.
    
    entityClass - The entity type must not be null.
    
    Returns:
    
    the result object returned by the action or Mono.empty()
  - select
```
public <T> reactor.core.publisher.Flux<T> select(Query query,
                                                 Class<T> entityClass)
                                          throws DataAccessException
```
    Description copied from interface: ReactiveCassandraOperations
    
    Execute a SELECT query and convert the resulting items to a stream of entities.
    
    Specified by:
    
    select in interface ReactiveCassandraOperations
    
    Parameters:
    
    query - must not be null.
    
    entityClass - The entity type must not be null.
    
    Returns:
    
    the result objects returned by the action.
    
    Throws:
    
    DataAccessException - if there is any problem issuing the execution.
  - selectOne
```
public <T> reactor.core.publisher.Mono<T> selectOne(Query query,
                                                    Class<T> entityClass)
                                             throws DataAccessException
```
    Description copied from interface: ReactiveCassandraOperations
    
    Execute a SELECT query and convert the resulting item to an entity.
    
    Specified by:
    
    selectOne in interface ReactiveCassandraOperations
    
    Parameters:
    
    query - must not be null.
    
    entityClass - The entity type must not be null.
    
    Returns:
    
    the result object returned by the action or Mono.empty()
    
    Throws:
    
    DataAccessException - if there is any problem issuing the execution.
  - update
```
public reactor.core.publisher.Mono<Boolean> update(Query query,
                                                   Update update,
                                                   Class<?> entityClass)
                                            throws DataAccessException
```
    Description copied from interface: ReactiveCassandraOperations
    
    Update the queried entities and return true if the update was applied.
    
    Specified by:
    
    update in interface ReactiveCassandraOperations
    
    Parameters:
    
    query - must not be null.
    
    update - must not be null.
    
    entityClass - The entity type must not be null.
    
    Throws:
    
    DataAccessException - if there is any problem executing the query.
  - delete
```
public reactor.core.publisher.Mono<Boolean> delete(Query query,
                                                   Class<?> entityClass)
                                            throws DataAccessException
```
    Description copied from interface: ReactiveCassandraOperations
    
    Remove entities (rows)/columns from the table by Query.
    
    Specified by:
    
    delete in interface ReactiveCassandraOperations
    
    Parameters:
    
    query - must not be null.
    
    entityClass - The entity type must not be null.
    
    Returns:
    
    true if the deletion was applied.
    
    Throws:
    
    DataAccessException - if there is any problem issuing the execution.
  - count
```
public reactor.core.publisher.Mono<Long> count(Class<?> entityClass)
```
    Description copied from interface: ReactiveCassandraOperations
    
    Returns the number of rows for the given entity class.
    
    Specified by:
    
    count in interface ReactiveCassandraOperations
    
    Parameters:
    
    entityClass - must not be null.
    
    Returns:
    
    the number of existing entities.
  - exists
```
public reactor.core.publisher.Mono<Boolean> exists(Object id,
                                                   Class<?> entityClass)
```
    Description copied from interface: ReactiveCassandraOperations
    
    Determine whether the row entityClass with the given id exists.
    
    Specified by:
    
    exists in interface ReactiveCassandraOperations
    
    Parameters:
    
    id - the Id value. For single primary keys it's the plain value. For composite primary keys either the PrimaryKeyClass or MapId. Must not be null.
    
    entityClass - must not be null.
    
    Returns:
    
    true if the object exists.
  - selectOneById
```
public <T> reactor.core.publisher.Mono<T> selectOneById(Object id,
                                                        Class<T> entityClass)
```
    Description copied from interface: ReactiveCassandraOperations
    
    Execute the Select by id for the given entityClass.
    
    Specified by:
    
    selectOneById in interface ReactiveCassandraOperations
    
    Parameters:
    
    id - the Id value. For single primary keys it's the plain value. For composite primary keys either the PrimaryKeyClass or MapId. Must not be null.
    
    entityClass - The entity type must not be null.
    
    Returns:
    
    the result object returned by the action or Mono.empty()
  - insert
```
public <T> reactor.core.publisher.Mono<T> insert(T entity)
```
    Description copied from interface: ReactiveCassandraOperations
    
    Insert the given entity and emit the entity if the insert was applied.
    
    Specified by:
    
    insert in interface ReactiveCassandraOperations
    
    Parameters:
    
    entity - The entity to insert, must not be null.
    
    Returns:
    
    the inserted entity.
  - insert
```
public reactor.core.publisher.Mono<WriteResult> insert(Object entity,
                                                       InsertOptions options)
```
    Description copied from interface: ReactiveCassandraOperations
    
    Insert the given entity applying WriteOptions and emit the entity if the insert was applied.
    
    Specified by:
    
    insert in interface ReactiveCassandraOperations
    
    Parameters:
    
    entity - The entity to insert, must not be null.
    
    options - must not be null.
    
    Returns:
    
    the WriteResult for this operation.
    
    See Also:
    
    InsertOptions.empty()
  - update
```
public <T> reactor.core.publisher.Mono<T> update(T entity)
```
    Description copied from interface: ReactiveCassandraOperations
    
    Update the given entity and emit the entity if the update was applied.
    
    Specified by:
    
    update in interface ReactiveCassandraOperations
    
    Parameters:
    
    entity - The entity to update, must not be null.
    
    Returns:
    
    the updated entity.
  - update
```
public reactor.core.publisher.Mono<WriteResult> update(Object entity,
                                                       UpdateOptions options)
```
    Description copied from interface: ReactiveCassandraOperations
    
    Update the given entity applying WriteOptions and emit the entity if the update was applied.
    
    Specified by:
    
    update in interface ReactiveCassandraOperations
    
    Parameters:
    
    entity - The entity to update, must not be null.
    
    options - must not be null.
    
    Returns:
    
    the WriteResult for this operation.
    
    See Also:
    
    UpdateOptions.empty()
  - delete
```
public <T> reactor.core.publisher.Mono<T> delete(T entity)
```
    Description copied from interface: ReactiveCassandraOperations
    
    Delete the given entity and emit the entity if the delete was applied.
    
    Specified by:
    
    delete in interface ReactiveCassandraOperations
    
    Parameters:
    
    entity - must not be null.
    
    Returns:
    
    the deleted entity.
  - delete
```
public reactor.core.publisher.Mono<WriteResult> delete(Object entity,
                                                       QueryOptions options)
```
    Description copied from interface: ReactiveCassandraOperations
    
    Delete the given entity applying QueryOptions and emit the entity if the delete was applied.
    
    Specified by:
    
    delete in interface ReactiveCassandraOperations
    
    Parameters:
    
    entity - must not be null.
    
    options - must not be null.
    
    Returns:
    
    the WriteResult for this operation.
    
    See Also:
    
    QueryOptions.empty()
  - deleteById
```
public reactor.core.publisher.Mono<Boolean> deleteById(Object id,
                                                       Class<?> entityClass)
```
    Description copied from interface: ReactiveCassandraOperations
    
    Remove the given object from the table by id.
    
    Specified by:
    
    deleteById in interface ReactiveCassandraOperations
    
    Parameters:
    
    id - the Id value. For single primary keys it's the plain value. For composite primary keys either the PrimaryKeyClass or MapId. Must not be null.
    
    entityClass - The entity type must not be null.
    
    Returns:
    
    true if the deletion was applied.
  - truncate
```
public reactor.core.publisher.Mono<Void> truncate(Class<?> entityClass)
```
    Description copied from interface: ReactiveCassandraOperations
    
    Execute a TRUNCATE query to remove all entities of a given class.
    
    Specified by:
    
    truncate in interface ReactiveCassandraOperations
    
    Parameters:
    
    entityClass - The entity type must not be null.

Class ReactiveCassandraTemplate

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ReactiveCassandraTemplate

ReactiveCassandraTemplate

ReactiveCassandraTemplate

ReactiveCassandraTemplate

Method Detail

getConverter

getMappingContext

getReactiveCqlOperations

getStatementFactory

select

selectOne

select

selectOne

select

selectOne

update

delete

count

exists

selectOneById

insert

insert

update

update

delete

delete

deleteById

truncate