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

Class CreateKeyspaceSpecification

java.lang.Object

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

org.springframework.data.cassandra.core.cql.keyspace.KeyspaceOptionsSpecification<CreateKeyspaceSpecification>

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

All Implemented Interfaces:

CqlSpecification, KeyspaceDescriptor

public class CreateKeyspaceSpecification
extends KeyspaceOptionsSpecification<CreateKeyspaceSpecification>
implements KeyspaceDescriptor, CqlSpecification

Object to configure a CREATE KEYSPACE specification.

Author:

Mark Paluch

Field Summary

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

options

Method Summary

Modifier and Type	Method	Description
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 CreateKeyspaceSpecification	createKeyspace(KeyspaceIdentifier name)	Deprecated. since 3.0, use createKeyspace(CqlIdentifier)
boolean	equals(Object o)
boolean	getIfNotExists()
int	hashCode()
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	with(String name, Object value, boolean escape, boolean quote)	Adds the given option by name to this keyspaces's options.
CreateKeyspaceSpecification	with(KeyspaceOption option)	Convenience method that calls with(option, null).
CreateKeyspaceSpecification	with(KeyspaceOption option, Object value)	Sets the given table option.
CreateKeyspaceSpecification	withNetworkReplication(DataCenterReplication... dcrs)	Configure datacenter replication given DataCenterReplication.
CreateKeyspaceSpecification	withSimpleReplication()	Configure simple replication with a replication factor of 1.
CreateKeyspaceSpecification	withSimpleReplication(long replicationFactor)	Configure simple replication with a replicationFactor.

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

getOptions

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

canEqual, getName

Methods inherited from class java.lang.Object

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

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

getName, getOptions

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

@Deprecated
public static CreateKeyspaceSpecification createKeyspace(KeyspaceIdentifier name)

Deprecated.

since 3.0, use createKeyspace(CqlIdentifier)

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.

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.

Since:

3.0

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

Configure simple replication with a replication factor of 1.

Returns:

this.

withSimpleReplication

public CreateKeyspaceSpecification withSimpleReplication(long replicationFactor)

Configure simple replication with a replicationFactor.

Returns:

this.

withNetworkReplication

public CreateKeyspaceSpecification withNetworkReplication(DataCenterReplication... dcrs)

Configure datacenter replication given DataCenterReplication.

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

equals

public boolean equals(@Nullable
 Object o)

Overrides:

equals in class KeyspaceOptionsSpecification<CreateKeyspaceSpecification>

hashCode

public int hashCode()

Overrides:

hashCode in class KeyspaceOptionsSpecification<CreateKeyspaceSpecification>