org.springframework.data.cassandra.core.cql.keyspace

Class AlterTableSpecification

java.lang.Object

org.springframework.data.cassandra.core.cql.keyspace.TableNameSpecification

org.springframework.data.cassandra.core.cql.keyspace.TableOptionsSpecification<AlterTableSpecification>

org.springframework.data.cassandra.core.cql.keyspace.AlterTableSpecification

public class AlterTableSpecification
extends TableOptionsSpecification<AlterTableSpecification>

Object to configure a ALTER TABLE specification.

Author:

Matthew T. Adams, Mark Paluch

See Also:

AddColumnSpecification, AlterColumnSpecification, DropColumnSpecification, RenameColumnSpecification, CreateTableSpecification, DropTableSpecification, TableOptionsSpecification, AlterTableCqlGenerator

Method Summary

Modifier and Type	Method and Description
AlterTableSpecification	add(com.datastax.oss.driver.api.core.CqlIdentifier column, com.datastax.oss.driver.api.core.type.DataType type) Adds an ADD to the list of column changes.
AlterTableSpecification	add(String column, com.datastax.oss.driver.api.core.type.DataType type) Adds an ADD to the list of column changes.
AlterTableSpecification	alter(com.datastax.oss.driver.api.core.CqlIdentifier column, com.datastax.oss.driver.api.core.type.DataType type) Adds an ALTER to the list of column changes.
AlterTableSpecification	alter(String column, com.datastax.oss.driver.api.core.type.DataType type) Adds an ALTER to the list of column changes.
static AlterTableSpecification	alterTable(com.datastax.oss.driver.api.core.CqlIdentifier tableName) Entry point into the AlterTableSpecification's fluent API given tableName to alter a table.
static AlterTableSpecification	alterTable(String tableName) Entry point into the AlterTableSpecification's fluent API given tableName to alter a table.
AlterTableSpecification	drop(com.datastax.oss.driver.api.core.CqlIdentifier column)
AlterTableSpecification	drop(String column)
List<ColumnChangeSpecification>	getChanges() Returns an unmodifiable list of column changes.
AlterTableSpecification	rename(com.datastax.oss.driver.api.core.CqlIdentifier from, com.datastax.oss.driver.api.core.CqlIdentifier to) Adds a RENAME to the list of column changes.
AlterTableSpecification	rename(String from, String to) Adds a RENAME to the list of column changes.

Methods inherited from class org.springframework.data.cassandra.core.cql.keyspace.TableOptionsSpecification

getOptions, with, with, with

Methods inherited from class org.springframework.data.cassandra.core.cql.keyspace.TableNameSpecification

getName

Methods inherited from class java.lang.Object

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

Method Detail

alterTable

public static AlterTableSpecification alterTable(String tableName)

Entry point into the AlterTableSpecification's fluent API given tableName to alter a table. Convenient if imported statically.

Parameters:

tableName - must not be null or empty.

Returns:

a new AlterTableSpecification.

alterTable

public static AlterTableSpecification alterTable(com.datastax.oss.driver.api.core.CqlIdentifier tableName)

Entry point into the AlterTableSpecification's fluent API given tableName to alter a table. Convenient if imported statically.

Parameters:

tableName - must not be null.

Returns:

a new AlterTableSpecification.

add

public AlterTableSpecification add(String column,
                                   com.datastax.oss.driver.api.core.type.DataType type)

Adds an ADD to the list of column changes.

Parameters:

column - must not be null or empty.

type - must not be null.

Returns:

this AlterTableSpecification.

add

public AlterTableSpecification add(com.datastax.oss.driver.api.core.CqlIdentifier column,
                                   com.datastax.oss.driver.api.core.type.DataType type)

Adds an ADD to the list of column changes.

Parameters:

column - must not be null.

type - must not be null.

Returns:

this AlterTableSpecification.

Since:

2.0

drop

public AlterTableSpecification drop(String column)

drop

public AlterTableSpecification drop(com.datastax.oss.driver.api.core.CqlIdentifier column)

rename

public AlterTableSpecification rename(String from,
                                      String to)

Adds a RENAME to the list of column changes.

Parameters:

from - must not be null or empty.

to - must not be null or empty.

Returns:

this AlterTableSpecification.

rename

public AlterTableSpecification rename(com.datastax.oss.driver.api.core.CqlIdentifier from,
                                      com.datastax.oss.driver.api.core.CqlIdentifier to)

Adds a RENAME to the list of column changes.

Parameters:

from - must not be null.

to - must not be null.

Returns:

this AlterTableSpecification.

Since:

2.0

alter

public AlterTableSpecification alter(String column,
                                     com.datastax.oss.driver.api.core.type.DataType type)

Adds an ALTER to the list of column changes.

Parameters:

column - must not be null or empty

type - must not be null

Returns:

this AlterTableSpecification.

alter

public AlterTableSpecification alter(com.datastax.oss.driver.api.core.CqlIdentifier column,
                                     com.datastax.oss.driver.api.core.type.DataType type)

Adds an ALTER to the list of column changes.

Parameters:

column - must not be null.

type - must not be null.

Returns:

this AlterTableSpecification.

Since:

2.0

getChanges

public List<ColumnChangeSpecification> getChanges()

Returns an unmodifiable list of column changes.