org.springframework.cassandra.core.keyspace

Class CreateTableSpecification

java.lang.Object

org.springframework.cassandra.core.keyspace.TableNameSpecification<TableOptionsSpecification<T>>

org.springframework.cassandra.core.keyspace.TableOptionsSpecification<TableSpecification<T>>

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

org.springframework.cassandra.core.keyspace.CreateTableSpecification

All Implemented Interfaces:

TableDescriptor

public class CreateTableSpecification
extends TableSpecification<CreateTableSpecification>

Builder class to construct a CREATE TABLE specification.

Author:

Matthew T. Adams

Field Summary

Fields inherited from class org.springframework.cassandra.core.keyspace.TableOptionsSpecification

options

Constructor Summary

Constructors

Constructor and Description
CreateTableSpecification()

Method Summary

Modifier and Type	Method and Description
static CreateTableSpecification	createTable() Entry point into the CreateTableSpecification's fluent API to create a table.
static CreateTableSpecification	createTable(CqlIdentifier name) Entry point into the CreateTableSpecification's fluent API to create a table.
static CreateTableSpecification	createTable(String name) Entry point into the CreateTableSpecification's fluent API 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	name(CqlIdentifier name)
CreateTableSpecification	name(String name) Sets the table name.
CreateTableSpecification	with(String name, 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(option, null).
CreateTableSpecification	with(TableOption option, Object value) Sets the given table option.

Methods inherited from class org.springframework.cassandra.core.keyspace.TableSpecification

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

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

getOptions

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

getName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.cassandra.core.keyspace.TableDescriptor

getName, getOptions

Constructor Detail

CreateTableSpecification

public CreateTableSpecification()

Method Detail

createTable

public static CreateTableSpecification createTable()

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

createTable

public static CreateTableSpecification createTable(CqlIdentifier name)

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

createTable

public static CreateTableSpecification createTable(String name)

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

name

public CreateTableSpecification name(CqlIdentifier name)

Overrides:

name in class TableOptionsSpecification<TableSpecification<CreateTableSpecification>>

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()

name

public CreateTableSpecification name(String name)

Description copied from class: TableNameSpecification

Sets the table name.

Overrides:

name in class TableOptionsSpecification<TableSpecification<CreateTableSpecification>>

Returns:

this

with

public CreateTableSpecification with(TableOption option)

Description copied from class: TableOptionsSpecification

Convenience method that calls with(option, null).

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,
                                     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