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

Interface ViewMetadata

All Superinterfaces:

Describable, RelationMetadata

All Known Subinterfaces:

DseViewMetadata

public interface ViewMetadata
extends RelationMetadata

A materialized view 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.
CqlIdentifier	getBaseTable() The table that this view is based on.
Optional<String>	getWhereClause()
boolean	includesAllColumns() Whether this view does a SELECT * on its base table (this only affects the output of describe(boolean)).

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

getBaseTable

@NonNull
CqlIdentifier getBaseTable()

The table that this view is based on.

includesAllColumns

boolean includesAllColumns()

Whether this view does a SELECT * on its base table (this only affects the output of describe(boolean)).

getWhereClause

@NonNull
Optional<String> getWhereClause()

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)

Description copied from interface: Describable

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.

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.