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

Interface SchemaTemplate

All Superinterfaces:

Metadata

public interface SchemaTemplate
extends Metadata

A Relational schema template metadata.

Method Summary

Modifier and Type	Method	Description
default void	accept(Visitor visitor)
Optional<? extends InvokedRoutine>	findInvokedRoutineByName(String routineName)	Retrieves a InvokedRoutine by looking up its name.
Optional<Table>	findTableByName(String tableName)	Retrieves a Table by looking up its name.
Schema	generateSchema(String databaseId, String schemaName)	Creates a Schema instance using the specified.
BitSet	getIndexEntriesAsBitset(Optional<Set<String>> readableIndexNames)	Returns a BitSet whose bits are set for each of passed index names.
Set<String>	getIndexes()
Set<? extends InvokedRoutine>	getInvokedRoutines()	Returns all InvokedRoutines defined in this schema template.
com.google.common.collect.Multimap<String,String>	getTableIndexMapping()
Set<? extends Table>	getTables()	Returns the Tables inside the schema template.
Collection<? extends InvokedRoutine>	getTemporaryInvokedRoutines()
String	getTransactionBoundMetadataAsString()
int	getVersion()	Returns the version of the schema template.
boolean	isEnableLongRows()	Returns true if long rows are permitted in tables of this template, else false.
boolean	isStoreRowVersions()	Returns true if each row is stored along with an monotonically increasing version.
<T extends SchemaTemplate> T	unwrap(Class<T> iface)

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

getName

Method Details

getVersion

int getVersion()

Returns the version of the schema template.

Returns:

The version of the schema template.

isEnableLongRows

boolean isEnableLongRows()

Returns true if long rows are permitted in tables of this template, else false.

Returns:

true if long rows are permitted in tables of this template, else false.

isStoreRowVersions

boolean isStoreRowVersions()

Returns true if each row is stored along with an monotonically increasing version. This is required to make use of the row_version() function within queries and indexes.

Returns:

true if each row is stored along with a monotonically increasing row_version().

getTables

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

Returns the Tables inside the schema template.

Returns:

The Tables inside the schema template.

Throws:

RelationalException - if it is a NoOpSchemaTemplate

findTableByName

@Nonnull
Optional<Table> findTableByName(@Nonnull
 String tableName)
                         throws RelationalException

Retrieves a Table by looking up its name.

Parameters:

tableName - The name of the Table.

Returns:

An Optional containing the Table if it is found, otherwise Empty.

Throws:

RelationalException

getTableIndexMapping

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

Throws:

RelationalException

getIndexes

@Nonnull
Set<String> getIndexes()
                throws RelationalException

Throws:

RelationalException

getIndexEntriesAsBitset

@Nonnull
BitSet getIndexEntriesAsBitset(@Nonnull
 Optional<Set<String>> readableIndexNames)
                        throws RelationalException

Returns a BitSet whose bits are set for each of passed index names.
Example for a given schema template st with indexes i1, i2, i3, i4 whose order are as-defined, calling st.getIndexEntriesAsBitset(Optiona.of(Set.of("i2", "i3")) returns a bitset of 0110.

Parameters:

readableIndexNames - The readable index names, providing an Optional.empty() returns a bitset with bits set to 1.

Returns:

a bit set whose bits are set for each of the passed readable index names.

Throws:

RelationalException - If a readable index is not found.

getInvokedRoutines

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

Returns all InvokedRoutines defined in this schema template.

Returns:

A set of all InvokedRoutines defined in this schema template.

Throws:

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

findInvokedRoutineByName

@Nonnull
Optional<? extends InvokedRoutine> findInvokedRoutineByName(@Nonnull
 String routineName)
                                                     throws RelationalException

Retrieves a InvokedRoutine by looking up its name.

Parameters:

routineName - The name of the InvokedRoutine.

Returns:

An Optional containing the InvokedRoutine if it is found, otherwise Empty.

Throws:

RelationalException

getTemporaryInvokedRoutines

@Nonnull
Collection<? extends InvokedRoutine> getTemporaryInvokedRoutines()
                                                          throws RelationalException

Throws:

RelationalException

getTransactionBoundMetadataAsString

@Nonnull
String getTransactionBoundMetadataAsString()
                                    throws RelationalException

Throws:

RelationalException

generateSchema

@Nonnull
Schema generateSchema(@Nonnull
 String databaseId,
 @Nonnull
 String schemaName)

Creates a Schema instance using the specified.

Parameters:

databaseId - The ID of the database.

schemaName - The name of the Schema.

Returns:

A new Schema instance with the specified name, database Id, version containing the same set of Tables in this SchemaTemplate.

accept

default void accept(@Nonnull
 Visitor visitor)

Specified by:

accept in interface Metadata

unwrap

@Nonnull
<T extends SchemaTemplate> T unwrap(@Nonnull
 Class<T> iface)
                             throws RelationalException

Throws:

RelationalException