org.springframework.data.cassandra.core

Interface CassandraAdminOperations

All Superinterfaces:

CassandraOperations, CqlOperations

All Known Implementing Classes:

CassandraAdminTemplate

public interface CassandraAdminOperations
extends CassandraOperations

Operations for managing a Cassandra keyspace.

Author:

David Webb, Matthew T. Adams, Mark Paluch, Fabio J. Mendes

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

Method Detail

createTable

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

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

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

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.

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

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

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.

dropTable

void dropTable(CqlIdentifier tableName)

Drops the named table.

Parameters:

tableName - The name of the table.

getTableMetadata

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

Lookup TableMetadata.

Parameters:

keyspace - must not be empty or null.

tableName - must not be null.

Returns:

the TableMetadata or null.

getKeyspaceMetadata

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

Returns KeyspaceMetadata for the current keyspace.

Returns:

KeyspaceMetadata for the current keyspace.

Since:

1.5

dropUserType

void dropUserType(CqlIdentifier typeName)

Drops a user type.

Parameters:

typeName - must not be null.

Since:

1.5