Package org.apache.cassandra.schema

Class KeyspaceMetadata

java.lang.Object

org.apache.cassandra.schema.KeyspaceMetadata

All Implemented Interfaces:

SchemaElement

public final class KeyspaceMetadata
extends Object
implements SchemaElement

An immutable representation of keyspace metadata (name, params, tables, types, and functions).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	KeyspaceMetadata.KeyspaceDiff
static enum	KeyspaceMetadata.Kind

Nested classes/interfaces inherited from interface org.apache.cassandra.cql3.SchemaElement

SchemaElement.SchemaElementType

Field Summary

Fields

Modifier and Type	Field	Description
final KeyspaceMetadata.Kind	kind
final String	name
final KeyspaceParams	params
final Tables	tables
final Types	types
final UserFunctions	userFunctions
final Views	views

Fields inherited from interface org.apache.cassandra.cql3.SchemaElement

NAME_COMPARATOR

Method Summary

Modifier and Type	Method	Description
static KeyspaceMetadata	create(String name, KeyspaceParams params)
static KeyspaceMetadata	create(String name, KeyspaceParams params, Tables tables)
static KeyspaceMetadata	create(String name, KeyspaceParams params, Tables tables, Views views, Types types, UserFunctions functions)
AbstractReplicationStrategy	createReplicationStrategy()
String	elementKeyspace()	Returns the CQL name of the keyspace to which this schema element belong.
String	elementName()	Returns the CQL name of this schema element.
SchemaElement.SchemaElementType	elementType()	Return the schema element type
KeyspaceMetadata	empty()
boolean	equals(Object o)
String	findAvailableIndexName(String baseName)
Optional<TableMetadata>	findIndexedTable(String indexName)
TableMetadata	getTableNullable(String tableName)
TableMetadata	getTableOrViewNullable(String tableOrViewName)
int	hashCode()
boolean	hasIndex(String indexName)
boolean	hasTable(String tableName)
boolean	hasView(String viewName)
boolean	isVirtual()
Iterable<TableMetadata>	tablesAndViews()
Stream<TableMetadata>	tablesUsingFunction(Function function)
String	toCqlString(boolean withInternals, boolean ifNotExists)	Returns a CQL representation of this element
String	toString()
void	validate()
static <T extends RequestValidationException> void	validateKeyspaceName(String keyspaceName, Function<String,T> exceptionBuilder)	Validates the keyspace name for valid characters and correct length.
static KeyspaceMetadata	virtual(String name, Tables tables)
KeyspaceMetadata	withSwapped(KeyspaceParams params)
KeyspaceMetadata	withSwapped(Tables regular)
KeyspaceMetadata	withSwapped(Types types)
KeyspaceMetadata	withSwapped(UserFunctions functions)
KeyspaceMetadata	withSwapped(Views views)
KeyspaceMetadata	withUpdatedUserType(UserType udt)	Returns a new KeyspaceMetadata with all instances of old UDT replaced with the updated version.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.cassandra.cql3.SchemaElement

elementKeyspaceQuotedIfNeeded, elementNameQuotedIfNeeded

Field Details

name

public final String name

kind

public final KeyspaceMetadata.Kind kind

params

public final KeyspaceParams params

tables

public final Tables tables

views

public final Views views

types

public final Types types

userFunctions

public final UserFunctions userFunctions

Method Details

validateKeyspaceName

public static <T extends RequestValidationException>
void validateKeyspaceName(String keyspaceName,
 Function<String,T> exceptionBuilder)

Validates the keyspace name for valid characters and correct length. Throws an exception if it's invalid.

Parameters:

keyspaceName - The name of the keyspace to validate

exceptionBuilder - The exception constructor to throw if validation fails

create

public static KeyspaceMetadata create(String name,
 KeyspaceParams params)

create

public static KeyspaceMetadata create(String name,
 KeyspaceParams params,
 Tables tables)

create

public static KeyspaceMetadata create(String name,
 KeyspaceParams params,
 Tables tables,
 Views views,
 Types types,
 UserFunctions functions)

virtual

public static KeyspaceMetadata virtual(String name,
 Tables tables)

withSwapped

public KeyspaceMetadata withSwapped(KeyspaceParams params)

withSwapped

public KeyspaceMetadata withSwapped(Tables regular)

withSwapped

public KeyspaceMetadata withSwapped(Views views)

withSwapped

public KeyspaceMetadata withSwapped(Types types)

withSwapped

public KeyspaceMetadata withSwapped(UserFunctions functions)

empty

public KeyspaceMetadata empty()

isVirtual

public boolean isVirtual()

withUpdatedUserType

public KeyspaceMetadata withUpdatedUserType(UserType udt)

Returns a new KeyspaceMetadata with all instances of old UDT replaced with the updated version. Replaces all instances in tables, views, types, and functions.

tablesAndViews

public Iterable<TableMetadata> tablesAndViews()

getTableOrViewNullable

@Nullable
public TableMetadata getTableOrViewNullable(String tableOrViewName)

getTableNullable

@Nullable
public TableMetadata getTableNullable(String tableName)

hasTable

public boolean hasTable(String tableName)

hasView

public boolean hasView(String viewName)

hasIndex

public boolean hasIndex(String indexName)

tablesUsingFunction

public Stream<TableMetadata> tablesUsingFunction(Function function)

Parameters:

function - a user function

Returns:

a stream of tables within this keyspace that have column masks using the specified user function

findAvailableIndexName

public String findAvailableIndexName(String baseName)

findIndexedTable

public Optional<TableMetadata> findIndexedTable(String indexName)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

elementType

public SchemaElement.SchemaElementType elementType()

Description copied from interface: SchemaElement

Return the schema element type

Specified by:

elementType in interface SchemaElement

Returns:

the schema element type

elementKeyspace

public String elementKeyspace()

Description copied from interface: SchemaElement

Returns the CQL name of the keyspace to which this schema element belong.

Specified by:

elementKeyspace in interface SchemaElement

Returns:

the keyspace name.

elementName

public String elementName()

Description copied from interface: SchemaElement

Returns the CQL name of this schema element.

Specified by:

elementName in interface SchemaElement

Returns:

the name of this schema element.

toCqlString

public String toCqlString(boolean withInternals,
 boolean ifNotExists)

Description copied from interface: SchemaElement

Returns a CQL representation of this element

Specified by:

toCqlString in interface SchemaElement

Parameters:

withInternals - if the internals part of the CQL should be exposed.

ifNotExists - if "IF NOT EXISTS" should be included.

Returns:

a CQL representation of this element

validate

public void validate()

createReplicationStrategy

public AbstractReplicationStrategy createReplicationStrategy()