com.datastax.oss.driver.api.querybuilder.schema

Interface CreateIndexStart

public interface CreateIndexStart

Method Summary

Modifier and Type	Method and Description
CreateIndexStart	custom(String className) Adds CUSTOM specification to the index for the given class name.
CreateIndexStart	ifNotExists() Adds IF NOT EXISTS to the create index specification.
default CreateIndexOnTable	onTable(CqlIdentifier table) Indicates which table this index is on.
CreateIndexOnTable	onTable(CqlIdentifier keyspace, CqlIdentifier table) Indicates which table this index is on.
default CreateIndexOnTable	onTable(String table) Shortcut for onTable(CqlIdentifier.fromCql(table)).
default CreateIndexOnTable	onTable(String keyspace, String table) Shortcut for onTable(CqlIdentifier.fromCql(keyspace),CqlIdentifier.fromCql(table)).
default CreateIndexStart	usingSASI() Declares that the index is a "SSTable Attached Secondary Index" (SASI) type index.

Method Detail

ifNotExists

@NonNull
CreateIndexStart ifNotExists()

Adds IF NOT EXISTS to the create index specification. This indicates that the index should not be created if it already exists.

custom

@NonNull
CreateIndexStart custom(@NonNull
                                 String className)

Adds CUSTOM specification to the index for the given class name. The class name will added to the end of the CREATE INDEX specification with USING 'classname'.

usingSASI

@NonNull
default CreateIndexStart usingSASI()

Declares that the index is a "SSTable Attached Secondary Index" (SASI) type index. This is a custom index with the class org.apache.cassandra.index.SASIIndex.

See Also:

CreateIndex.withSASIOptions(Map)

onTable

@NonNull
CreateIndexOnTable onTable(@Nullable
                                    CqlIdentifier keyspace,
                                    @NonNull
                                    CqlIdentifier table)

Indicates which table this index is on.

onTable

@NonNull
default CreateIndexOnTable onTable(@NonNull
                                            CqlIdentifier table)

Indicates which table this index is on. This assumes the keyspace name is already qualified for the Session or Statement.

onTable

@NonNull
default CreateIndexOnTable onTable(@Nullable
                                            String keyspace,
                                            @NonNull
                                            String table)

Shortcut for onTable(CqlIdentifier.fromCql(keyspace),CqlIdentifier.fromCql(table)).

onTable

@NonNull
default CreateIndexOnTable onTable(@NonNull
                                            String table)

Shortcut for onTable(CqlIdentifier.fromCql(table)).