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

Interface DseGraphTableMetadata

All Superinterfaces:

Describable, DseRelationMetadata, DseTableMetadata, RelationMetadata, TableMetadata

public interface DseGraphTableMetadata
extends DseTableMetadata

Specialized table metadata, that handles the graph-specific properties introduced in DSE 6.8.

This type only exists to avoid breaking binary compatibility. When the driver is connected to a DSE cluster, all the TableMetadata instances it returns can be safely downcast to this interface.

Method Summary

Modifier and Type	Method and Description
default String	describe(boolean pretty) Returns a single CQL statement that creates the element.
Optional<DseEdgeMetadata>	getEdge() The edge metadata if this table represents an edge in graph, otherwise empty.
Optional<DseVertexMetadata>	getVertex() The vertex metadata if this table represents a vertex in graph, otherwise empty.

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

describeWithChildren, getIndex, getIndex, getIndexes, isCompactStorage, isVirtual

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

getVertex

@NonNull
Optional<DseVertexMetadata> getVertex()

The vertex metadata if this table represents a vertex in graph, otherwise empty.

This is mutually exclusive with getEdge().

getEdge

@NonNull
Optional<DseEdgeMetadata> getEdge()

The edge metadata if this table represents an edge in graph, otherwise empty.

This is mutually exclusive with getVertex().

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

Specified by:

describe in interface TableMetadata

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.