Module spring.data.cassandra

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

Class CreateIndexSpecification

java.lang.Object

org.springframework.data.cassandra.core.cql.keyspace.IndexNameSpecification<CreateIndexSpecification>

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

All Implemented Interfaces:

CqlSpecification, IndexDescriptor

public class CreateIndexSpecification
extends IndexNameSpecification<CreateIndexSpecification>
implements IndexDescriptor, CqlSpecification

Object to configure a CREATE INDEX specification.

Author:

Matthew T. Adams, David Webb, Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CreateIndexSpecification.ColumnFunction	Column functions to specify indexing behavior.

Method Summary

Modifier and Type	Method	Description
CreateIndexSpecification	columnFunction(CreateIndexSpecification.ColumnFunction columnFunction)	Set a CreateIndexSpecification.ColumnFunction such as KEYS(…), ENTRIES(…).
CreateIndexSpecification	columnName(com.datastax.oss.driver.api.core.CqlIdentifier columnName)	Sets the column name.
CreateIndexSpecification	columnName(String columnName)	Sets the column name.
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.
CreateIndexSpecification	entries()	Causes the inclusion of an ENTRIES clause.
CreateIndexSpecification	full()	Causes the inclusion of an FULL clause.
CreateIndexSpecification.ColumnFunction	getColumnFunction()
com.datastax.oss.driver.api.core.CqlIdentifier	getColumnName()
boolean	getIfNotExists()
Map<String,String>	getOptions()
com.datastax.oss.driver.api.core.CqlIdentifier	getTableName()	Returns the table name for the index
String	getUsing()
CreateIndexSpecification	ifNotExists()	Causes the inclusion of an IF NOT EXISTS clause.
CreateIndexSpecification	ifNotExists(boolean ifNotExists)	Toggles the inclusion of an IF NOT EXISTS clause.
boolean	isCustom()
CreateIndexSpecification	keys()	Causes the inclusion of an KEYS clause.
CreateIndexSpecification	tableName(com.datastax.oss.driver.api.core.CqlIdentifier tableName)	Sets the table name.
CreateIndexSpecification	tableName(String tableName)	Sets the table name.
CreateIndexSpecification	using(String className)
CreateIndexSpecification	values()	Causes the inclusion of an VALUES clause.
CreateIndexSpecification	withOption(String name, String value)	Configure a Index-creation options using key-value pairs.

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

getKeyspace, 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.data.cassandra.core.cql.keyspace.IndexDescriptor

getName

Method Details

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

Since:

4.4

tableName

public CreateIndexSpecification tableName(String tableName)

Sets the table name.

Parameters:

tableName - must not be null or empty.

Returns:

this

tableName

public CreateIndexSpecification tableName(com.datastax.oss.driver.api.core.CqlIdentifier tableName)

Sets the table name.

Parameters:

tableName - must not be null.

Returns:

this

getTableName

public com.datastax.oss.driver.api.core.CqlIdentifier getTableName()

Description copied from interface: IndexDescriptor

Returns the table name for the index

Specified by:

getTableName in interface IndexDescriptor

columnName

public CreateIndexSpecification columnName(String columnName)

Sets the column name.

Parameters:

columnName - must not be null or empty.

Returns:

this

columnName

public CreateIndexSpecification columnName(com.datastax.oss.driver.api.core.CqlIdentifier columnName)

Sets the column name.

Parameters:

columnName - must not be null.

Returns:

this

getColumnName

public com.datastax.oss.driver.api.core.CqlIdentifier getColumnName()

Specified by:

getColumnName in interface IndexDescriptor

ifNotExists

public CreateIndexSpecification ifNotExists()

Causes the inclusion of an IF NOT EXISTS clause.

Returns:

this

ifNotExists

public CreateIndexSpecification ifNotExists(boolean ifNotExists)

Toggles the inclusion of an IF NOT EXISTS clause.

Returns:

this

getIfNotExists

public boolean getIfNotExists()

isCustom

public boolean isCustom()

Specified by:

isCustom in interface IndexDescriptor

using

public CreateIndexSpecification using(String className)

getUsing

@Nullable
public String getUsing()

Specified by:

getUsing in interface IndexDescriptor

keys

public CreateIndexSpecification keys()

Causes the inclusion of an KEYS clause.

Returns:

this

Since:

2.0

values

public CreateIndexSpecification values()

Causes the inclusion of an VALUES clause.

Returns:

this

Since:

2.0

entries

public CreateIndexSpecification entries()

Causes the inclusion of an ENTRIES clause.

Returns:

this

Since:

2.0

full

public CreateIndexSpecification full()

Causes the inclusion of an FULL clause.

Returns:

this

Since:

2.0

columnFunction

public CreateIndexSpecification columnFunction(CreateIndexSpecification.ColumnFunction columnFunction)

Set a CreateIndexSpecification.ColumnFunction such as KEYS(…), ENTRIES(…).

Parameters:

columnFunction - column function to apply, must not be null.

Returns:

this

Since:

2.0

getColumnFunction

public CreateIndexSpecification.ColumnFunction getColumnFunction()

withOption

public CreateIndexSpecification withOption(String name,
 String value)

Configure a Index-creation options using key-value pairs.

Parameters:

name - option name.

value - option value.

Returns:

this

Since:

2.0

getOptions

public Map<String,String> getOptions()

Returns:

index options map.