Class CreateTableSpecification

java.lang.Object

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

org.springframework.data.cassandra.core.cql.keyspace.TableOptionsSpecification<TableSpecification<CreateTableSpecification>>

org.springframework.data.cassandra.core.cql.keyspace.TableSpecification<CreateTableSpecification>

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

All Implemented Interfaces:

CqlSpecification, TableDescriptor

public class CreateTableSpecification
extends TableSpecification<CreateTableSpecification>
implements CqlSpecification

Object to configure a CREATE TABLE specification.

Author:

Matthew T. Adams, Mark Paluch

Method Summary

Modifier and Type	Method	Description
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.
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(String tableName)	Entry point into the CreateTableSpecification's fluent API given tableName to create a table.
boolean	getIfNotExists()
CreateTableSpecification	ifNotExists()	Causes the inclusion of an IF NOT EXISTS clause.
CreateTableSpecification	ifNotExists(boolean ifNotExists)	Toggles the inclusion of an IF NOT EXISTS clause.
CreateTableSpecification	with(String name, @Nullable Object value)	Adds the given option by name to this table's options.
CreateTableSpecification	with(String name, @Nullable Object value, boolean escape, boolean quote)	Adds the given option by name to this table's options.
CreateTableSpecification	with(TableOption option)	Convenience method that calls #with(TableOption, null) or #with(TableOption, true) if the option requires a boolean value.
CreateTableSpecification	with(TableOption option, Object value)	Sets the given table option.

Methods inherited from class TableSpecification

clusteredKeyColumn, clusteredKeyColumn, clusteredKeyColumn, clusteredKeyColumn, clusteredKeyColumn, column, column, column, column, column, column, getClusteredKeyColumns, getColumns, getNonKeyColumns, getPartitionKeyColumns, getPrimaryKeyColumns, getStaticColumns, partitionKeyColumn, partitionKeyColumn, staticColumn, staticColumn

Methods inherited from class TableOptionsSpecification

getOptions

Methods inherited from class TableNameSpecification

getKeyspace, getName

Methods inherited from class Object

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

Methods inherited from interface TableDescriptor

getName, getOptions

Method Details

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(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 null, then the table name is prefixed with keyspace.

Parameters:

keyspace - can be null.

tableName - must not be null.

Returns:

a new CreateTableSpecification.

Since:

4.4

ifNotExists

public CreateTableSpecification ifNotExists()

Causes the inclusion of an IF NOT EXISTS clause.

Returns:

this

ifNotExists

public CreateTableSpecification ifNotExists(boolean ifNotExists)

Toggles the inclusion of an IF NOT EXISTS clause.

Returns:

this

getIfNotExists

public boolean getIfNotExists()

with

public CreateTableSpecification with(TableOption option)

Description copied from class: TableOptionsSpecification

Convenience method that calls #with(TableOption, null) or #with(TableOption, true) if the option requires a boolean value.

Overrides:

with in class TableOptionsSpecification<TableSpecification<CreateTableSpecification>>

Returns:

this

with

public CreateTableSpecification with(TableOption option,
 Object value)

Description copied from class: TableOptionsSpecification

Sets the given table option. This is a convenience method that calls TableOptionsSpecification.with(String, Object, boolean, boolean) appropriately from the given TableOption and value for that option.

Overrides:

with in class TableOptionsSpecification<TableSpecification<CreateTableSpecification>>

Parameters:

option - the option to set.

value - the value of the option. Must be type-compatible with the TableOption.

Returns:

this

See Also:

• TableOptionsSpecification.with(String, Object, boolean, boolean)

with

public CreateTableSpecification with(String name,
 @Nullable Object value)

Description copied from class: TableOptionsSpecification

Adds the given option by name to this table's options.

Options that have null values are considered single string options where the name of the option is the string to be used. Otherwise, the result of Object.toString() is considered to be the value of the option with the given name. Values that require escaping or quoting should be handled by the specification must be either quoted and escaped already or provided through TableOptionsSpecification.with(String, Object, boolean, boolean).

Overrides:

with in class TableOptionsSpecification<TableSpecification<CreateTableSpecification>>

Parameters:

name - the name of the option

value - the value of the option. If null, the value is ignored and the option is considered to be composed of only the name, otherwise the value's Object.toString() value is used.

Returns:

this

with

public CreateTableSpecification with(String name,
 @Nullable Object value,
 boolean escape,
 boolean quote)

Description copied from class: TableOptionsSpecification

Adds the given option by name to this table's options.

Options that have null values are considered single string options where the name of the option is the string to be used. Otherwise, the result of Object.toString() is considered to be the value of the option with the given name. The value, after conversion to string, may have embedded single quotes escaped according to parameter escape and may be single-quoted according to parameter quote.

Overrides:

with in class TableOptionsSpecification<TableSpecification<CreateTableSpecification>>

Parameters:

name - the name of the option

value - the value of the option. If null, the value is ignored and the option is considered to be composed of only the name, otherwise the value's Object.toString() value is used.

escape - whether to escape the value via CqlStringUtils.escapeSingle(Object). Ignored if given value is an instance of a Map.

quote - whether to quote the value via CqlStringUtils.singleQuote(Object). Ignored if given value is an instance of a Map.

Returns:

this