org.springframework.data.cassandra.core

Class CassandraTemplate

java.lang.Object

org.springframework.cassandra.support.CassandraAccessor

org.springframework.cassandra.core.CqlTemplate

org.springframework.data.cassandra.core.CassandraTemplate

All Implemented Interfaces:

InitializingBean, CqlOperations, CassandraOperations

Direct Known Subclasses:

CassandraAdminTemplate

public class CassandraTemplate
extends CqlTemplate
implements CassandraOperations

The CassandraTemplate is a convenient API for all Cassandra operations using POJOs with their Spring Data Cassandra mapping information. For low-level Cassandra operation, see CqlTemplate.

Author:

Alex Shvid, David Webb, Matthew T. Adams, Oliver Gierke, Mark Paluch, John Blum

See Also:

CqlTemplate, CassandraOperations

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	CassandraTemplate.ClauseCallback

Field Summary

Fields

Modifier and Type	Field and Description
protected CassandraConverter	cassandraConverter
protected CassandraMappingContext	mappingContext

Fields inherited from class org.springframework.cassandra.core.CqlTemplate

RESULT_SET_RETURNING_EXTRACTOR, RUN_RUNNABLE_EXECUTOR

Fields inherited from class org.springframework.cassandra.support.CassandraAccessor

logger

Constructor Summary

Constructors

