CreateIndexSpecification (Spring Data for Apache Cassandra 3.2.0 API)

java.lang.Object
- org.springframework.data.cassandra.core.cql.keyspace.IndexNameSpecification<CreateIndexSpecification>
- - org.springframework.data.cassandra.core.cql.keyspace.CreateIndexSpecification

All Implemented Interfaces:

IndexDescriptor
```
public class CreateIndexSpecification
extends IndexNameSpecification<CreateIndexSpecification>
implements IndexDescriptor
```
Object to configure a CREATE INDEX specification.

Author:

Matthew T. Adams, David Webb, Mark Paluch

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CreateIndexSpecification.ColumnFunction
Column functions to specify indexing behavior.

Nested Classes
Modifier and Type	Class and Description
`static class`	`CreateIndexSpecification.ColumnFunction` Column functions to specify indexing behavior.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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 a index.
`static CreateIndexSpecification`	`createIndex(com.datastax.oss.driver.api.core.CqlIdentifier indexName)` Entry point into the `CreateIndexSpecification`'s fluent API given `indexName` to create a index.
`static CreateIndexSpecification`	`createIndex(String indexName)` Entry point into the `CreateIndexSpecification`'s fluent API given `indexName` to create a 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
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 Detail
  - createIndex
```
public static CreateIndexSpecification createIndex()
```
    Entry point into the CreateIndexSpecification's fluent API to create a index. Convenient if imported statically.
  - createIndex
```
public static CreateIndexSpecification createIndex(String indexName)
```
    Entry point into the CreateIndexSpecification's fluent API given indexName to create a 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 a index. Convenient if imported statically.
    
    Parameters:
    
    indexName - must not be null.
    
    Returns:
    
    a new CreateIndexSpecification.
  - 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.

Class CreateIndexSpecification

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

createIndex

createIndex

createIndex

tableName

tableName

getTableName

columnName

columnName

getColumnName

ifNotExists

ifNotExists

getIfNotExists

isCustom

using

getUsing

keys

values

entries

full

columnFunction

getColumnFunction

withOption

getOptions