org.springframework.data.cassandra.core

Interface CassandraAdminOperations

All Superinterfaces:

CassandraOperations, ExecutableDeleteOperation, ExecutableInsertOperation, ExecutableSelectOperation, ExecutableUpdateOperation, FluentCassandraOperations

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

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.data.cassandra.core.ExecutableSelectOperation

ExecutableSelectOperation.ExecutableSelect<T>, ExecutableSelectOperation.SelectWithProjection<T>, ExecutableSelectOperation.SelectWithQuery<T>, ExecutableSelectOperation.SelectWithTable<T>, ExecutableSelectOperation.TerminatingSelect<T>

Nested classes/interfaces inherited from interface org.springframework.data.cassandra.core.ExecutableInsertOperation

ExecutableInsertOperation.ExecutableInsert<T>, ExecutableInsertOperation.InsertWithOptions<T>, ExecutableInsertOperation.InsertWithTable<T>, ExecutableInsertOperation.TerminatingInsert<T>

Nested classes/interfaces inherited from interface org.springframework.data.cassandra.core.ExecutableUpdateOperation

ExecutableUpdateOperation.ExecutableUpdate, ExecutableUpdateOperation.TerminatingUpdate, ExecutableUpdateOperation.UpdateWithQuery, ExecutableUpdateOperation.UpdateWithTable

Nested classes/interfaces inherited from interface org.springframework.data.cassandra.core.ExecutableDeleteOperation

ExecutableDeleteOperation.DeleteWithQuery, ExecutableDeleteOperation.DeleteWithTable, ExecutableDeleteOperation.ExecutableDelete, ExecutableDeleteOperation.TerminatingDelete

Method Summary

Modifier and Type	Method and Description
void	createTable(boolean ifNotExists, com.datastax.oss.driver.api.core.CqlIdentifier tableName, Class<?> entityClass, Map<String,Object> optionsByName) Create a table with the name given and fields corresponding to the given class.
void	dropTable(boolean ifExists, com.datastax.oss.driver.api.core.CqlIdentifier tableName) Drops the named table.
void	dropTable(Class<?> entityType) Drops a table based on the given entity type.
void	dropTable(com.datastax.oss.driver.api.core.CqlIdentifier tableName) Drops the named table.
void	dropUserType(com.datastax.oss.driver.api.core.CqlIdentifier typeName) Drops a user type.
com.datastax.oss.driver.api.core.metadata.schema.KeyspaceMetadata	getKeyspaceMetadata() Returns KeyspaceMetadata for the current keyspace.
SchemaFactory	getSchemaFactory()
Optional<com.datastax.oss.driver.api.core.metadata.schema.TableMetadata>	getTableMetadata(com.datastax.oss.driver.api.core.CqlIdentifier keyspace, com.datastax.oss.driver.api.core.CqlIdentifier tableName) Lookup TableMetadata.
default Optional<com.datastax.oss.driver.api.core.metadata.schema.TableMetadata>	getTableMetadata(String keyspace, com.datastax.oss.driver.api.core.CqlIdentifier tableName) Lookup TableMetadata.

Methods inherited from interface org.springframework.data.cassandra.core.CassandraOperations

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

Methods inherited from interface org.springframework.data.cassandra.core.ExecutableSelectOperation

query

Methods inherited from interface org.springframework.data.cassandra.core.ExecutableInsertOperation

insert

Methods inherited from interface org.springframework.data.cassandra.core.ExecutableUpdateOperation

update

Methods inherited from interface org.springframework.data.cassandra.core.ExecutableDeleteOperation

delete

Method Detail

getSchemaFactory

SchemaFactory getSchemaFactory()

Returns:

the SchemaFactory.

Since:

3.0

createTable

void createTable(boolean ifNotExists,
                 com.datastax.oss.driver.api.core.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.

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

void dropTable(Class<?> entityType)

Drops a table based on the given entity type. The name of the table is derived from either the simple name of the entity class or name of the table specified with the Table mapping annotation.

Parameters:

entityType - type of the entity for which the table will be dropped.

dropTable

void dropTable(com.datastax.oss.driver.api.core.CqlIdentifier tableName)

Drops the named table.

Parameters:

tableName - Name of the table to drop.

See Also:

dropTable(boolean, CqlIdentifier)

dropTable

void dropTable(boolean ifExists,
               com.datastax.oss.driver.api.core.CqlIdentifier tableName)

Drops the named table.

Parameters:

ifExists - If true, will only drop the table if it exists, else the drop operation will be ignored.

tableName - Name of the table to drop.

Since:

2.1

dropUserType

void dropUserType(com.datastax.oss.driver.api.core.CqlIdentifier typeName)

Drops a user type.

Parameters:

typeName - must not be null.

Since:

1.5

getKeyspaceMetadata

com.datastax.oss.driver.api.core.metadata.schema.KeyspaceMetadata getKeyspaceMetadata()

Returns KeyspaceMetadata for the current keyspace.

Returns:

KeyspaceMetadata for the current keyspace.

Since:

1.5

getTableMetadata

default Optional<com.datastax.oss.driver.api.core.metadata.schema.TableMetadata> getTableMetadata(String keyspace,
                                                                                                  com.datastax.oss.driver.api.core.CqlIdentifier tableName)

Lookup TableMetadata.

Parameters:

keyspace - must not be empty or null.

tableName - must not be null.

Returns:

the TableMetadata or null.

getTableMetadata

Optional<com.datastax.oss.driver.api.core.metadata.schema.TableMetadata> getTableMetadata(com.datastax.oss.driver.api.core.CqlIdentifier keyspace,
                                                                                          com.datastax.oss.driver.api.core.CqlIdentifier tableName)

Lookup TableMetadata.

Parameters:

keyspace - must not be null.

tableName - must not be null.

Returns:

the TableMetadata or null.

Since:

3.0