org.springframework.data.cassandra.core

Interface CassandraOperations

All Superinterfaces:

CqlOperations

All Known Subinterfaces:

CassandraAdminOperations

All Known Implementing Classes:

CassandraAdminTemplate, CassandraTemplate

public interface CassandraOperations
extends CqlOperations

Operations for interacting with Cassandra. These operations are used by the Repository implementation, but can also be used directly when that is desired by the developer.

Author:

Alex Shvid, David Webb, Matthew Adams

Method Summary

Modifier and Type	Method and Description
long	count(Class<?> type)
<T> void	delete(List<T> entities) Remove the given object from the table by id.
<T> void	delete(List<T> entities, QueryOptions options)
<T> void	delete(T entity) Remove the given object from the table by id.
<T> void	delete(T entity, QueryOptions options)
<T> void	deleteAll(Class<T> clazz) Deletes all entities of a given class.
<T> Cancellable	deleteAsynchronously(List<T> entities) Remove the given objects from the table by id.
<T> Cancellable	deleteAsynchronously(List<T> entities, DeletionListener<T> listener) Remove the given objects from the table by id.
<T> Cancellable	deleteAsynchronously(List<T> entities, DeletionListener<T> listener, QueryOptions options) Remove the given objects from the table by id.
<T> Cancellable	deleteAsynchronously(List<T> entities, QueryOptions options) Remove the given objects from the table by id.
<T> Cancellable	deleteAsynchronously(T entity) Remove the given object from the table by id.
<T> Cancellable	deleteAsynchronously(T entity, DeletionListener<T> listener) Remove the given object from the table by id.
<T> Cancellable	deleteAsynchronously(T entity, DeletionListener<T> listener, QueryOptions options) Remove the given object from the table by id.
<T> Cancellable	deleteAsynchronously(T entity, QueryOptions options) Remove the given object from the table by id.
void	deleteById(Class<?> type, Object id)
boolean	exists(Class<?> type, Object id)
CassandraConverter	getConverter() Returns the underlying CassandraConverter.
CqlIdentifier	getTableName(Class<?> entityClass) The table name used for the specified class by this template.
<T> List<T>	insert(List<T> entities) Insert the given list of entities.
<T> List<T>	insert(List<T> entities, WriteOptions options) Insert the given list of entities.
<T> T	insert(T entity) Insert the given entity.
<T> T	insert(T entity, WriteOptions options) Insert the given entity.
<T> List<T>	insertAsynchronously(List<T> entities) Deprecated. This method does not allow for query cancellation or notification of completion. Favor insertAsynchronously(List, WriteListener).
<T> Cancellable	insertAsynchronously(List<T> entities, WriteListener<T> listener) Inserts the given entities asynchronously in a batch.
<T> Cancellable	insertAsynchronously(List<T> entities, WriteListener<T> listener, WriteOptions options) Inserts the given entities asynchronously in a batch.
<T> List<T>	insertAsynchronously(List<T> entities, WriteOptions options) Deprecated. This method does not allow for query cancellation or notification of completion. Favor insertAsynchronously(List, WriteListener, WriteOptions).
<T> T	insertAsynchronously(T entity) Deprecated. This method does not allow for query cancellation or notification of completion. Favor insertAsynchronously(Object, WriteListener).
<T> Cancellable	insertAsynchronously(T entity, WriteListener<T> listener) Inserts the given entity asynchronously.
<T> Cancellable	insertAsynchronously(T entity, WriteListener<T> listener, WriteOptions options) Inserts the given entity asynchronously.
<T> T	insertAsynchronously(T entity, WriteOptions options) Deprecated. This method does not allow for query cancellation or notification of completion. Favor insertAsynchronously(Object, WriteListener, WriteOptions).
<T> List<T>	select(com.datastax.driver.core.querybuilder.Select select, Class<T> type) Execute the Select Query and convert to the list of entities
<T> List<T>	select(String cql, Class<T> type) Execute query and convert ResultSet to the list of entities
<T> List<T>	selectAll(Class<T> type) Deprecated. Calling this method could result in OutOfMemoryError, as this is a brute force selection.
<T> List<T>	selectBySimpleIds(Class<T> type, Iterable<?> ids)
<T> T	selectOne(com.datastax.driver.core.querybuilder.Select select, Class<T> type) Execute Select query and convert ResultSet to the entity
<T> T	selectOne(String cql, Class<T> type) Execute CQL and convert ResultSet to the entity
<T> Cancellable	selectOneAsynchronously(com.datastax.driver.core.querybuilder.Select select, Class<T> type, QueryForObjectListener<T> listener) Executes the Select query asynchronously.
<T> Cancellable	selectOneAsynchronously(com.datastax.driver.core.querybuilder.Select select, Class<T> type, QueryForObjectListener<T> listener, QueryOptions options) Executes the Select query asynchronously.
<T> Cancellable	selectOneAsynchronously(String cql, Class<T> type, QueryForObjectListener<T> listener) Executes the string CQL query asynchronously.
<T> Cancellable	selectOneAsynchronously(String cql, Class<T> type, QueryForObjectListener<T> listener, QueryOptions options) Executes the string CQL query asynchronously.
<T> T	selectOneById(Class<T> type, Object id)
<T> List<T>	update(List<T> entities) Update the given list of entities.
<T> List<T>	update(List<T> entities, WriteOptions options) Update the given list of entities.
<T> T	update(T entity) Update the given entity.
<T> T	update(T entity, WriteOptions options) Update the given entity.
<T> List<T>	updateAsynchronously(List<T> entities) Deprecated. This method does not allow for query cancellation or notification of completion. Favor updateAsynchronously(List, WriteListener).
<T> Cancellable	updateAsynchronously(List<T> entities, WriteListener<T> listener) Updates the given entities asynchronously in a batch.
<T> Cancellable	updateAsynchronously(List<T> entities, WriteListener<T> listener, WriteOptions options) Updates the given entities asynchronously in a batch.
<T> List<T>	updateAsynchronously(List<T> entities, WriteOptions options) Deprecated. This method does not allow for query cancellation or notification of completion. Favor updateAsynchronously(List, WriteListener, WriteOptions).
<T> T	updateAsynchronously(T entity) Deprecated. This method does not allow for query cancellation or notification of completion. Favor updateAsynchronously(Object, WriteListener).
<T> Cancellable	updateAsynchronously(T entity, WriteListener<T> listener) Updates the given entity asynchronously.
<T> Cancellable	updateAsynchronously(T entity, WriteListener<T> listener, WriteOptions options) Updates the given entity asynchronously.
<T> T	updateAsynchronously(T entity, WriteOptions options) Deprecated. This method does not allow for query cancellation or notification of completion. Favor updateAsynchronously(Object, WriteListener, WriteOptions).

