org.springframework.cassandra.core.keyspace

Class CreateKeyspaceSpecification

java.lang.Object

org.springframework.cassandra.core.keyspace.KeyspaceActionSpecification<KeyspaceOptionsSpecification<T>>

org.springframework.cassandra.core.keyspace.KeyspaceOptionsSpecification<KeyspaceSpecification<T>>

org.springframework.cassandra.core.keyspace.KeyspaceSpecification<CreateKeyspaceSpecification>

org.springframework.cassandra.core.keyspace.CreateKeyspaceSpecification

All Implemented Interfaces:

KeyspaceDescriptor

public class CreateKeyspaceSpecification
extends KeyspaceSpecification<CreateKeyspaceSpecification>

Field Summary

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

options

Constructor Summary

Constructors

Constructor and Description
CreateKeyspaceSpecification()
CreateKeyspaceSpecification(KeyspaceIdentifier name)
CreateKeyspaceSpecification(String name)

Method Summary

Modifier and Type	Method and Description
static CreateKeyspaceSpecification	createKeyspace() Entry point into the CreateKeyspaceSpecification's fluent API to create a keyspace.
static CreateKeyspaceSpecification	createKeyspace(KeyspaceIdentifier name) Entry point into the CreateKeyspaceSpecification's fluent API to create a keyspace.
static CreateKeyspaceSpecification	createKeyspace(String name) Entry point into the CreateKeyspaceSpecification's fluent API to create a keyspace.
boolean	getIfNotExists()
CreateKeyspaceSpecification	ifNotExists() Causes the inclusion of an IF NOT EXISTS clause.
CreateKeyspaceSpecification	ifNotExists(boolean ifNotExists) Toggles the inclusion of an IF NOT EXISTS clause.
CreateKeyspaceSpecification	name(KeyspaceIdentifier name) Sets the keyspace name.
CreateKeyspaceSpecification	name(String name) Sets the keyspace name.
CreateKeyspaceSpecification	with(KeyspaceOption option) Convenience method that calls with(option, null).
CreateKeyspaceSpecification	with(KeyspaceOption option, Object value) Sets the given table option.
CreateKeyspaceSpecification	with(String name, Object value, boolean escape, boolean quote) Adds the given option by name to this keyspaces's options.
CreateKeyspaceSpecification	withNetworkReplication(DataCenterReplication... dcrs)
CreateKeyspaceSpecification	withSimpleReplication()
CreateKeyspaceSpecification	withSimpleReplication(long replicationFactor)

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

getOptions

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

equals, getName, hashCode

Methods inherited from class java.lang.Object

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

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

getName, getOptions

Constructor Detail

CreateKeyspaceSpecification

public CreateKeyspaceSpecification()

CreateKeyspaceSpecification

public CreateKeyspaceSpecification(String name)

CreateKeyspaceSpecification

public CreateKeyspaceSpecification(KeyspaceIdentifier name)

Method Detail

createKeyspace

public static CreateKeyspaceSpecification createKeyspace()

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

createKeyspace

public static CreateKeyspaceSpecification createKeyspace(String name)

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

createKeyspace

public static CreateKeyspaceSpecification createKeyspace(KeyspaceIdentifier name)

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

ifNotExists

public CreateKeyspaceSpecification ifNotExists()

Causes the inclusion of an IF NOT EXISTS clause.

Returns:

this

ifNotExists

public CreateKeyspaceSpecification ifNotExists(boolean ifNotExists)

Toggles the inclusion of an IF NOT EXISTS clause.

Returns:

this

getIfNotExists

public boolean getIfNotExists()

withSimpleReplication

public CreateKeyspaceSpecification withSimpleReplication()

withSimpleReplication

public CreateKeyspaceSpecification withSimpleReplication(long replicationFactor)

withNetworkReplication

public CreateKeyspaceSpecification withNetworkReplication(DataCenterReplication... dcrs)

name

public CreateKeyspaceSpecification name(String name)

Description copied from class: KeyspaceActionSpecification

Sets the keyspace name.

Overrides:

name in class KeyspaceOptionsSpecification<KeyspaceSpecification<CreateKeyspaceSpecification>>

Returns:

this

name

public CreateKeyspaceSpecification name(KeyspaceIdentifier name)

Description copied from class: KeyspaceActionSpecification

Sets the keyspace name.

Overrides:

name in class KeyspaceActionSpecification<KeyspaceOptionsSpecification<KeyspaceSpecification<CreateKeyspaceSpecification>>>

Returns:

this

with

public CreateKeyspaceSpecification with(KeyspaceOption option)

Description copied from class: KeyspaceOptionsSpecification

Convenience method that calls with(option, null).

Overrides:

with in class KeyspaceOptionsSpecification<KeyspaceSpecification<CreateKeyspaceSpecification>>

Returns:

this

with

public CreateKeyspaceSpecification with(KeyspaceOption option,
                                        Object value)

Description copied from class: KeyspaceOptionsSpecification

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

Overrides:

with in class KeyspaceOptionsSpecification<KeyspaceSpecification<CreateKeyspaceSpecification>>

Parameters:

option - The option to set.

value - The value of the option. Must be type-compatible with the KeyspaceOption.

Returns:

this

See Also:

KeyspaceOptionsSpecification.with(String, Object, boolean, boolean)

with

public CreateKeyspaceSpecification with(String name,
                                        Object value,
                                        boolean escape,
                                        boolean quote)

Description copied from class: KeyspaceOptionsSpecification

Adds the given option by name to this keyspaces'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 KeyspaceOptionsSpecification<KeyspaceSpecification<CreateKeyspaceSpecification>>

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