Constructor and Description
CassandraTemplate() Default constructor used to wire in the required components later.
CassandraTemplate(com.datastax.driver.core.Session session) Creates a new CassandraTemplate for the given Session.
CassandraTemplate(com.datastax.driver.core.Session session, CassandraConverter converter) Creates an instance of CassandraTemplate initialized with the given Session and CassandraConverter.

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
protected void	appendIdCriteria(CassandraTemplate.ClauseCallback clauseCallback, CassandraPersistentEntity<?> entity, Map<?,?> id) Deprecated.
protected void	appendIdCriteria(CassandraTemplate.ClauseCallback clauseCallback, CassandraPersistentEntity<?> entity, Object id) Deprecated.
protected void	appendIdCriteria(com.datastax.driver.core.querybuilder.Delete.Where where, CassandraPersistentEntity<?> entity, Object id) Deprecated.
protected void	appendIdCriteria(com.datastax.driver.core.querybuilder.Select.Where where, CassandraPersistentEntity<?> entity, Object id) Deprecated.
CassandraBatchOperations	batchOps() Returns a new CassandraBatchOperations.
long	count(Class<?> type) Returns the number of rows for the given entityClass by querying the table of the given entity class.
static <T> com.datastax.driver.core.querybuilder.Batch	createDeleteBatchQuery(String tableName, List<T> objectsToDelete, QueryOptions options, EntityWriter<Object,Object> entityWriter) Create a Batch Query object for multiple deletes.
static com.datastax.driver.core.querybuilder.Delete	createDeleteQuery(String tableName, Object objectToDelete, QueryOptions options, EntityWriter<Object,Object> entityWriter) Create a Delete Query Object from an annotated POJO.
static <T> com.datastax.driver.core.querybuilder.Batch	createInsertBatchQuery(String tableName, List<T> objectsToInsert, WriteOptions options, EntityWriter<Object,Object> entityWriter) Generates a Batch Object for multiple inserts.
static com.datastax.driver.core.querybuilder.Insert	createInsertQuery(String tableName, Object objectToUpdate, WriteOptions options, EntityWriter<Object,Object> entityWriter) Generates a Query Object for an insert.
static <T> com.datastax.driver.core.querybuilder.Batch	createUpdateBatchQuery(String tableName, List<T> objectsToUpdate, WriteOptions options, EntityWriter<Object,Object> entityWriter) Generates a Batch Object for multiple Updates.
static com.datastax.driver.core.querybuilder.Update	createUpdateQuery(String tableName, Object objectToUpdate, WriteOptions options, EntityWriter<Object,Object> entityWriter) Generates a Query Object for an Update.
<T> void	delete(List<T> entities) Remove the given objects from the table by id.
<T> void	delete(List<T> entities, QueryOptions options) Remove the given objects from the table by id.
<T> void	delete(T entity) Remove the given object from the table by id.
<T> void	delete(T entity, QueryOptions options) Remove the given object from the table by id.
<T> void	deleteAll(Class<T> entityClass) 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<?> entityClass, Object id) Remove the given object from the table by id.
protected <T> void	doBatchDelete(List<T> entities, QueryOptions options)
protected <T> Cancellable	doBatchDeleteAsync(List<T> entities, DeletionListener<T> listener, QueryOptions options)
protected <T> List<T>	doBatchInsert(List<T> entities, WriteOptions options)
protected <T> Cancellable	doBatchInsertAsync(List<T> entities, WriteListener<T> listener, WriteOptions options) Asynchronously performs a batch insert or update.
protected <T> List<T>	doBatchUpdate(List<T> entities, WriteOptions options)
protected <T> Cancellable	doBatchUpdateAsync(List<T> entities, WriteListener<T> listener, WriteOptions options) Asynchronously performs a batch insert or update.
protected <T> List<T>	doBatchWrite(List<T> entities, WriteOptions options, boolean insert)
protected <T> Cancellable	doBatchWriteAsync(List<T> entities, WriteListener<T> listener, WriteOptions options, boolean insert) Asynchronously performs a batch insert or update.
protected <T> void	doDelete(T entity, QueryOptions options)
protected <T> Cancellable	doDeleteAsync(T entity, DeletionListener<T> listener, QueryOptions options)
protected <T> T	doInsert(T entity, WriteOptions options)
protected <T> Cancellable	doInsertAsync(T entity, WriteListener<T> listener, WriteOptions options)
protected <T> Cancellable	doInsertAsynchronously(List<T> entities, WriteListener<T> listener, WriteOptions options) This method resolves ambiguity the compiler sees as a result of type erasure between insertAsynchronously(Object, WriteListener, WriteOptions) and insertAsynchronously(List, WriteListener, WriteOptions).
protected <T> Cancellable	doSelectOneAsync(Object query, Class<T> entityClass, QueryForObjectListener<T> listener, QueryOptions options)
protected <T> T	doUpdate(T entity, WriteOptions options)
protected <T> Cancellable	doUpdateAsync(T entity, WriteListener<T> listener, WriteOptions options)
protected <T> Cancellable	doUpdateAsynchronously(List<T> entities, WriteListener<T> listener, WriteOptions options) This method resolves ambiguity the compiler sees as a result of type erasure between updateAsynchronously(Object, WriteListener, WriteOptions) and updateAsynchronously(List, WriteListener, WriteOptions).
boolean	exists(Class<?> entityClass, Object id) Determine whether the row entityClass with the given id exists.
CassandraMappingContext	getCassandraMappingContext() Deprecated. as of 1.5, see getMappingContext().
CassandraConverter	getConverter() Returns the underlying CassandraConverter.
CassandraMappingContext	getMappingContext() Returns the CassandraMappingContext.
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 without inserting null values.
<T> T	insert(T entity, WriteOptions options) Insert the given entity without inserting null values.
<T> List<T>	insertAsynchronously(List<T> entities) Deprecated. as of 1.2, see insertAsynchronously(Object, 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. as of 1.2, see insertAsynchronously(List, WriteListener, WriteOptions)
<T> T	insertAsynchronously(T entity) Deprecated. as of 1.2, see insertAsynchronously(List, WriteListener, WriteOptions).
<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. as of 1.2, see insertAsynchronously(List, WriteListener, WriteOptions).
protected <T> List<T>	select(com.datastax.driver.core.querybuilder.Select query, CassandraConverterRowCallback<T> rowCallback)
<T> List<T>	select(com.datastax.driver.core.querybuilder.Select select, Class<T> entityClass) Execute the Select Query and convert to the list of entities.
protected <T> List<T>	select(String query, CassandraConverterRowCallback<T> rowCallback)
<T> List<T>	select(String cql, Class<T> entityClass) Execute query and convert ResultSet to the list of entities.
<T> List<T>	selectAll(Class<T> entityClass)
<T> List<T>	selectBySimpleIds(Class<T> entityClass, Iterable<?> ids) Select objects for the given entityClass and ids.
protected <T> T	selectOne(com.datastax.driver.core.querybuilder.Select query, CassandraConverterRowCallback<T> rowCallback)
<T> T	selectOne(com.datastax.driver.core.querybuilder.Select select, Class<T> entityClass) Execute Select query and convert ResultSet to the entity
protected <T> T	selectOne(String query, CassandraConverterRowCallback<T> rowCallback)
<T> T	selectOne(String cql, Class<T> entityClass) 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> entityClass, QueryForObjectListener<T> listener, QueryOptions options) Executes the Select query asynchronously.
<T> Cancellable	selectOneAsynchronously(String cql, Class<T> entityClass, QueryForObjectListener<T> listener) Executes the string CQL query asynchronously.
<T> Cancellable	selectOneAsynchronously(String cql, Class<T> entityClass, QueryForObjectListener<T> listener, QueryOptions options) Executes the string CQL query asynchronously.
<T> T	selectOneById(Class<T> entityClass, Object id) Execute the Select by id for the given entityClass.
void	setConverter(CassandraConverter cassandraConverter) Set the CassandraConverter used by this template to perform conversions.
<T> Iterator<T>	stream(String query, Class<T> entityClass) Executes the given select query on the entity table of the specified type backed by a Cassandra ResultSet.
static <T> com.datastax.driver.core.querybuilder.Batch	toUpdateBatchQuery(String tableName, List<T> objectsToUpdate, WriteOptions options, EntityWriter<Object,Object> entityWriter) Deprecated. as of 1.2, method renamed. Use createUpdateBatchQuery(String, List, WriteOptions, EntityWriter)
static com.datastax.driver.core.querybuilder.Update	toUpdateQueryX(String tableName, Object objectToUpdate, WriteOptions options, EntityWriter<Object,Object> entityWriter) Deprecated. as of 1.2, method renamed. Use createUpdateQuery(String, Object, WriteOptions, EntityWriter)
<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) Updates the given entities asynchronously in a batch.
<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) Updates the given entities asynchronously in a batch.
<T> T	updateAsynchronously(T entity) Updates the given entity asynchronously.
<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) Updates the given entity asynchronously.

