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

Interface KeyspaceMetadata

All Superinterfaces:

Describable

All Known Subinterfaces:

DseGraphKeyspaceMetadata, DseKeyspaceMetadata

public interface KeyspaceMetadata
extends Describable

A keyspace 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<AggregateMetadata>	getAggregate(CqlIdentifier aggregateId, DataType... parameterTypes)
default Optional<AggregateMetadata>	getAggregate(CqlIdentifier aggregateId, Iterable<DataType> parameterTypes)
default Optional<AggregateMetadata>	getAggregate(FunctionSignature aggregateSignature)
default Optional<AggregateMetadata>	getAggregate(String aggregateName, DataType... parameterTypes) Shortcut for getAggregate(CqlIdentifier, DataType...) getAggregate(CqlIdentifier.fromCql(aggregateName), parameterTypes)}.
default Optional<AggregateMetadata>	getAggregate(String aggregateName, Iterable<DataType> parameterTypes) Shortcut for getAggregate(CqlIdentifier.fromCql(aggregateName), parameterTypes).
Map<FunctionSignature,AggregateMetadata>	getAggregates()
default Optional<FunctionMetadata>	getFunction(CqlIdentifier functionId, DataType... parameterTypes)
default Optional<FunctionMetadata>	getFunction(CqlIdentifier functionId, Iterable<DataType> parameterTypes)
default Optional<FunctionMetadata>	getFunction(FunctionSignature functionSignature)
default Optional<FunctionMetadata>	getFunction(String functionName, DataType... parameterTypes) Shortcut for getFunction(CqlIdentifier.fromCql(functionName), parameterTypes).
default Optional<FunctionMetadata>	getFunction(String functionName, Iterable<DataType> parameterTypes) Shortcut for getFunction(CqlIdentifier.fromCql(functionName), parameterTypes).
Map<FunctionSignature,FunctionMetadata>	getFunctions()
CqlIdentifier	getName()
Map<String,String>	getReplication() The replication options defined for this keyspace.
default Optional<TableMetadata>	getTable(CqlIdentifier tableId)
default Optional<TableMetadata>	getTable(String tableName) Shortcut for getTable(CqlIdentifier.fromCql(tableName)).
Map<CqlIdentifier,TableMetadata>	getTables()
default Optional<UserDefinedType>	getUserDefinedType(CqlIdentifier typeId)
default Optional<UserDefinedType>	getUserDefinedType(String typeName) Shortcut for getUserDefinedType(CqlIdentifier.fromCql(typeName)).
Map<CqlIdentifier,UserDefinedType>	getUserDefinedTypes()
default Optional<ViewMetadata>	getView(CqlIdentifier viewId)
default Optional<ViewMetadata>	getView(String viewName) Shortcut for getView(CqlIdentifier.fromCql(viewName)).
Map<CqlIdentifier,ViewMetadata>	getViews()
default Map<CqlIdentifier,ViewMetadata>	getViewsOnTable(CqlIdentifier tableId) Gets the views based on a given table.
boolean	isDurableWrites() Whether durable writes are set on this keyspace.
boolean	isVirtual() Whether this keyspace is virtual
default boolean	shallowEquals(Object other)

Method Detail

getName

@NonNull
CqlIdentifier getName()

isDurableWrites

boolean isDurableWrites()

Whether durable writes are set on this keyspace.

isVirtual

boolean isVirtual()

Whether this keyspace is virtual

getReplication

@NonNull
Map<String,String> getReplication()

The replication options defined for this keyspace.

getTables

@NonNull
Map<CqlIdentifier,TableMetadata> getTables()

getTable

@NonNull
default Optional<TableMetadata> getTable(@NonNull
                                                  CqlIdentifier tableId)

getTable

@NonNull
default Optional<TableMetadata> getTable(@NonNull
                                                  String tableName)

Shortcut for getTable(CqlIdentifier.fromCql(tableName)).

getViews

@NonNull
Map<CqlIdentifier,ViewMetadata> getViews()