Methods inherited from interface org.springframework.cassandra.core.CqlOperations

count, count, describeRing, describeRing, execute, execute, execute, execute, execute, execute, execute, execute, execute, execute, execute, execute, execute, execute, execute, execute, execute, execute, execute, executeAsynchronously, executeAsynchronously, executeAsynchronously, executeAsynchronously, executeAsynchronously, executeAsynchronously, executeAsynchronously, executeAsynchronously, executeAsynchronously, executeAsynchronously, executeAsynchronously, executeAsynchronously, executeAsynchronously, executeAsynchronously, executeAsynchronously, executeAsynchronously, executeAsynchronously, executeAsynchronously, executeAsynchronously, executeAsynchronously, executeAsynchronously, getResultSetUninterruptibly, getResultSetUninterruptibly, getResultSetUninterruptibly, getSession, ingest, ingest, ingest, ingest, ingest, ingest, process, process, processList, processListOfMap, processMap, processOne, processOne, query, query, query, query, query, query, query, query, query, query, query, query, query, query, query, query, query, query, query, query, query, query, query, query, query, query, query, query, query, query, queryAsynchronously, queryAsynchronously, queryAsynchronously, queryAsynchronously, queryAsynchronously, queryAsynchronously, queryAsynchronously, queryAsynchronously, queryAsynchronously, queryAsynchronously, queryAsynchronously, queryAsynchronously, queryAsynchronously, queryAsynchronously, queryAsynchronously, queryAsynchronously, queryAsynchronously, queryForList, queryForList, queryForListAsynchronously, queryForListAsynchronously, queryForListOfMap, queryForListOfMap, queryForListOfMapAsynchronously, queryForListOfMapAsynchronously, queryForListOfMapAsynchronously, queryForMap, queryForMap, queryForMapAsynchronously, queryForMapAsynchronously, queryForMapAsynchronously, queryForObject, queryForObject, queryForObject, queryForObject, queryForObjectAsynchronously, queryForObjectAsynchronously, queryForObjectAsynchronously, queryForObjectAsynchronously, queryForObjectAsynchronously, queryForObjectAsynchronously, truncate, truncate