Methods inherited from class org.springframework.cassandra.core.CqlTemplate

addPreparedStatementOptions, addQueryOptions, addWriteOptions, addWriteOptions, count, count, describeRing, describeRing, doExecute, doExecute, doExecute, doExecute, doExecuteAsync, doExecuteAsync, doExecuteAsync, doExecuteQueryReturnResultSet, doExecuteQueryReturnResultSet, 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, firstColumnToObject, getHosts, getResultSetUninterruptibly, getResultSetUninterruptibly, getResultSetUninterruptibly, ingest, ingest, ingest, ingest, ingest, ingest, logCql, logCql, logStatement, 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, 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, selectCount, toMap, translateExceptionIfPossible, translateExceptionIfPossible, truncate, truncate

Methods inherited from class org.springframework.cassandra.support.CassandraAccessor

getExceptionTranslator, getSession, logDebug, setExceptionTranslator, setSession

Methods inherited from class java.lang.Object

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

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

Field Detail

cassandraConverter

protected CassandraConverter cassandraConverter

mappingContext

protected CassandraMappingContext mappingContext

Constructor Detail

CassandraTemplate

public CassandraTemplate()

Default constructor used to wire in the required components later.

CassandraTemplate

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

Creates a new CassandraTemplate for the given Session.

Parameters:

session - Cassandra Session connected to the Cassandra cluster instance; must not be null.

See Also:

Session

CassandraTemplate

public CassandraTemplate(com.datastax.driver.core.Session session,
                         CassandraConverter converter)

Creates an instance of CassandraTemplate initialized with the given Session and CassandraConverter.

Parameters:

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

setConverter

public void setConverter(CassandraConverter cassandraConverter)

Set the CassandraConverter used by this template to perform conversions.

Parameters:

cassandraConverter - Converter used to perform conversion of Cassandra data types to entity types. Must not be null.

Throws:

IllegalArgumentException - if cassandraConverter is null.

getConverter

public CassandraConverter getConverter()

Description copied from interface: CassandraOperations

Returns the underlying CassandraConverter.

Specified by:

getConverter in interface CassandraOperations

Returns:

the underlying CassandraConverter.

getCassandraMappingContext

@Deprecated
public CassandraMappingContext getCassandraMappingContext()

Deprecated. as of 1.5, see getMappingContext().

getMappingContext

public CassandraMappingContext getMappingContext()

Returns the CassandraMappingContext.

Returns:

the CassandraMappingContext.

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface InitializingBean

Overrides:

afterPropertiesSet in class CassandraAccessor

exists

public boolean exists(Class<?> entityClass,
                      Object id)

Description copied from interface: CassandraOperations

Determine whether the row entityClass with the given id exists.

Specified by:

exists in interface CassandraOperations

Parameters:

entityClass - The entity type must not be null.

id - must not be null.

Returns:

true, if the object exists

count

public long count(Class<?> type)

Description copied from interface: CassandraOperations

Returns the number of rows for the given entityClass by querying the table of the given entity class.

Specified by:

count in interface CassandraOperations

Parameters:

type - The entity type must not be null.

Returns:

number of rows

delete

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

Description copied from interface: CassandraOperations

Remove the given objects from the table by id.

Specified by:

delete in interface CassandraOperations

Parameters:

entities - must not be null.

delete

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

Description copied from interface: CassandraOperations

Remove the given objects from the table by id.

Specified by:

delete in interface CassandraOperations

Parameters:

entities - must not be null.

options - may be null.

deleteById

