com.datastax.oss.driver.api.core.metadata.schema

Interface IndexMetadata

All Superinterfaces:

Describable

All Known Subinterfaces:

DseIndexMetadata

public interface IndexMetadata
extends Describable

A secondary index in the schema metadata.

Method Summary

Modifier and Type	Method and Description
default String	describe(boolean pretty) Returns a single CQL statement that creates the element.
default String	describeWithChildren(boolean pretty) Returns a CQL script that creates the element and all of its children.
default Optional<String>	getClassName() If this index is custom, the name of the server-side implementation.
CqlIdentifier	getKeyspace()
IndexKind	getKind()
CqlIdentifier	getName()
Map<String,String>	getOptions() The options of the index.
CqlIdentifier	getTable()
String	getTarget()

Method Detail

getKeyspace

@NonNull
CqlIdentifier getKeyspace()

getTable

@NonNull
CqlIdentifier getTable()

getName

@NonNull
CqlIdentifier getName()

getKind

@NonNull
IndexKind getKind()

getTarget

@NonNull
String getTarget()

getClassName

@NonNull
default Optional<String> getClassName()

If this index is custom, the name of the server-side implementation. Otherwise, empty.

getOptions

@NonNull
Map<String,String> getOptions()

The options of the index.

This directly reflects the corresponding column of the system table (system.schema_columns.index_options in Cassandra <= 2.2, or system_schema.indexes.options in later versions).

Note that some of these options might also be exposed as standalone fields in this interface, namely getClassName() and {getTarget()}.

describe

@NonNull
default String describe(boolean pretty)

Description copied from interface: Describable

Returns a single CQL statement that creates the element.

Specified by:

describe in interface Describable

Parameters:

pretty - if true, make the output more human-readable (line breaks, indents, and pretty identifiers). If false, return the statement on a single line with minimal formatting.

describeWithChildren

@NonNull
default String describeWithChildren(boolean pretty)

Description copied from interface: Describable

Returns a CQL script that creates the element and all of its children. For example: a schema with its tables, materialized views, types, etc. A table with its indices.

Specified by:

describeWithChildren in interface Describable

Parameters:

pretty - if true, make the output more human-readable (line breaks, indents, and pretty identifiers). If false, return each statement on a single line with minimal formatting.