public interface IndexMetadata extends Describable
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() |
@NonNull CqlIdentifier getKeyspace()
@NonNull CqlIdentifier getTable()
@NonNull CqlIdentifier getName()
@NonNull IndexKind getKind()
@NonNull String getTarget()
@NonNull default Optional<String> getClassName()
@NonNull Map<String,String> getOptions()
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()
}.
@NonNull default String describe(boolean pretty)
Describable
describe
in interface Describable
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.@NonNull default String describeWithChildren(boolean pretty)
Describable
describeWithChildren
in interface Describable
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.Copyright © 2017–2020. All rights reserved.