Module spring.data.cassandra

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

Class SpecificationBuilder

java.lang.Object

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

public final class SpecificationBuilder
extends Object

Entrypoint to create CQL specifications to add, alter and delete CQL objects such as tables and index.

Specifications can be rendered to CQL using CqlGenerator.toCql(CqlSpecification) for direct usage with the database.

Since:

4.4

Author:

Mark Paluch

See Also:

• CqlGenerator

Method Summary

Modifier and Type	Method	Description
static AddColumnSpecification	addColumn(com.datastax.oss.driver.api.core.CqlIdentifier name, com.datastax.oss.driver.api.core.type.DataType type)	Create a new AddColumnSpecification for the given name and DataType.
static AddColumnSpecification	addColumn(String name, com.datastax.oss.driver.api.core.type.DataType type)	Create a new AddColumnSpecification for the given name and DataType.
static AlterColumnSpecification	alterColumn(com.datastax.oss.driver.api.core.CqlIdentifier name, com.datastax.oss.driver.api.core.type.DataType type)	Entry point into the AlterColumnSpecification's fluent API given name and DataType to alter a column.
static AlterColumnSpecification	alterColumn(String name, com.datastax.oss.driver.api.core.type.DataType type)	Entry point into the AlterColumnSpecification's fluent API given name and DataType to alter a column.
static AlterKeyspaceSpecification	alterKeyspace(com.datastax.oss.driver.api.core.CqlIdentifier name)	Entry point into the AlterKeyspaceSpecification's fluent API given name to alter a keyspace.
static AlterKeyspaceSpecification	alterKeyspace(String name)	Entry point into the AlterKeyspaceSpecification's fluent API given name to alter a keyspace.
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(com.datastax.oss.driver.api.core.CqlIdentifier keyspace, 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.
static AlterTableSpecification	alterTable(String keyspace, String tableName)	Entry point into the AlterTableSpecification's fluent API given tableName to alter a table.
static AlterUserTypeSpecification	alterType(String typeName)	Entry point into the AlterColumnSpecification's fluent API given typeName to alter a user type.
static CreateIndexSpecification	createIndex()	Entry point into the CreateIndexSpecification's fluent API to create an index.
static CreateIndexSpecification	createIndex(com.datastax.oss.driver.api.core.CqlIdentifier indexName)	Entry point into the CreateIndexSpecification's fluent API given indexName to create an index.
static CreateIndexSpecification	createIndex(com.datastax.oss.driver.api.core.CqlIdentifier keyspace, com.datastax.oss.driver.api.core.CqlIdentifier indexName)	Entry point into the CreateIndexSpecification's fluent API given keyspace and indexName to create an index.
static CreateIndexSpecification	createIndex(String indexName)	Entry point into the CreateIndexSpecification's fluent API given indexName to create an index.
static CreateIndexSpecification	createIndex(String keyspace, String indexName)	Entry point into the CreateIndexSpecification's fluent API given indexName to create an index.
static CreateKeyspaceSpecification	createKeyspace(com.datastax.oss.driver.api.core.CqlIdentifier name)	Entry point into the CreateKeyspaceSpecification's fluent API given name to create a keyspace.
static CreateKeyspaceSpecification	createKeyspace(String name)	Entry point into the CreateKeyspaceSpecification's fluent API given name to create a keyspace.
static CreateTableSpecification	createTable(com.datastax.oss.driver.api.core.CqlIdentifier tableName)	Entry point into the CreateTableSpecification's fluent API given tableName to create a table.
static CreateTableSpecification	createTable(com.datastax.oss.driver.api.core.CqlIdentifier keyspace, com.datastax.oss.driver.api.core.CqlIdentifier tableName)	Entry point into the CreateTableSpecification's fluent API given tableName to create a table.
static CreateTableSpecification	createTable(String tableName)	Entry point into the CreateTableSpecification's fluent API given tableName to create a table.
static CreateTableSpecification	createTable(String keyspace, String tableName)	Entry point into the CreateTableSpecification's fluent API given tableName to create a table.
static CreateUserTypeSpecification	createType(com.datastax.oss.driver.api.core.CqlIdentifier name)	Entry point into the CreateUserTypeSpecification's fluent API given typeName to create a type.
static CreateUserTypeSpecification	createType(com.datastax.oss.driver.api.core.CqlIdentifier keyspace, com.datastax.oss.driver.api.core.CqlIdentifier name)	Entry point into the CreateUserTypeSpecification's fluent API given typeName to create a type.
static CreateUserTypeSpecification	createType(String typeName)	Entry point into the CreateUserTypeSpecification's fluent API given name to create a type.
static CreateUserTypeSpecification	createType(String keyspace, String typeName)	Entry point into the CreateUserTypeSpecification's fluent API given name to create a type.
static DropColumnSpecification	dropColumn(com.datastax.oss.driver.api.core.CqlIdentifier name)	Create a new DropColumnSpecification for the given name.
static DropColumnSpecification	dropColumn(String name)	Create a new DropColumnSpecification for the given name.
static DropIndexSpecification	dropIndex(com.datastax.oss.driver.api.core.CqlIdentifier indexName)	Create a new DropIndexSpecification for the given indexName.
static DropIndexSpecification	dropIndex(com.datastax.oss.driver.api.core.CqlIdentifier keyspace, com.datastax.oss.driver.api.core.CqlIdentifier indexName)	Create a new DropIndexSpecification for the given indexName.
static DropIndexSpecification	dropIndex(String indexName)	Create a new DropIndexSpecification for the given indexName.
static DropIndexSpecification	dropIndex(String keyspace, String indexName)	Create a new DropIndexSpecification for the given indexName.
static DropKeyspaceSpecification	dropKeyspace(com.datastax.oss.driver.api.core.CqlIdentifier name)	Create a new DropKeyspaceSpecification for the given name.
static DropKeyspaceSpecification	dropKeyspace(String name)	Create a new DropKeyspaceSpecification for the given name.
static DropTableSpecification	dropTable(com.datastax.oss.driver.api.core.CqlIdentifier tableName)	Entry point into the DropTableSpecification's fluent API given tableName to drop a table.
static DropTableSpecification	dropTable(com.datastax.oss.driver.api.core.CqlIdentifier keyspace, com.datastax.oss.driver.api.core.CqlIdentifier tableName)	Entry point into the DropTableSpecification's fluent API given tableName to drop a table.
static DropTableSpecification	dropTable(String tableName)	Entry point into the DropTableSpecification's fluent API tableName to drop a table.
static DropTableSpecification	dropTable(String keyspace, String tableName)	Entry point into the DropTableSpecification's fluent API given tableName to drop a table.
static DropUserTypeSpecification	dropType(com.datastax.oss.driver.api.core.CqlIdentifier typeName)	Entry point into the DropUserTypeSpecification's fluent API given typeName to drop a type.
static DropUserTypeSpecification	dropType(com.datastax.oss.driver.api.core.CqlIdentifier keyspace, com.datastax.oss.driver.api.core.CqlIdentifier typeName)	Entry point into the DropUserTypeSpecification's fluent API given typeName to drop a type.
static DropUserTypeSpecification	dropType(String typeName)	Entry point into the DropUserTypeSpecification's fluent API given typeName to drop a type.
static DropUserTypeSpecification	dropType(String keyspace, String typeName)	Entry point into the DropUserTypeSpecification's fluent API given typeName to drop a type.

Methods inherited from class java.lang.Object

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

Method Details

createKeyspace

public static CreateKeyspaceSpecification createKeyspace(String name)

Entry point into the CreateKeyspaceSpecification's fluent API given name to create a keyspace. Convenient if imported statically.

Parameters:

name - must not be null or empty.

Returns:

a new CreateKeyspaceSpecification.

createKeyspace

public static CreateKeyspaceSpecification createKeyspace(com.datastax.oss.driver.api.core.CqlIdentifier name)

Entry point into the CreateKeyspaceSpecification's fluent API given name to create a keyspace. Convenient if imported statically.

Parameters:

name - must not be null.

Returns:

a new CreateKeyspaceSpecification.

alterKeyspace

public static AlterKeyspaceSpecification alterKeyspace(String name)

Entry point into the AlterKeyspaceSpecification's fluent API given name to alter a keyspace. Convenient if imported statically.

Parameters:

name - must not be null or empty.

Returns:

a new AlterKeyspaceSpecification.

alterKeyspace

public static AlterKeyspaceSpecification alterKeyspace(com.datastax.oss.driver.api.core.CqlIdentifier name)

Entry point into the AlterKeyspaceSpecification's fluent API given name to alter a keyspace. Convenient if imported statically.

Parameters:

name - must not be null or empty.

Returns:

a new AlterKeyspaceSpecification.

dropKeyspace

public static DropKeyspaceSpecification dropKeyspace(String name)

Create a new DropKeyspaceSpecification for the given name.

Parameters:

name - must not be null or empty.

Returns:

a new DropKeyspaceSpecification.

dropKeyspace

public static DropKeyspaceSpecification dropKeyspace(com.datastax.oss.driver.api.core.CqlIdentifier name)

Create a new DropKeyspaceSpecification for the given name.

Parameters:

name - must not be null.

Returns:

a new DropKeyspaceSpecification.

createTable

public static CreateTableSpecification createTable(String tableName)

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

Parameters:

tableName - must not be null or empty.

Returns:

a new CreateTableSpecification.

createTable

public static CreateTableSpecification createTable(@Nullable
 String keyspace,
 String tableName)

Entry point into the CreateTableSpecification's fluent API given tableName to create a table. Convenient if imported statically. Uses the default keyspace if keyspace is null; otherwise, of the keyspace is not {@link null}, then the table name is prefixed with keyspace.

Parameters:

keyspace - can be null.

tableName - must not be null.

Returns:

a new CreateTableSpecification.

createTable

public static CreateTableSpecification createTable(com.datastax.oss.driver.api.core.CqlIdentifier tableName)

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

Parameters:

tableName - must not be null.

Returns:

a new CreateTableSpecification.

createTable

public static CreateTableSpecification createTable(@Nullable
 com.datastax.oss.driver.api.core.CqlIdentifier keyspace,
 com.datastax.oss.driver.api.core.CqlIdentifier tableName)

Entry point into the CreateTableSpecification's fluent API given tableName to create a table. Convenient if imported statically. Uses the default keyspace if keyspace is null; otherwise, of the keyspace is not {@link null}, then the table name is prefixed with keyspace.

Parameters:

keyspace - can be null.

tableName - must not be null.

Returns:

a new CreateTableSpecification.

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(@Nullable
 String keyspace,
 String tableName)

Entry point into the AlterTableSpecification's fluent API given tableName to alter a table. Convenient if imported statically. Uses the default keyspace if keyspace is null; otherwise, of the keyspace is not {@link null}, then the table name is prefixed with keyspace.

Parameters:

keyspace - can be null.

tableName - must not be null.

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.

alterTable

public static AlterTableSpecification alterTable(@Nullable
 com.datastax.oss.driver.api.core.CqlIdentifier keyspace,
 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. Uses the default keyspace if keyspace is null; otherwise, of the keyspace is not {@link null}, then the table name is prefixed with keyspace.

Parameters:

keyspace - can be null.

tableName - must not be null.

Returns:

a new AlterTableSpecification.

dropTable

public static DropTableSpecification dropTable(String tableName)

Entry point into the DropTableSpecification's fluent API tableName to drop a table. Convenient if imported statically.

Parameters:

tableName - must not be null or empty.

Returns:

a new DropTableSpecification.

dropTable

public static DropTableSpecification dropTable(@Nullable
 String keyspace,
 String tableName)

Entry point into the DropTableSpecification's fluent API given tableName to drop a table. Convenient if imported statically. Uses the default keyspace if keyspace is null; otherwise, of the keyspace is not {@link null}, then the table name is prefixed with keyspace.

Parameters:

keyspace - can be null.

tableName - must not be null.

Returns:

a new DropTableSpecification.

dropTable

public static DropTableSpecification dropTable(com.datastax.oss.driver.api.core.CqlIdentifier tableName)

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

Parameters:

tableName - must not be null.

Returns:

a new DropTableSpecification.

dropTable

public static DropTableSpecification dropTable(@Nullable
 com.datastax.oss.driver.api.core.CqlIdentifier keyspace,
 com.datastax.oss.driver.api.core.CqlIdentifier tableName)

Entry point into the DropTableSpecification's fluent API given tableName to drop a table. Convenient if imported statically. Uses the default keyspace if keyspace is null; otherwise, of the keyspace is not {@link null}, then the table name is prefixed with keyspace.

Parameters:

keyspace - can be null.

tableName - must not be null.

Returns:

a new DropTableSpecification.

addColumn

public static AddColumnSpecification addColumn(String name,
 com.datastax.oss.driver.api.core.type.DataType type)

Create a new AddColumnSpecification for the given name and DataType.

Parameters:

name - must not be null or empty.

type - must not be null.

Returns:

a new AddColumnSpecification.

addColumn

public static AddColumnSpecification addColumn(com.datastax.oss.driver.api.core.CqlIdentifier name,
 com.datastax.oss.driver.api.core.type.DataType type)

Create a new AddColumnSpecification for the given name and DataType.

Parameters:

name - must not be null.

type - must not be null.

Returns:

a new AddColumnSpecification.

alterColumn

public static AlterColumnSpecification alterColumn(String name,
 com.datastax.oss.driver.api.core.type.DataType type)

Entry point into the AlterColumnSpecification's fluent API given name and DataType to alter a column. Convenient if imported statically.

Parameters:

name - must not be null or empty.

type - must not be null.

Returns:

a new AlterColumnSpecification.

alterColumn

public static AlterColumnSpecification alterColumn(com.datastax.oss.driver.api.core.CqlIdentifier name,
 com.datastax.oss.driver.api.core.type.DataType type)

Entry point into the AlterColumnSpecification's fluent API given name and DataType to alter a column. Convenient if imported statically.

Parameters:

name - must not be null.

type - must not be null.

Returns:

a new AlterColumnSpecification.

dropColumn

public static DropColumnSpecification dropColumn(String name)

Create a new DropColumnSpecification for the given name.

Parameters:

name - must not be null or empty.

dropColumn

public static DropColumnSpecification dropColumn(com.datastax.oss.driver.api.core.CqlIdentifier name)

Create a new DropColumnSpecification for the given name.

Parameters:

name - must not be null or empty.

createIndex

public static CreateIndexSpecification createIndex()

Entry point into the CreateIndexSpecification's fluent API to create an index. Convenient if imported statically.

createIndex

public static CreateIndexSpecification createIndex(String indexName)

Entry point into the CreateIndexSpecification's fluent API given indexName to create an index. Convenient if imported statically.

Parameters:

indexName - must not be null or empty.

Returns:

a new CreateIndexSpecification.

createIndex

public static CreateIndexSpecification createIndex(@Nullable
 String keyspace,
 String indexName)

Entry point into the CreateIndexSpecification's fluent API given indexName to create an index. Convenient if imported statically.

Parameters:

indexName - must not be null or empty.

Returns:

a new CreateIndexSpecification.

createIndex

public static CreateIndexSpecification createIndex(com.datastax.oss.driver.api.core.CqlIdentifier indexName)

Entry point into the CreateIndexSpecification's fluent API given indexName to create an index. Convenient if imported statically.

Parameters:

indexName - must not be null.

Returns:

a new CreateIndexSpecification.

createIndex

public static CreateIndexSpecification createIndex(@Nullable
 com.datastax.oss.driver.api.core.CqlIdentifier keyspace,
 @Nullable
 com.datastax.oss.driver.api.core.CqlIdentifier indexName)

Entry point into the CreateIndexSpecification's fluent API given keyspace and indexName to create an index. Convenient if imported statically. Uses the default keyspace if keyspace is null; otherwise, of the keyspace is not {@link null}, then the index and table name are prefixed with keyspace.

Parameters:

keyspace - can be null.

indexName - can be null.

Returns:

a new CreateIndexSpecification.

dropIndex

public static DropIndexSpecification dropIndex(String indexName)

Create a new DropIndexSpecification for the given indexName.

Parameters:

indexName - must not be null or empty.

Returns:

a new DropIndexSpecification.

dropIndex

public static DropIndexSpecification dropIndex(@Nullable
 String keyspace,
 String indexName)

Create a new DropIndexSpecification for the given indexName. Uses the default keyspace if keyspace is null; otherwise, of the keyspace is not {@link null}, then the index name is prefixed with keyspace.

Parameters:

keyspace - can be null.

indexName - must not be null.

Returns:

a new DropIndexSpecification.

dropIndex

public static DropIndexSpecification dropIndex(com.datastax.oss.driver.api.core.CqlIdentifier indexName)

Create a new DropIndexSpecification for the given indexName.

Parameters:

indexName - must not be null.

Returns:

a new DropIndexSpecification.

dropIndex

public static DropIndexSpecification dropIndex(@Nullable
 com.datastax.oss.driver.api.core.CqlIdentifier keyspace,
 com.datastax.oss.driver.api.core.CqlIdentifier indexName)

Create a new DropIndexSpecification for the given indexName. Uses the default keyspace if keyspace is null; otherwise, of the keyspace is not {@link null}, then the index name is prefixed with keyspace.

Parameters:

keyspace - can be null.

indexName - must not be null.

Returns:

a new DropIndexSpecification.

createType

public static CreateUserTypeSpecification createType(String typeName)

Entry point into the CreateUserTypeSpecification's fluent API given name to create a type. Convenient if imported statically.

Parameters:

typeName - must not null or empty.

Returns:

a new CreateUserTypeSpecification.

createType

public static CreateUserTypeSpecification createType(@Nullable
 String keyspace,
 String typeName)

Entry point into the CreateUserTypeSpecification's fluent API given name to create a type. Convenient if imported statically. Uses the default keyspace if keyspace is null; otherwise, of the keyspace is not {@link null}, then the UDT name is prefixed with keyspace.

Parameters:

keyspace - can be null.

typeName - must not null.

Returns:

a new CreateUserTypeSpecification.

createType

public static CreateUserTypeSpecification createType(com.datastax.oss.driver.api.core.CqlIdentifier name)

Entry point into the CreateUserTypeSpecification's fluent API given typeName to create a type. Convenient if imported statically.

Parameters:

name - must not null.

Returns:

a new CreateUserTypeSpecification.

createType

public static CreateUserTypeSpecification createType(@Nullable
 com.datastax.oss.driver.api.core.CqlIdentifier keyspace,
 com.datastax.oss.driver.api.core.CqlIdentifier name)

Entry point into the CreateUserTypeSpecification's fluent API given typeName to create a type. Convenient if imported statically. Uses the default keyspace if keyspace is null; otherwise, of the keyspace is not {@link null}, then the UDT name is prefixed with keyspace.

Parameters:

keyspace - can be null.

name - must not null.

Returns:

a new CreateUserTypeSpecification.

alterType

public static AlterUserTypeSpecification alterType(String typeName)

Entry point into the AlterColumnSpecification's fluent API given typeName to alter a user type. Convenient if imported statically.

Parameters:

typeName - must not be null or empty.

Returns:

a new AlterUserTypeSpecification.

dropType

public static DropUserTypeSpecification dropType(String typeName)

Entry point into the DropUserTypeSpecification's fluent API given typeName to drop a type. Convenient if imported statically.

Parameters:

typeName - must not be null or empty.

Returns:

a new DropUserTypeSpecification.

dropType

public static DropUserTypeSpecification dropType(@Nullable
 String keyspace,
 String typeName)

Entry point into the DropUserTypeSpecification's fluent API given typeName to drop a type. Convenient if imported statically. Uses the default keyspace if keyspace is null; otherwise, of the keyspace is not {@link null}, then the UDT name is prefixed with keyspace.

Parameters:

keyspace - can be null.

typeName - must not be null or empty.

Returns:

a new DropUserTypeSpecification.

dropType

public static DropUserTypeSpecification dropType(com.datastax.oss.driver.api.core.CqlIdentifier typeName)

Entry point into the DropUserTypeSpecification's fluent API given typeName to drop a type. Convenient if imported statically.

Parameters:

typeName - must not be null or empty.

Returns:

a new DropUserTypeSpecification.

dropType

public static DropUserTypeSpecification dropType(@Nullable
 com.datastax.oss.driver.api.core.CqlIdentifier keyspace,
 com.datastax.oss.driver.api.core.CqlIdentifier typeName)

Entry point into the DropUserTypeSpecification's fluent API given typeName to drop a type. Convenient if imported statically. Uses the default keyspace if keyspace is null; otherwise, of the keyspace is not {@link null}, then the UDT name is prefixed with keyspace.

Parameters:

keyspace - can be null.

typeName - must not be null or empty.

Returns:

a new DropUserTypeSpecification.