sirius.db.jdbc.schema

Class Schema

java.lang.Object

sirius.db.jdbc.schema.Schema

All Implemented Interfaces:

sirius.kernel.di.Initializable, sirius.kernel.di.std.Priorized, sirius.kernel.Startable

public class Schema
extends Object
implements sirius.kernel.Startable, sirius.kernel.di.Initializable

Creates the database schemata for all databases managed via Mixing and OMA.

Field Summary

Fields inherited from interface sirius.kernel.di.std.Priorized

DEFAULT_PRIORITY

Constructor Summary

Constructors

Constructor and Description
Schema()

Method Summary

Modifier and Type	Method and Description
void	computeRequiredSchemaChanges() (Re-)Computes the changes required on the database schema to match the expectations of the software.
SchemaUpdateAction	executeSchemaUpdateAction(String id) Executes the schema change action with the given id.
Database	getDatabase(String realm) Provides the underlying database instance used to perform the actual statements.
int	getPriority()
sirius.kernel.async.Future	getReadyFuture() Provides a Future which is fullfilled when then schema is fully initialized
List<SchemaUpdateAction>	getSchemaUpdateActions() Lists the update actions which need to be performed on the current database to match the expectation of the software.
void	initialize()
boolean	isConfigured(String realm) Determines if a JDBC database is configured for the given realm
void	started()
protected void	updateSchemaAtStartup()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Schema

public Schema()

Method Detail

getDatabase

@Nullable
public Database getDatabase(String realm)

Provides the underlying database instance used to perform the actual statements.

Parameters:

realm - the realm to determine the database for

Returns:

the database used by the framework

isConfigured

public boolean isConfigured(String realm)

Determines if a JDBC database is configured for the given realm

Parameters:

realm - the realm to check for

Returns:

true if a database is configured, false otherwise

getReadyFuture

public sirius.kernel.async.Future getReadyFuture()

Provides a Future which is fullfilled when then schema is fully initialized

Returns:

the future which is fullfilled if the framework is ready

updateSchemaAtStartup

protected void updateSchemaAtStartup()

computeRequiredSchemaChanges

public void computeRequiredSchemaChanges()

(Re-)Computes the changes required on the database schema to match the expectations of the software.

All non critical changes (new tables, new columns) are performed at system startup to prevent errors.

getSchemaUpdateActions

public List<SchemaUpdateAction> getSchemaUpdateActions()

Lists the update actions which need to be performed on the current database to match the expectation of the software.

Returns:

the list of required schema changes.

executeSchemaUpdateAction

@Nullable
public SchemaUpdateAction executeSchemaUpdateAction(String id)

Executes the schema change action with the given id.

Parameters:

id - the id of the action to execute

Returns:

the action itself to fetch an error message in case of database problems

getPriority

public int getPriority()

Specified by:

getPriority in interface sirius.kernel.di.std.Priorized

Specified by:

getPriority in interface sirius.kernel.Startable

started

public void started()

Specified by:

started in interface sirius.kernel.Startable

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface sirius.kernel.di.Initializable

Throws:

Exception