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

Interface Describable

All Known Subinterfaces:

AggregateMetadata, DseAggregateMetadata, DseFunctionMetadata, DseGraphKeyspaceMetadata, DseGraphTableMetadata, DseIndexMetadata, DseKeyspaceMetadata, DseRelationMetadata, DseTableMetadata, DseViewMetadata, FunctionMetadata, IndexMetadata, KeyspaceMetadata, RelationMetadata, TableMetadata, UserDefinedType, ViewMetadata

public interface Describable

A schema element that can be described in terms of CQL CREATE statements.

Method Summary

Modifier and Type	Method	Description
String	describe(boolean pretty)	Returns a single CQL statement that creates the element.
String	describeWithChildren(boolean pretty)	Returns a CQL script that creates the element and all of its children.

Method Detail

describe

@NonNull
String describe(boolean pretty)

Returns a single CQL statement that creates the element.

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
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.

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.