fr.ifremer.adagio.core.dao.technical

Interface DatabaseSchemaDao

All Known Implementing Classes:

DatabaseSchemaDaoImpl

public interface DatabaseSchemaDao

Method Summary

Methods

Modifier and Type	Method and Description
void	generateCreateSchemaFile(String filename) Generate a file with all SQL for database creation
void	generateCreateSchemaFile(String filename, boolean doExecute, boolean withDrop, boolean withCreate)
void	generateDiffChangeLog(File outputChangelogFile, String typesToControl) Generate a diff change log
void	generateDiffReport(File outputFile, String typesToControl) Generate a diff of database
void	generateStatusReport(File outputFile) Report into a file the liquibase status of database
void	generateUpdateSchemaFile(String filename) Generate a file with update SQL statement.
void	generateUpdateSchemaFile(String filename, boolean doUpdate) Generate a file with update SQL statement, and/or execute it on database.
Version	getSchemaVersion() Retrieve the schema version, from table SYSTEM_VERSION,
Version	getSchemaVersionIfUpdate() Get the database schema version if updates is apply (the version that the database should have if updateSchema() was called)
boolean	isDbExists() Check if db files exists.
boolean	isDbLoaded() Check if connection could be open.
boolean	shouldUpdateSchema() Check if a update schema if need This is equivalent to : getSchemaVersion().compareTo(getSchemaVersionIfUpdate()) >= 0
void	updateSchema() Execute all changes need on database schema

Method Detail

generateCreateSchemaFile

void generateCreateSchemaFile(String filename)

Generate a file with all SQL for database creation

Parameters:

filename - full path of the file to generate

generateCreateSchemaFile

void generateCreateSchemaFile(String filename,
                            boolean doExecute,
                            boolean withDrop,
                            boolean withCreate)

Parameters:

filename - The file to generate, or null if only execution is need

doExecute - The SQL script must be execute on database ?

withDrop - generate drop statement ?

withCreate - generate create statement ?

generateUpdateSchemaFile

void generateUpdateSchemaFile(String filename)

Generate a file with update SQL statement. SQL statements will NOT be executed on database

Parameters:

filename -

generateUpdateSchemaFile

void generateUpdateSchemaFile(String filename,
                            boolean doUpdate)

Generate a file with update SQL statement, and/or execute it on database.

Parameters:

filename - The file to generate, or null if only execution on database is need

doUpdate - true if execution is need on database

updateSchema

void updateSchema()
                  throws DatabaseSchemaUpdateException

Execute all changes need on database schema

Throws:

DatabaseSchemaUpdateException - if could not update schema

Since:

3.4.0

getSchemaVersion

Version getSchemaVersion()
                         throws VersionNotFoundException

Retrieve the schema version, from table SYSTEM_VERSION,

Returns:

The database version (i.e. '3.2.3' @see Version)

Throws:

VersionNotFoundException - if the version could not be found, or has a bad format

Since:

3.4.0

getSchemaVersionIfUpdate

Version getSchemaVersionIfUpdate()

Get the database schema version if updates is apply (the version that the database should have if updateSchema() was called)

Returns:

The database version (i.e. '3.2.3' @see Version)

Since:

3.4.0

shouldUpdateSchema

boolean shouldUpdateSchema()
                           throws VersionNotFoundException

Check if a update schema if need This is equivalent to : getSchemaVersion().compareTo(getSchemaVersionIfUpdate()) >= 0

Returns:

true if a update is need

Throws:

VersionNotFoundException

Since:

3.4.0

isDbLoaded

boolean isDbLoaded()

Check if connection could be open. If a validation query has been set in configuration, test it

Returns:

if db is loaded

isDbExists

boolean isDbExists()

Check if db files exists. If not a database file, return true

Returns:

if db files exists

generateStatusReport

void generateStatusReport(File outputFile)
                          throws IOException

Report into a file the liquibase status of database

Throws:

IOException

generateDiffReport

void generateDiffReport(File outputFile,
                      String typesToControl)
                        throws IOException

Generate a diff of database

Parameters:

typesToControl - a comma separated database object to check (i.e Table, View, Column...). If null, all types are checked

Throws:

IOException

generateDiffChangeLog

void generateDiffChangeLog(File outputChangelogFile,
                         String typesToControl)
                           throws IOException

Generate a diff change log

Parameters:

typesToControl - a comma separated database object to check (i.e Table, View, Column...). If null, all types are checked

Throws:

IOException