org.springframework.data.cassandra.core

Class CassandraAdminTemplate

java.lang.Object

org.springframework.data.cassandra.core.CassandraTemplate

org.springframework.data.cassandra.core.CassandraAdminTemplate

All Implemented Interfaces:

CassandraAdminOperations, CassandraOperations

public class CassandraAdminTemplate
extends CassandraTemplate
implements CassandraAdminOperations

Default implementation of CassandraAdminOperations.

Author:

Mark Paluch, Fabio J. Mendes, John Blum

Constructor Summary

Constructors

Constructor and Description
CassandraAdminTemplate(com.datastax.driver.core.Session session, CassandraConverter converter) Constructor used for a basic template configuration.
CassandraAdminTemplate(SessionFactory sessionFactory, CassandraConverter converter) Constructor used for a basic template configuration.

Method Summary

Modifier and Type	Method and Description
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(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.
Optional<com.datastax.driver.core.TableMetadata>	getTableMetadata(String keyspace, CqlIdentifier tableName) Lookup TableMetadata.

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

batchOps, count, delete, delete, delete, deleteById, exists, getConverter, getCqlOperations, getMappingContext, getStatementFactory, getTableName, insert, insert, select, select, select, selectOne, selectOne, selectOne, selectOneById, slice, slice, stream, stream, stream, truncate, update, update, update

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, deleteById, exists, getConverter, getCqlOperations, getTableName, insert, insert, select, select, select, selectOne, selectOne, selectOne, selectOneById, slice, slice, stream, stream, stream, truncate, update, update, update

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.

CassandraAdminTemplate

public CassandraAdminTemplate(SessionFactory sessionFactory,
                              CassandraConverter converter)

Constructor used for a basic template configuration.

Parameters:

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

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