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

Interface RelationMetadata

All Superinterfaces:

Describable

All Known Subinterfaces:

DseGraphTableMetadata, DseRelationMetadata, DseTableMetadata, DseViewMetadata, TableMetadata, ViewMetadata

public interface RelationMetadata
extends Describable

A table or materialized view in the schema metadata.

Method Summary

Modifier and Type	Method and Description
Map<ColumnMetadata,ClusteringOrder>	getClusteringColumns()
default Optional<ColumnMetadata>	getColumn(CqlIdentifier columnId)
default Optional<ColumnMetadata>	getColumn(String columnName) Shortcut for getColumn(CqlIdentifier.fromCql(columnName)).
Map<CqlIdentifier,ColumnMetadata>	getColumns()
Optional<UUID>	getId() The unique id generated by the server for this element.
CqlIdentifier	getKeyspace()
CqlIdentifier	getName()
Map<CqlIdentifier,Object>	getOptions() The options of this table or materialized view.
List<ColumnMetadata>	getPartitionKey()
default List<ColumnMetadata>	getPrimaryKey() Convenience method to get all the primary key columns (partition key + clustering columns) in a single call.

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

describe, describeWithChildren

Method Detail

getKeyspace

@NonNull
CqlIdentifier getKeyspace()

getName

@NonNull
CqlIdentifier getName()

getId

Optional<UUID> getId()

The unique id generated by the server for this element.

getPrimaryKey

@NonNull
default List<ColumnMetadata> getPrimaryKey()

Convenience method to get all the primary key columns (partition key + clustering columns) in a single call.

Note that this creates a new list instance on each call.

See Also:

getPartitionKey(), getClusteringColumns()

getPartitionKey

@NonNull
List<ColumnMetadata> getPartitionKey()

getClusteringColumns

@NonNull
Map<ColumnMetadata,ClusteringOrder> getClusteringColumns()

getColumns

@NonNull
Map<CqlIdentifier,ColumnMetadata> getColumns()

getColumn

@NonNull
default Optional<ColumnMetadata> getColumn(@NonNull
                                                    CqlIdentifier columnId)

getColumn

@NonNull
default Optional<ColumnMetadata> getColumn(@NonNull
                                                    String columnName)

Shortcut for getColumn(CqlIdentifier.fromCql(columnName)).

getOptions

@NonNull
Map<CqlIdentifier,Object> getOptions()

The options of this table or materialized view.

This corresponds to the WITH clauses in the CREATE statement that would recreate this element. The exact set of keys and the types of the values depend on the server version that this metadata was extracted from. For example, in Cassandra 2.2 and below, WITH caching takes a string argument, whereas starting with Cassandra 3.0 it is a map.