Method Detail

getTableName

CqlIdentifier getTableName(Class<?> entityClass)

The table name used for the specified class by this template.

Parameters:

entityClass - must not be null.

Returns:

select

<T> List<T> select(String cql,
                   Class<T> type)

Execute query and convert ResultSet to the list of entities

Parameters:

query - must not be null.

type - must not be null, mapped entity type.

Returns:

select

<T> List<T> select(com.datastax.driver.core.querybuilder.Select select,
                   Class<T> type)

Execute the Select Query and convert to the list of entities

Parameters:

select - must not be null.

type - must not be null, mapped entity type.

Returns:

selectOneById

<T> T selectOneById(Class<T> type,
                    Object id)

selectOne

<T> T selectOne(String cql,
                Class<T> type)

Execute CQL and convert ResultSet to the entity

Parameters:

query - must not be null.

type - must not be null, mapped entity type.

Returns:

selectOneAsynchronously

<T> Cancellable selectOneAsynchronously(com.datastax.driver.core.querybuilder.Select select,
                                        Class<T> type,
                                        QueryForObjectListener<T> listener)

Executes the Select query asynchronously.

Parameters:

select - The Select query to execute.

type - The type of entity to retrieve.

Returns:

A Cancellable that can be used to cancel the query.

selectOneAsynchronously

<T> Cancellable selectOneAsynchronously(String cql,
                                        Class<T> type,
                                        QueryForObjectListener<T> listener)

Executes the string CQL query asynchronously.

Parameters:

select - The string query CQL to execute.

type - The type of entity to retrieve.

Returns:

A Cancellable that can be used to cancel the query.

selectOneAsynchronously

<T> Cancellable selectOneAsynchronously(com.datastax.driver.core.querybuilder.Select select,
                                        Class<T> type,
                                        QueryForObjectListener<T> listener,
                                        QueryOptions options)

Executes the Select query asynchronously.

Parameters:

select - The Select query to execute.

type - The type of entity to retrieve.

options - The QueryOptions to use.

Returns:

A Cancellable that can be used to cancel the query.

selectOneAsynchronously

<T> Cancellable selectOneAsynchronously(String cql,
                                        Class<T> type,
                                        QueryForObjectListener<T> listener,
                                        QueryOptions options)

Executes the string CQL query asynchronously.

Parameters:

select - The string query CQL to execute.

type - The type of entity to retrieve.

options - The QueryOptions to use.

Returns:

A Cancellable that can be used to cancel the query.

selectOne

<T> T selectOne(com.datastax.driver.core.querybuilder.Select select,
                Class<T> type)

Execute Select query and convert ResultSet to the entity

Parameters:

query - must not be null.

type - must not be null, mapped entity type.

Returns:

exists

boolean exists(Class<?> type,
               Object id)

count

long count(Class<?> type)

insert

<T> T insert(T entity)

Insert the given entity.

Parameters:

entity - The entity to insert

Returns:

The entity given

insert

<T> T insert(T entity,
             WriteOptions options)

Insert the given entity.

Parameters:

entity - The entity to insert

options - The WriteOptions to use.

Returns:

The entity given

insert

<T> List<T> insert(List<T> entities)

Insert the given list of entities.

Parameters:

entities - The entities to insert.

Returns:

The entities given.

insert

<T> List<T> insert(List<T> entities,
                   WriteOptions options)

Insert the given list of entities.

Parameters:

entities - The entities to insert.

options - The WriteOptions to use.

Returns:

The entities given.

insertAsynchronously

@Deprecated
<T> T insertAsynchronously(T entity)

Deprecated. This method does not allow for query cancellation or notification of completion. Favor insertAsynchronously(Object, WriteListener).

Inserts the given entity asynchronously.

Parameters:

entity - The entity to insert

Returns:

The entity given

See Also:

insertAsynchronously(Object, WriteListener)

insertAsynchronously

@Deprecated
<T> T insertAsynchronously(T entity,
                                       WriteOptions options)

Deprecated. This method does not allow for query cancellation or notification of completion. Favor insertAsynchronously(Object, WriteListener, WriteOptions).

Inserts the given entity asynchronously.