public void deleteById(Class<?> entityClass,
                       Object id)

Description copied from interface: CassandraOperations

Remove the given object from the table by id.

Specified by:

deleteById in interface CassandraOperations

Parameters:

entityClass - The entity type must not be null.

id - must not be null.

delete

public <T> void delete(T entity)

Description copied from interface: CassandraOperations

Remove the given object from the table by id.

Specified by:

delete in interface CassandraOperations

Parameters:

entity - must not be null.

delete

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

Description copied from interface: CassandraOperations

Remove the given object from the table by id.

Specified by:

delete in interface CassandraOperations

Parameters:

entity - must not be null.

options - may be null.

deleteAsynchronously

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

Description copied from interface: CassandraOperations

Remove the given objects from the table by id.

Specified by:

deleteAsynchronously in interface CassandraOperations

Parameters:

entities - The objects to delete

deleteAsynchronously

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

Description copied from interface: CassandraOperations

Remove the given objects from the table by id.

Specified by:

deleteAsynchronously in interface CassandraOperations

Parameters:

entities - The objects to delete

options - The QueryOptions to use

deleteAsynchronously

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

Description copied from interface: CassandraOperations

Remove the given objects from the table by id.

Specified by:

deleteAsynchronously in interface CassandraOperations

Parameters:

entities - The objects to delete

listener - The DeletionListener to receive notification upon completion

deleteAsynchronously

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

Description copied from interface: CassandraOperations

Remove the given objects from the table by id.

Specified by:

deleteAsynchronously in interface CassandraOperations

Parameters:

entities - The objects to delete

listener - The DeletionListener to receive notification upon completion

options - The QueryOptions to use

deleteAsynchronously

public <T> Cancellable deleteAsynchronously(T entity)

Description copied from interface: CassandraOperations

Remove the given object from the table by id.

Specified by:

deleteAsynchronously in interface CassandraOperations

Parameters:

entity - The object to delete

deleteAsynchronously

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

Description copied from interface: CassandraOperations

Remove the given object from the table by id.

Specified by:

deleteAsynchronously in interface CassandraOperations

Parameters:

entity - The object to delete

options - The QueryOptions to use

deleteAsynchronously

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

Description copied from interface: CassandraOperations

Remove the given object from the table by id.

Specified by:

deleteAsynchronously in interface CassandraOperations

Parameters:

entity - The object to delete

listener - The DeletionListener to receive notification upon completion

deleteAsynchronously

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

Description copied from interface: CassandraOperations

Remove the given object from the table by id.

Specified by:

deleteAsynchronously in interface CassandraOperations

Parameters:

entity - The object to delete

listener - The DeletionListener to receive notification upon completion

options - The QueryOptions to use

getTableName

public CqlIdentifier getTableName(Class<?> entityClass)

Description copied from interface: CassandraOperations

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

Specified by:

getTableName in interface CassandraOperations

Parameters:

entityClass - The entity type must not be null.

Returns:

the CqlIdentifier

insert

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

Description copied from interface: CassandraOperations

Insert the given list of entities.

Specified by:

insert in interface CassandraOperations

Parameters:

entities - The entities to insert.

Returns:

The entities given.

insert

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

Description copied from interface: CassandraOperations

Insert the given list of entities.

Specified by:

insert in interface CassandraOperations

Parameters:

entities - The entities to insert.

options - The WriteOptions to use.

Returns:

The entities given.

insert

public <T> T insert(T entity)

Description copied from interface: CassandraOperations

Insert the given entity without inserting null values.

Specified by:

insert in interface CassandraOperations

Parameters:

entity - The entity to insert

Returns:

The entity given

insert

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

Description copied from interface: CassandraOperations

Insert the given entity without inserting null values.

Specified by:

insert in interface CassandraOperations

Parameters:

entity - The entity to insert

options - The WriteOptions to use.

Returns:

The entity given

insertAsynchronously

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

Deprecated. as of 1.2, see insertAsynchronously(Object, WriteListener)

Description copied from interface: CassandraOperations

Inserts the given entities asynchronously in a batch.

Specified by:

insertAsynchronously in interface CassandraOperations

Parameters:

entities - The entities to insert

Returns:

The entities given

See Also:

CassandraOperations.insertAsynchronously(List, WriteListener)

insertAsynchronously

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

Deprecated. as of 1.2, see insertAsynchronously(List, WriteListener, WriteOptions)

Description copied from interface: CassandraOperations

Inserts the given entities asynchronously in a batch.

Specified by:

insertAsynchronously in interface CassandraOperations

Parameters:

entities - The entities to insert

Returns:

The entities given

See Also:

CassandraOperations.insertAsynchronously(List, WriteListener, WriteOptions)

insertAsynchronously

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

Description copied from interface: CassandraOperations

Inserts the given entities asynchronously in a batch.

Specified by:

insertAsynchronously in interface CassandraOperations

Parameters:

entities - The entities to insert

listener - The listener to receive notification of completion

Returns:

A Cancellable enabling the cancellation of the operation

insertAsynchronously

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

Description copied from interface: CassandraOperations

Inserts the given entities asynchronously in a batch.

Specified by:

insertAsynchronously in interface CassandraOperations

Parameters:

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

doInsertAsynchronously

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

This method resolves ambiguity the compiler sees as a result of type erasure between insertAsynchronously(Object, WriteListener, WriteOptions) and insertAsynchronously(List, WriteListener, WriteOptions).

insertAsynchronously

@Deprecated
public <T> T insertAsynchronously(T entity)

Deprecated. as of 1.2, see insertAsynchronously(List, WriteListener, WriteOptions).

Description copied from interface: CassandraOperations

Inserts the given entity asynchronously.

Specified by:

insertAsynchronously in interface CassandraOperations

Parameters:

entity - The entity to insert

Returns:

The entity given

See Also:

CassandraOperations.insertAsynchronously(Object, WriteListener)

insertAsynchronously

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

Deprecated. as of 1.2, see insertAsynchronously(List, WriteListener, WriteOptions).

Description copied from interface: CassandraOperations

Inserts the given entity asynchronously.

Specified by:

insertAsynchronously in interface CassandraOperations

Parameters:

entity - The entity to insert

Returns:

The entity given

See Also:

CassandraOperations.insertAsynchronously(Object, WriteOptions)

insertAsynchronously

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

Description copied from interface: CassandraOperations

Inserts the given entity asynchronously.

Specified by:

insertAsynchronously in interface CassandraOperations

Parameters:

entity - The entity to insert

listener - The listener to receive notification of completion

Returns:

A Cancellable enabling the cancellation of the operation

insertAsynchronously

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

Description copied from interface: CassandraOperations

Inserts the given entity asynchronously.

Specified by:

insertAsynchronously in interface CassandraOperations

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

selectAll

public <T> List<T> selectAll(Class<T> entityClass)

Specified by:

selectAll in interface CassandraOperations

Parameters:

entityClass - The entity type must not be null.

Returns:

A list of all entities of type T.

select

public <T> List<T> select(String cql,
                          Class<T> entityClass)

Description copied from interface: CassandraOperations

Execute query and convert ResultSet to the list of entities.

Specified by:

select in interface CassandraOperations

Parameters:

cql - must not be null.

entityClass - The entity type must not be null.

Returns:

the converted results

select

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

Description copied from interface: CassandraOperations

Execute the Select Query and convert to the list of entities.

Specified by:

select in interface CassandraOperations

Parameters:

select - must not be null.

entityClass - The entity type must not be null.

Returns:

the converted results

selectBySimpleIds

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

Description copied from interface: CassandraOperations

Select objects for the given entityClass and ids.

Specified by:

selectBySimpleIds in interface CassandraOperations

Parameters:

entityClass - The entity type must not be null.

ids - must not be null.

Returns:

the converted results

selectOneById

public <T> T selectOneById(Class<T> entityClass,
                           Object id)

Description copied from interface: CassandraOperations

Execute the Select by id for the given entityClass.

Specified by:

selectOneById in interface CassandraOperations

Parameters:

entityClass - The entity type must not be null.

id - must not be null.

Returns:

the converted object or null.

appendIdCriteria

@Deprecated
protected void appendIdCriteria(CassandraTemplate.ClauseCallback clauseCallback,
                                            CassandraPersistentEntity<?> entity,
                                            Map<?,?> id)

Deprecated.

appendIdCriteria

@Deprecated
protected void appendIdCriteria(CassandraTemplate.ClauseCallback clauseCallback,
                                            CassandraPersistentEntity<?> entity,
                                            Object id)

Deprecated.

appendIdCriteria

@Deprecated
protected void appendIdCriteria(com.datastax.driver.core.querybuilder.Select.Where where,
                                            CassandraPersistentEntity<?> entity,
                                            Object id)

Deprecated.

appendIdCriteria

@Deprecated
protected void appendIdCriteria(com.datastax.driver.core.querybuilder.Delete.Where where,
                                            CassandraPersistentEntity<?> entity,
                                            Object id)

Deprecated.

selectOne

public <T> T selectOne(String cql,
                       Class<T> entityClass)

Description copied from interface: CassandraOperations

Execute CQL and convert ResultSet to the entity

Specified by:

