org.springframework.data.cassandra.core

Class CassandraAdminTemplate

java.lang.Object

org.springframework.cassandra.support.CassandraAccessor

org.springframework.cassandra.core.CqlTemplate

org.springframework.data.cassandra.core.CassandraTemplate

org.springframework.data.cassandra.core.CassandraAdminTemplate

All Implemented Interfaces:

InitializingBean, CqlOperations, CassandraAdminOperations, CassandraOperations

public class CassandraAdminTemplate
extends CassandraTemplate
implements CassandraAdminOperations

Default implementation of CassandraAdminOperations.

Author:

Mark Paluch, Fabio J. Mendes

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.data.cassandra.core.CassandraTemplate

CassandraTemplate.ClauseCallback

Field Summary

Fields inherited from class org.springframework.data.cassandra.core.CassandraTemplate

cassandraConverter, 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
CassandraAdminTemplate(com.datastax.driver.core.Session session, CassandraConverter converter) Constructor used for a basic template configuration

Method Summary

Modifier and Type	Method and Description
void	alterTable(CqlIdentifier tableName, Class<?> entityClass, boolean dropRemovedAttributeColumns) Add columns to the given table from the given class.
void	createTable(boolean ifNotExists, CqlIdentifier tableName, Class<?> entityClass, Map<String,Object> optionsByName) Create a table with the name given and fields corresponding to the given class.
protected void	doAlterTable(Class<?> entityClass, String keyspace, CqlIdentifier tableName) Create a list of query operations to alter the table for the given entity
void	dropTable(Class<?> entityClass)
void	dropTable(CqlIdentifier tableName) Drops the named table.
void	dropUserType(CqlIdentifier typeName) Drops a user type.
com.datastax.driver.core.KeyspaceMetadata	getKeyspaceMetadata() Returns KeyspaceMetadata for the current keyspace.
com.datastax.driver.core.TableMetadata	getTableMetadata(String keyspace, CqlIdentifier tableName) Lookup TableMetadata.
void	replaceTable(CqlIdentifier tableName, Class<?> entityClass, Map<String,Object> optionsByName) Drops the existing table with the given name and creates a new one; basically a #dropTable(String) followed by a #createTable(boolean, String, Class, Map).

Methods inherited from class org.springframework.data.cassandra.core.CassandraTemplate

afterPropertiesSet, appendIdCriteria, appendIdCriteria, appendIdCriteria, appendIdCriteria, batchOps, count, createDeleteBatchQuery, createDeleteQuery, createInsertBatchQuery, createInsertQuery, createUpdateBatchQuery, createUpdateQuery, delete, delete, delete, delete, deleteAll, deleteAsynchronously, deleteAsynchronously, deleteAsynchronously, deleteAsynchronously, deleteAsynchronously, deleteAsynchronously, deleteAsynchronously, deleteAsynchronously, deleteById, doBatchDelete, doBatchDeleteAsync, doBatchInsert, doBatchInsertAsync, doBatchUpdate, doBatchUpdateAsync, doBatchWrite, doBatchWriteAsync, doDelete, doDeleteAsync, doInsert, doInsertAsync, doInsertAsynchronously, doSelectOneAsync, doUpdate, doUpdateAsync, doUpdateAsynchronously, exists, getCassandraMappingContext, getConverter, getMappingContext, getTableName, insert, insert, insert, insert, insertAsynchronously, insertAsynchronously, insertAsynchronously, insertAsynchronously, insertAsynchronously, insertAsynchronously, insertAsynchronously, insertAsynchronously, select, select, select, select, selectAll, selectBySimpleIds, selectOne, selectOne, selectOne, selectOne, selectOneAsynchronously, selectOneAsynchronously, selectOneAsynchronously, selectOneAsynchronously, selectOneById, setConverter, stream, toUpdateBatchQuery, toUpdateQueryX, update, update, update, update, updateAsynchronously, updateAsynchronously, updateAsynchronously, updateAsynchronously, updateAsynchronously, updateAsynchronously, updateAsynchronously, updateAsynchronously

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.data.cassandra.core.CassandraOperations

