Package com.apple.foundationdb.relational.api.metadata

Interface Schema

All Superinterfaces:

Metadata

public interface Schema
extends Metadata

Metadata for a Relational Schema.

Method Summary

Modifier and Type	Method	Description
default void	accept(Visitor visitor)
String	getDatabaseName()	Returns the ID of the database which this Schema belong to.
default com.google.common.collect.Multimap<String,String>	getIndexes()	Returns a list of all table-scoped Indexes in this schema.
default Set<? extends InvokedRoutine>	getInvokedRoutines()	Returns all InvokedRoutines defined in this schema.
SchemaTemplate	getSchemaTemplate()	returns the SchemaTemplate from which this Schema is generated.
default Set<? extends Table>	getTables()	Returns the tables inside the Schema.

Methods inherited from interface com.apple.foundationdb.relational.api.metadata.Metadata

getName

Method Details

getSchemaTemplate

@Nonnull
SchemaTemplate getSchemaTemplate()

returns the SchemaTemplate from which this Schema is generated.

Returns:

The SchemaTemplate from which this Schema is generated.

getDatabaseName

@Nonnull
String getDatabaseName()

Returns the ID of the database which this Schema belong to.

Returns:

The ID of the database which this Schema belong to.

getTables

@Nonnull
default Set<? extends Table> getTables()
                                throws RelationalException

Returns the tables inside the Schema.

Returns:

The tables inside the Schema.

Throws:

RelationalException - if the schema template is NoOpSchemaTemplate

getIndexes

@Nonnull
default com.google.common.collect.Multimap<String,String> getIndexes()
                                                              throws RelationalException

Returns a list of all table-scoped Indexes in this schema.

Returns:

a multi-map whose key is the Table name, and value(s) is the Index.

Throws:

RelationalException - if something goes wrong.

getInvokedRoutines

@Nonnull
default Set<? extends InvokedRoutine> getInvokedRoutines()
                                                  throws RelationalException

Returns all InvokedRoutines defined in this schema.

Returns:

A set of all InvokedRoutines defined in this schema.

Throws:

RelationalException - If there was an error retrieving the invoked routines from the catalog.

accept

default void accept(@Nonnull
 Visitor visitor)

Specified by:

accept in interface Metadata