selectOne in interface CassandraOperations

Parameters:

cql - must not be null.

entityClass - The entity type must not be null.

Returns:

the converted object or null.

selectOne

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

Description copied from interface: CassandraOperations

Execute Select query and convert ResultSet to the entity

Specified by:

selectOne in interface CassandraOperations

Parameters:

select - must not be null.

entityClass - The entity type must not be null.

Returns:

the converted object or null.

update

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

Description copied from interface: CassandraOperations

Update the given list of entities.

Specified by:

update in interface CassandraOperations

Parameters:

entities - The entities to update.

Returns:

The entities given.

update

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

Description copied from interface: CassandraOperations

Update the given list of entities.

Specified by:

update in interface CassandraOperations

Parameters:

entities - The entities to update.

options - The WriteOptions to use.

Returns:

The entities given.

update

public <T> T update(T entity)

Description copied from interface: CassandraOperations

Update the given entity.

Specified by:

update in interface CassandraOperations

Parameters:

entity - The entity to update

Returns:

The entity given

update

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

Description copied from interface: CassandraOperations

Update the given entity.

Specified by:

update in interface CassandraOperations

Parameters:

entity - The entity to update

options - The WriteOptions to use.

Returns:

The entity given

updateAsynchronously

public <T> List<T> updateAsynchronously(List<T> entities)

Description copied from interface: CassandraOperations

Updates the given entities asynchronously in a batch.

Specified by:

updateAsynchronously in interface CassandraOperations

Parameters:

entities - The entities to update

Returns:

The entities given

See Also:

CassandraOperations.updateAsynchronously(List, WriteListener)

updateAsynchronously

public <T> List<T> updateAsynchronously(List<T> entities,
                                        WriteOptions options)

Description copied from interface: CassandraOperations

Updates the given entities asynchronously in a batch.

Specified by:

updateAsynchronously in interface CassandraOperations

Parameters:

entities - The entities to update

Returns:

The entities given

See Also:

CassandraOperations.updateAsynchronously(List, WriteListener, WriteOptions)

updateAsynchronously

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

Description copied from interface: CassandraOperations

Updates the given entities asynchronously in a batch.

Specified by:

updateAsynchronously in interface CassandraOperations

Parameters:

entities - The entities to update

listener - The listener to receive notification of completion

Returns:

A Cancellable enabling the cancellation of the operation

updateAsynchronously

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

Description copied from interface: CassandraOperations

Updates the given entities asynchronously in a batch.

Specified by:

updateAsynchronously in interface CassandraOperations

Parameters:

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

doUpdateAsynchronously

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

This method resolves ambiguity the compiler sees as a result of type erasure between updateAsynchronously(Object, WriteListener, WriteOptions) and updateAsynchronously(List, WriteListener, WriteOptions).

updateAsynchronously

public <T> T updateAsynchronously(T entity)

Description copied from interface: CassandraOperations

Updates the given entity asynchronously.

Specified by:

updateAsynchronously in interface CassandraOperations

Parameters:

entity - The entity to update

Returns:

The entity given

See Also:

CassandraOperations.updateAsynchronously(Object, WriteListener)

updateAsynchronously

public <T> T updateAsynchronously(T entity,
                                  WriteOptions options)

Description copied from interface: CassandraOperations

Updates the given entity asynchronously.

Specified by:

updateAsynchronously in interface CassandraOperations

Parameters:

entity - The entity to update

Returns:

The entity given

See Also:

CassandraOperations.updateAsynchronously(Object, WriteOptions)

updateAsynchronously

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

Description copied from interface: CassandraOperations

Updates the given entity asynchronously.

Specified by:

updateAsynchronously in interface CassandraOperations

Parameters:

entity - The entity to update

listener - The listener to receive notification of completion

Returns:

A Cancellable enabling the cancellation of the operation

updateAsynchronously

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

Description copied from interface: CassandraOperations

Updates the given entity asynchronously.

Specified by:

updateAsynchronously in interface CassandraOperations

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

select

protected <T> List<T> select(String query,
                             CassandraConverterRowCallback<T> rowCallback)

select

protected <T> List<T> select(com.datastax.driver.core.querybuilder.Select query,
                             CassandraConverterRowCallback<T> rowCallback)

stream

public <T> Iterator<T> stream(String query,
                              Class<T> entityClass)

Description copied from interface: CassandraOperations

Executes the given select query on the entity table of the specified type backed by a Cassandra ResultSet.

Returns a Iterator that wraps the Cassandra ResultSet.

Specified by:

stream in interface CassandraOperations

Type Parameters:

T - element return type.

Parameters:

query - query to execute. Must not be empty or null.