Parameters:

entity - The entity to insert

Returns:

The entity given

See Also:

insertAsynchronously(Object, WriteOptions)

insertAsynchronously

<T> Cancellable insertAsynchronously(T entity,
                                     WriteListener<T> listener)

Inserts the given entity asynchronously.

Parameters:

entity - The entity to insert

listener - The listener to receive notification of completion

Returns:

A Cancellable enabling the cancellation of the operation

insertAsynchronously

<T> Cancellable insertAsynchronously(T entity,
                                     WriteListener<T> listener,
                                     WriteOptions options)

Inserts the given entity asynchronously.

Parameters:

entity - The entity to insert

listener - The listener to receive notification of completion

options - The WriteOptions to use

Returns:

A Cancellable enabling the cancellation of the operation

insertAsynchronously

@Deprecated
<T> List<T> insertAsynchronously(List<T> entities)

Deprecated. This method does not allow for query cancellation or notification of completion. Favor insertAsynchronously(List, WriteListener).

Inserts the given entities asynchronously in a batch.

Parameters:

entity - The entities to insert

Returns:

The entities given

See Also:

insertAsynchronously(List, WriteListener)

insertAsynchronously

@Deprecated
<T> List<T> insertAsynchronously(List<T> entities,
                                             WriteOptions options)

Deprecated. This method does not allow for query cancellation or notification of completion. Favor insertAsynchronously(List, WriteListener, WriteOptions).

Inserts the given entities asynchronously in a batch.

Parameters:

entity - The entities to insert

Returns:

The entities given

See Also:

insertAsynchronously(List, WriteListener, WriteOptions)

insertAsynchronously

<T> Cancellable insertAsynchronously(List<T> entities,
                                     WriteListener<T> listener)

Inserts the given entities asynchronously in a batch.

Parameters:

entity - The entities to insert

listener - The listener to receive notification of completion

Returns:

A Cancellable enabling the cancellation of the operation

insertAsynchronously

<T> Cancellable insertAsynchronously(List<T> entities,
                                     WriteListener<T> listener,
                                     WriteOptions options)

Inserts the given entities asynchronously in a batch.

Parameters:

entity - The entities to insert

listener - The listener to receive notification of completion

options - The WriteOptions to use

Returns:

A Cancellable enabling the cancellation of the operation

update

<T> T update(T entity)

Update the given entity.

Parameters:

entity - The entity to update

Returns:

The entity given

update

<T> T update(T entity,
             WriteOptions options)

Update the given entity.

Parameters:

entity - The entity to update

options - The WriteOptions to use.

Returns:

The entity given

update

<T> List<T> update(List<T> entities)

Update the given list of entities.

Parameters:

entities - The entities to update.

Returns:

The entities given.

update

<T> List<T> update(List<T> entities,
                   WriteOptions options)

Update the given list of entities.

Parameters:

entities - The entities to update.

options - The WriteOptions to use.

Returns:

The entities given.

updateAsynchronously

@Deprecated
<T> T updateAsynchronously(T entity)

Deprecated. This method does not allow for query cancellation or notification of completion. Favor updateAsynchronously(Object, WriteListener).

Updates the given entity asynchronously.

Parameters:

entity - The entity to update

Returns:

The entity given

See Also:

updateAsynchronously(Object, WriteListener)

updateAsynchronously

@Deprecated
<T> T updateAsynchronously(T entity,
                                       WriteOptions options)

Deprecated. This method does not allow for query cancellation or notification of completion. Favor updateAsynchronously(Object, WriteListener, WriteOptions).

Updates the given entity asynchronously.

Parameters:

entity - The entity to update

Returns:

The entity given

See Also:

updateAsynchronously(Object, WriteOptions)

updateAsynchronously

<T> Cancellable updateAsynchronously(T entity,
                                     WriteListener<T> listener)

Updates the given entity asynchronously.

Parameters:

entity - The entity to update

listener - The listener to receive notification of completion

Returns:

A Cancellable enabling the cancellation of the operation

updateAsynchronously

<T> Cancellable updateAsynchronously(T entity,
                                     WriteListener<T> listener,
                                     WriteOptions options)

Updates the given entity asynchronously.

Parameters:

entity - The entity to update

listener - The listener to receive notification of completion

options - The WriteOptions to use

Returns:

A Cancellable enabling the cancellation of the operation

updateAsynchronously