batchOps, count, delete, delete, delete, delete, deleteAll, deleteAsynchronously, deleteAsynchronously, deleteAsynchronously, deleteAsynchronously, deleteAsynchronously, deleteAsynchronously, deleteAsynchronously, deleteAsynchronously, deleteById, exists, getConverter, getTableName, insert, insert, insert, insert, insertAsynchronously, insertAsynchronously, insertAsynchronously, insertAsynchronously, insertAsynchronously, insertAsynchronously, insertAsynchronously, insertAsynchronously, select, select, selectAll, selectBySimpleIds, selectOne, selectOne, selectOneAsynchronously, selectOneAsynchronously, selectOneAsynchronously, selectOneAsynchronously, selectOneById, stream, update, update, update, update, updateAsynchronously, updateAsynchronously, updateAsynchronously, updateAsynchronously, updateAsynchronously, updateAsynchronously, updateAsynchronously, updateAsynchronously

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

Constructor Detail

CassandraAdminTemplate

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

Constructor used for a basic template configuration

Parameters:

session - must not be null.

converter - must not be null.

Method Detail

createTable

public void createTable(boolean ifNotExists,
                        CqlIdentifier tableName,
                        Class<?> entityClass,
                        Map<String,Object> optionsByName)

Description copied from interface: CassandraAdminOperations

Create a table with the name given and fields corresponding to the given class. If the table already exists and parameter ifNotExists is true, this is a no-op and false is returned. If the table doesn't exist, parameter ifNotExists is ignored, the table is created and true is returned.

Specified by:

createTable in interface CassandraAdminOperations

Parameters:

ifNotExists - If true, will only create the table if it doesn't exist, else the create operation will be ignored and the method will return false.

tableName - The name of the table.

entityClass - The class whose fields determine the columns created.

optionsByName - Table options, given by the string option name and the appropriate option value.

alterTable

public void alterTable(CqlIdentifier tableName,
                       Class<?> entityClass,
                       boolean dropRemovedAttributeColumns)

Description copied from interface: CassandraAdminOperations

Add columns to the given table from the given class. If parameter dropRemovedAttributColumns is true, then this effectively becomes a synchronization operation between the class's fields and the existing table's columns.

Specified by:

alterTable in interface CassandraAdminOperations

Parameters:

tableName - The name of the existing table.

entityClass - The class whose fields determine the columns added.

dropRemovedAttributeColumns - Whether to drop columns that exist on the table but that don't have corresponding fields in the class. If true, this effectively becomes a synchronziation operation.

replaceTable

public void replaceTable(CqlIdentifier tableName,
                         Class<?> entityClass,
                         Map<String,Object> optionsByName)

Description copied from interface: CassandraAdminOperations

Drops the existing table with the given name and creates a new one; basically a #dropTable(String) followed by a #createTable(boolean, String, Class, Map).

Specified by:

replaceTable in interface CassandraAdminOperations

Parameters:

tableName - The name of the table.

entityClass - The class whose fields determine the new table's columns.

optionsByName - Table options, given by the string option name and the appropriate option value.

doAlterTable

protected void doAlterTable(Class<?> entityClass,
                            String keyspace,
                            CqlIdentifier tableName)

Create a list of query operations to alter the table for the given entity

Parameters:

entityClass -

tableName -

dropTable

public void dropTable(Class<?> entityClass)

dropTable

public void dropTable(CqlIdentifier tableName)

Description copied from interface: CassandraAdminOperations

Drops the named table.

Specified by:

dropTable in interface CassandraAdminOperations

Parameters:

tableName - The name of the table.

dropUserType

public void dropUserType(CqlIdentifier typeName)

Description copied from interface: CassandraAdminOperations

Drops a user type.

Specified by:

dropUserType in interface CassandraAdminOperations

Parameters:

typeName - must not be null.

getTableMetadata

public com.datastax.driver.core.TableMetadata getTableMetadata(String keyspace,
                                                               CqlIdentifier tableName)

Description copied from interface: CassandraAdminOperations

Lookup TableMetadata.

Specified by:

getTableMetadata in interface CassandraAdminOperations

Parameters:

keyspace - must not be empty or null.

tableName - must not be null.

Returns:

the TableMetadata or null.

getKeyspaceMetadata

public com.datastax.driver.core.KeyspaceMetadata getKeyspaceMetadata()

Description copied from interface: CassandraAdminOperations

Returns KeyspaceMetadata for the current keyspace.

Specified by:

getKeyspaceMetadata in interface CassandraAdminOperations

Returns:

KeyspaceMetadata for the current keyspace.