entityClass - Class type of the elements in the Iterator stream. Must not be null.

Returns:

an Iterator (stream) over the elements in the query result set.

selectOne

protected <T> T selectOne(String query,
                          CassandraConverterRowCallback<T> rowCallback)

selectOne

protected <T> T selectOne(com.datastax.driver.core.querybuilder.Select query,
                          CassandraConverterRowCallback<T> rowCallback)

doBatchDelete

protected <T> void doBatchDelete(List<T> entities,
                                 QueryOptions options)

doBatchDeleteAsync

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

doInsert

protected <T> T doInsert(T entity,
                         WriteOptions options)

doInsertAsync

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

doBatchInsert

protected <T> List<T> doBatchInsert(List<T> entities,
                                    WriteOptions options)

doBatchUpdate

protected <T> List<T> doBatchUpdate(List<T> entities,
                                    WriteOptions options)

doBatchWrite

protected <T> List<T> doBatchWrite(List<T> entities,
                                   WriteOptions options,
                                   boolean insert)

doBatchInsertAsync

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

Asynchronously performs a batch insert or update.

Parameters:

entities - The entities to insert or update.

listener - The listener that will receive notification of the completion of the batch insert or update. May be null.

options - The WriteOptions to use. May be null.

Returns:

A Cancellable that can be used to cancel the query if necessary.

doBatchUpdateAsync

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

Asynchronously performs a batch insert or update.

Parameters:

entities - The entities to insert or update.

listener - The listener that will receive notification of the completion of the batch insert or update. May be null.

options - The WriteOptions to use. May be null.

Returns:

A Cancellable that can be used to cancel the query if necessary.

doBatchWriteAsync

protected <T> Cancellable doBatchWriteAsync(List<T> entities,
                                            WriteListener<T> listener,
                                            WriteOptions options,
                                            boolean insert)

Asynchronously performs a batch insert or update.

Parameters:

entities - The entities to insert or update.

listener - The listener that will receive notification of the completion of the batch insert or update. May be null.

options - The WriteOptions to use. May be null.

insert - If true, then an insert is performed, else an update is performed.

Returns:

A Cancellable that can be used to cancel the query if necessary.

doDelete

protected <T> void doDelete(T entity,
                            QueryOptions options)

doDeleteAsync

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

doUpdate

protected <T> T doUpdate(T entity,
                         WriteOptions options)

doUpdateAsync

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

batchOps

public CassandraBatchOperations batchOps()

Description copied from interface: CassandraOperations

Returns a new CassandraBatchOperations. Each CassandraBatchOperations instance can be executed only once so you might want to obtain new CassandraBatchOperations instances for each batch.

Specified by:

batchOps in interface CassandraOperations

Returns:

a new CassandraBatchOperations associated with the given entity class.

createInsertQuery

public static com.datastax.driver.core.querybuilder.Insert createInsertQuery(String tableName,
                                                                             Object objectToUpdate,
                                                                             WriteOptions options,
                                                                             EntityWriter<Object,Object> entityWriter)

Generates a Query Object for an insert.

Parameters:

tableName - the table name, must not be empty and not null.

objectToUpdate - the object to save, must not be null.

options - optional WriteOptions to apply to the Insert statement, may be null.

entityWriter - the EntityWriter to write insert values.

Returns:

The Query object to run with session.execute();

createInsertBatchQuery

public static <T> com.datastax.driver.core.querybuilder.Batch createInsertBatchQuery(String tableName,
                                                                                     List<T> objectsToInsert,
                                                                                     WriteOptions options,
                                                                                     EntityWriter<Object,Object> entityWriter)

Generates a Batch Object for multiple inserts.

Parameters:

tableName - the table name, must not be empty and not null.

objectsToInsert - the object to save, must not be empty and not null.

options - optional WriteOptions to apply to the Insert statement, may be null.

entityWriter - the EntityWriter to write insert values.

Returns:

The Query object to run with session.execute();

createUpdateQuery

public static com.datastax.driver.core.querybuilder.Update createUpdateQuery(String tableName,
                                                                             Object objectToUpdate,
                                                                             WriteOptions options,
                                                                             EntityWriter<Object,Object> entityWriter)

Generates a Query Object for an Update. The Update uses the identity and values from the given objectsToUpdate.

Parameters:

tableName - the table name, must not be empty and not null.

objectToUpdate - the object to update, must not be null.

options - optional WriteOptions to apply to the Update statement, may be null.

entityWriter - the EntityWriter to write update assignments and where clauses.

Returns:

The Query object to run with session.execute();

createUpdateBatchQuery

