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

Interface TableMetadata

All Superinterfaces:

Describable, RelationMetadata

All Known Subinterfaces:

DseGraphTableMetadata, DseTableMetadata

public interface TableMetadata
extends RelationMetadata

A table 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<IndexMetadata>	getIndex(CqlIdentifier indexId)
default Optional<IndexMetadata>	getIndex(String indexName) Shortcut for getIndex(CqlIdentifier.fromCql(indexName)).
Map<CqlIdentifier,IndexMetadata>	getIndexes()
boolean	isCompactStorage()
boolean	isVirtual() Whether this table is virtual

Methods inherited from interface com.datastax.oss.driver.api.core.metadata.schema.RelationMetadata

getClusteringColumns, getColumn, getColumn, getColumns, getId, getKeyspace, getName, getOptions, getPartitionKey, getPrimaryKey

Method Detail

isCompactStorage

boolean isCompactStorage()

isVirtual

boolean isVirtual()

Whether this table is virtual

getIndexes

@NonNull
Map<CqlIdentifier,IndexMetadata> getIndexes()

getIndex

@NonNull
default Optional<IndexMetadata> getIndex(@NonNull
                                                  CqlIdentifier indexId)

getIndex

@NonNull
default Optional<IndexMetadata> getIndex(@NonNull
                                                  String indexName)

Shortcut for getIndex(CqlIdentifier.fromCql(indexName)).

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)

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.

This describes the table and all of its indices. Contrary to previous driver versions, views are not included.

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.