public class CreateIndexSpecification extends IndexNameSpecification<CreateIndexSpecification> implements IndexDescriptor
CREATE INDEX
specification.Modifier and Type | Class and Description |
---|---|
static class |
CreateIndexSpecification.ColumnFunction
Column functions to specify indexing behavior.
|
Modifier and Type | Method and Description |
---|---|
CreateIndexSpecification |
columnFunction(CreateIndexSpecification.ColumnFunction columnFunction)
|
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.
|
getName
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getName
public static CreateIndexSpecification createIndex()
CreateIndexSpecification
's fluent API to create a index. Convenient if imported
statically.public static CreateIndexSpecification createIndex(String indexName)
CreateIndexSpecification
's fluent API given indexName
to create a index.
Convenient if imported statically.indexName
- must not be null or empty.CreateIndexSpecification
.public static CreateIndexSpecification createIndex(com.datastax.oss.driver.api.core.CqlIdentifier indexName)
CreateIndexSpecification
's fluent API given indexName
to create a index.
Convenient if imported statically.indexName
- must not be null.CreateIndexSpecification
.public CreateIndexSpecification tableName(String tableName)
tableName
- must not be null or empty.public CreateIndexSpecification tableName(com.datastax.oss.driver.api.core.CqlIdentifier tableName)
tableName
- must not be null.public com.datastax.oss.driver.api.core.CqlIdentifier getTableName()
IndexDescriptor
getTableName
in interface IndexDescriptor
public CreateIndexSpecification columnName(String columnName)
columnName
- must not be null or empty.public CreateIndexSpecification columnName(com.datastax.oss.driver.api.core.CqlIdentifier columnName)
columnName
- must not be null.public com.datastax.oss.driver.api.core.CqlIdentifier getColumnName()
getColumnName
in interface IndexDescriptor
public CreateIndexSpecification ifNotExists()
IF NOT EXISTS
clause.public CreateIndexSpecification ifNotExists(boolean ifNotExists)
IF NOT EXISTS
clause.public boolean getIfNotExists()
public boolean isCustom()
isCustom
in interface IndexDescriptor
public CreateIndexSpecification using(String className)
@Nullable public String getUsing()
getUsing
in interface IndexDescriptor
public CreateIndexSpecification keys()
KEYS
clause.public CreateIndexSpecification values()
VALUES
clause.public CreateIndexSpecification entries()
ENTRIES
clause.public CreateIndexSpecification full()
FULL
clause.public CreateIndexSpecification columnFunction(CreateIndexSpecification.ColumnFunction columnFunction)
columnFunction
- column function to apply, must not be null.public CreateIndexSpecification.ColumnFunction getColumnFunction()
public CreateIndexSpecification withOption(String name, String value)
name
- option name.value
- option value.Copyright © 2011–2021 Pivotal Software, Inc.. All rights reserved.