com.edorasware.commons.core.persistence.schema

Interface DatabaseSchemaService

All Known Implementing Classes:

DefaultDatabaseSchemaService

public interface DatabaseSchemaService

Database schema service which provides methods to create, validate ,upgrade and drop the schema.

Method Summary

Modifier and Type	Method and Description
void	create() Creates the database schema, upgrading an existing schema if it is present.
void	drop() Drops the database schema.
DatabaseSchemaStatus<org.flywaydb.core.api.MigrationInfo>	getStatus() Returns the status of the database schema.
boolean	isNewSchema() Checks whether the database initialization created a new schema.
void	setListeners(DatabaseSchemaServiceListener... databaseSchemaServiceListener) Set the DatabaseSchemaServiceListener which gets called before and after each operation.
void	validate() Validates the database schema and checks if the codebase is able to use the schema.

Method Detail

create

void create()

Creates the database schema, upgrading an existing schema if it is present.

Throws:

DatabaseSchemaException - if there was an error creating the schema

validate

void validate()

Validates the database schema and checks if the codebase is able to use the schema.

Throws:

DatabaseSchemaException - if the database schema is not valid

drop

void drop()

Drops the database schema.

Throws:

DatabaseSchemaException - if there was an error dropping the schema

getStatus

DatabaseSchemaStatus<org.flywaydb.core.api.MigrationInfo> getStatus()

Returns the status of the database schema.

Returns:

the database schema status

Throws:

DatabaseSchemaException - if there was an error getting the status of the schema

setListeners

void setListeners(DatabaseSchemaServiceListener... databaseSchemaServiceListener)

Set the DatabaseSchemaServiceListener which gets called before and after each operation.

Parameters:

databaseSchemaServiceListener - the database schema service listener

isNewSchema

boolean isNewSchema()

Checks whether the database initialization created a new schema.

Note

this will only return the correct value after the Flyway migration has been triggered and the baseline migration has been applied.

Returns:

true if the Flyway migration involved the creation of a new schema (baseline applied)