public static <T> com.datastax.driver.core.querybuilder.Batch createUpdateBatchQuery(String tableName,
                                                                                     List<T> objectsToUpdate,
                                                                                     WriteOptions options,
                                                                                     EntityWriter<Object,Object> entityWriter)

Generates a Batch Object for multiple Updates. The Update uses the identity and values from the given objectsToUpdate.

Parameters:

tableName - the table name, must not be empty and not null.

objectsToUpdate - the object to update, must not be empty and not null.

options - optional WriteOptions to apply to the Update statement, may be null.

entityWriter - the EntityWriter to write update assignments and where clauses.

Returns:

The Query object to run with session.execute();

toUpdateBatchQuery

@Deprecated
public static <T> com.datastax.driver.core.querybuilder.Batch toUpdateBatchQuery(String tableName,
                                                                                             List<T> objectsToUpdate,
                                                                                             WriteOptions options,
                                                                                             EntityWriter<Object,Object> entityWriter)

Deprecated. as of 1.2, method renamed. Use createUpdateBatchQuery(String, List, WriteOptions, EntityWriter)

See Also:

createUpdateBatchQuery(String, List, WriteOptions, EntityWriter)

toUpdateQueryX

@Deprecated
public static com.datastax.driver.core.querybuilder.Update toUpdateQueryX(String tableName,
                                                                                      Object objectToUpdate,
                                                                                      WriteOptions options,
                                                                                      EntityWriter<Object,Object> entityWriter)

Deprecated. as of 1.2, method renamed. Use createUpdateQuery(String, Object, WriteOptions, EntityWriter)

See Also:

createUpdateQuery(String, Object, WriteOptions, EntityWriter)

createDeleteQuery

public static com.datastax.driver.core.querybuilder.Delete createDeleteQuery(String tableName,
                                                                             Object objectToDelete,
                                                                             QueryOptions options,
                                                                             EntityWriter<Object,Object> entityWriter)

Create a Delete Query Object from an annotated POJO. The Delete uses the identity from the given objectToDelete.

Parameters:

tableName - the table name, must not be empty and not null.

objectToDelete - the object to delete, must not be null.

options - optional QueryOptions to apply to the Delete statement, may be null.

entityWriter - the EntityWriter to write delete where clauses.

Returns:

The Query object to run with session.execute();

createDeleteBatchQuery

public static <T> com.datastax.driver.core.querybuilder.Batch createDeleteBatchQuery(String tableName,
                                                                                     List<T> objectsToDelete,
                                                                                     QueryOptions options,
                                                                                     EntityWriter<Object,Object> entityWriter)

Create a Batch Query object for multiple deletes.

Parameters:

tableName - the table name, must not be empty and not null.

objectsToDelete - the object to delete, must not be empty and not null.

options - optional QueryOptions to apply to the Delete statement, may be null.

entityWriter - the EntityWriter to write delete where clauses.

Returns:

The Query object to run with session.execute();

deleteAll

public <T> void deleteAll(Class<T> entityClass)

Description copied from interface: CassandraOperations

Deletes all entities of a given class.

Specified by:

deleteAll in interface CassandraOperations

Parameters:

entityClass - The entity type must not be null.

selectOneAsynchronously

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

Description copied from interface: CassandraOperations

Executes the Select query asynchronously.

Specified by:

selectOneAsynchronously in interface CassandraOperations

Parameters:

select - The Select query to execute.

type - The entity type must not be null.

Returns:

A Cancellable that can be used to cancel the query.

selectOneAsynchronously

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

Description copied from interface: CassandraOperations

Executes the string CQL query asynchronously.

Specified by:

selectOneAsynchronously in interface CassandraOperations

Parameters:

cql - The string query CQL to execute.

entityClass - The entity type must not be null.

Returns:

A Cancellable that can be used to cancel the query.

selectOneAsynchronously

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

Description copied from interface: CassandraOperations

Executes the Select query asynchronously.

Specified by:

selectOneAsynchronously in interface CassandraOperations

Parameters:

select - The Select query to execute.

entityClass - The entity type must not be null.

options - The QueryOptions to use.

Returns:

A Cancellable that can be used to cancel the query.

selectOneAsynchronously

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

Description copied from interface: CassandraOperations

Executes the string CQL query asynchronously.

Specified by:

selectOneAsynchronously in interface CassandraOperations

Parameters:

cql - The string query CQL to execute.

entityClass - The entity type must not be null.

options - The QueryOptions to use.

Returns:

A Cancellable that can be used to cancel the query.

doSelectOneAsync

protected <T> Cancellable doSelectOneAsync(Object query,
                                           Class<T> entityClass,
                                           QueryForObjectListener<T> listener,
                                           QueryOptions options)