@Deprecated
<T> List<T> updateAsynchronously(List<T> entities)

Deprecated. This method does not allow for query cancellation or notification of completion. Favor updateAsynchronously(List, WriteListener).

Updates the given entities asynchronously in a batch.

Parameters:

entity - The entities to update

Returns:

The entities given

See Also:

updateAsynchronously(List, WriteListener)

updateAsynchronously

@Deprecated
<T> List<T> updateAsynchronously(List<T> entities,
                                             WriteOptions options)

Deprecated. This method does not allow for query cancellation or notification of completion. Favor updateAsynchronously(List, WriteListener, WriteOptions).

Updates the given entities asynchronously in a batch.

Parameters:

entity - The entities to update

Returns:

The entities given

See Also:

updateAsynchronously(List, WriteListener, WriteOptions)

updateAsynchronously

<T> Cancellable updateAsynchronously(List<T> entities,
                                     WriteListener<T> listener)

Updates the given entities asynchronously in a batch.

Parameters:

entity - The entities to update

listener - The listener to receive notification of completion

Returns:

A Cancellable enabling the cancellation of the operation

updateAsynchronously

<T> Cancellable updateAsynchronously(List<T> entities,
                                     WriteListener<T> listener,
                                     WriteOptions options)

Updates the given entities asynchronously in a batch.

Parameters:

entity - The entities to update

listener - The listener to receive notification of completion

options - The WriteOptions to use

Returns:

A Cancellable enabling the cancellation of the operation

delete

<T> void delete(T entity)

Remove the given object from the table by id.

Parameters:

object -

delete

<T> void delete(T entity,
                QueryOptions options)

Parameters:

entity -

tableName -

options -

delete

<T> void delete(List<T> entities)

Remove the given object from the table by id.

Parameters:

object -

delete

<T> void delete(List<T> entities,
                QueryOptions options)

deleteAll

<T> void deleteAll(Class<T> clazz)

Deletes all entities of a given class.

deleteAsynchronously

<T> Cancellable deleteAsynchronously(T entity)

Remove the given object from the table by id.

Parameters:

entity - The object to delete

deleteAsynchronously

<T> Cancellable deleteAsynchronously(T entity,
                                     QueryOptions options)

Remove the given object from the table by id.

Parameters:

entity - The object to delete

options - The QueryOptions to use

deleteAsynchronously

<T> Cancellable deleteAsynchronously(T entity,
                                     DeletionListener<T> listener)

Remove the given object from the table by id.

Parameters:

entity - The object to delete

listener - The DeletionListener to receive notification upon completion

deleteAsynchronously

<T> Cancellable deleteAsynchronously(T entity,
                                     DeletionListener<T> listener,
                                     QueryOptions options)

Remove the given object from the table by id.

Parameters:

entity - The object to delete

listener - The DeletionListener to receive notification upon completion

options - The QueryOptions to use

deleteAsynchronously

<T> Cancellable deleteAsynchronously(List<T> entities)

Remove the given objects from the table by id.

Parameters:

entities - The objects to delete

deleteAsynchronously

<T> Cancellable deleteAsynchronously(List<T> entities,
                                     DeletionListener<T> listener)

Remove the given objects from the table by id.

Parameters:

entities - The objects to delete

listener - The DeletionListener to receive notification upon completion

deleteAsynchronously

<T> Cancellable deleteAsynchronously(List<T> entities,
                                     QueryOptions options)

Remove the given objects from the table by id.

Parameters:

entities - The objects to delete

options - The QueryOptions to use

deleteAsynchronously

<T> Cancellable deleteAsynchronously(List<T> entities,
                                     DeletionListener<T> listener,
                                     QueryOptions options)

Remove the given objects from the table by id.

Parameters:

entities - The objects to delete

listener - The DeletionListener to receive notification upon completion

options - The QueryOptions to use

getConverter

CassandraConverter getConverter()

Returns the underlying CassandraConverter.

Returns:

deleteById

void deleteById(Class<?> type,
                Object id)

selectBySimpleIds

<T> List<T> selectBySimpleIds(Class<T> type,
                              Iterable<?> ids)

selectAll

@Deprecated
<T> List<T> selectAll(Class<T> type)

Deprecated. Calling this method could result in OutOfMemoryError, as this is a brute force selection.

Parameters:

type - The type of entity to select.

Returns:

A list of all entities of type T.