getViewsOnTable

@NonNull
default Map<CqlIdentifier,ViewMetadata> getViewsOnTable(@NonNull
                                                                 CqlIdentifier tableId)

Gets the views based on a given table.

getView

@NonNull
default Optional<ViewMetadata> getView(@NonNull
                                                CqlIdentifier viewId)

getView

@NonNull
default Optional<ViewMetadata> getView(@NonNull
                                                String viewName)

Shortcut for getView(CqlIdentifier.fromCql(viewName)).

getUserDefinedTypes

@NonNull
Map<CqlIdentifier,UserDefinedType> getUserDefinedTypes()

getUserDefinedType

@NonNull
default Optional<UserDefinedType> getUserDefinedType(@NonNull
                                                              CqlIdentifier typeId)

getUserDefinedType

@NonNull
default Optional<UserDefinedType> getUserDefinedType(@NonNull
                                                              String typeName)

Shortcut for getUserDefinedType(CqlIdentifier.fromCql(typeName)).

getFunctions

@NonNull
Map<FunctionSignature,FunctionMetadata> getFunctions()

getFunction

@NonNull
default Optional<FunctionMetadata> getFunction(@NonNull
                                                        FunctionSignature functionSignature)

getFunction

@NonNull
default Optional<FunctionMetadata> getFunction(@NonNull
                                                        CqlIdentifier functionId,
                                                        @NonNull
                                                        Iterable<DataType> parameterTypes)

getFunction

@NonNull
default Optional<FunctionMetadata> getFunction(@NonNull
                                                        String functionName,
                                                        @NonNull
                                                        Iterable<DataType> parameterTypes)

Shortcut for getFunction(CqlIdentifier.fromCql(functionName), parameterTypes).

getFunction

@NonNull
default Optional<FunctionMetadata> getFunction(@NonNull
                                                        CqlIdentifier functionId,
                                                        @NonNull
                                                        DataType... parameterTypes)

Parameters:

parameterTypes - neither the individual types, nor the vararg array itself, can be null.

getFunction

@NonNull
default Optional<FunctionMetadata> getFunction(@NonNull
                                                        String functionName,
                                                        @NonNull
                                                        DataType... parameterTypes)

Shortcut for getFunction(CqlIdentifier.fromCql(functionName), parameterTypes).

Parameters:

parameterTypes - neither the individual types, nor the vararg array itself, can be null.

getAggregates

@NonNull
Map<FunctionSignature,AggregateMetadata> getAggregates()

getAggregate

@NonNull
default Optional<AggregateMetadata> getAggregate(@NonNull
                                                          FunctionSignature aggregateSignature)

getAggregate

@NonNull
default Optional<AggregateMetadata> getAggregate(@NonNull
                                                          CqlIdentifier aggregateId,
                                                          @NonNull
                                                          Iterable<DataType> parameterTypes)

getAggregate

@NonNull
default Optional<AggregateMetadata> getAggregate(@NonNull
                                                          String aggregateName,
                                                          @NonNull
                                                          Iterable<DataType> parameterTypes)

Shortcut for getAggregate(CqlIdentifier.fromCql(aggregateName), parameterTypes).

getAggregate

@NonNull
default Optional<AggregateMetadata> getAggregate(@NonNull
                                                          CqlIdentifier aggregateId,
                                                          @NonNull
                                                          DataType... parameterTypes)

Parameters:

parameterTypes - neither the individual types, nor the vararg array itself, can be null.

getAggregate

@NonNull
default Optional<AggregateMetadata> getAggregate(@NonNull
                                                          String aggregateName,
                                                          @NonNull
                                                          DataType... parameterTypes)

Shortcut for getAggregate(CqlIdentifier, DataType...) getAggregate(CqlIdentifier.fromCql(aggregateName), parameterTypes)}.

Parameters:

parameterTypes - neither the individual types, nor the vararg array itself, can be null.

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.

shallowEquals

default boolean shallowEquals(Object other)