Package com.github.nwillc.funjdbc.migrate

Class Manager

java.lang.Object

com.github.nwillc.funjdbc.migrate.Manager

All Implemented Interfaces:

DbAccessor, ConnectionProvider

public class Manager
extends java.lang.Object
implements DbAccessor

The migration Manager. This singleton manages a set of Migrations, performing them as needed and persisting the status of each.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Manager.MigrationComparator

Method Summary

Modifier and Type	Method	Description
void	add(Migration... migrations)	Add Migrations to the set..
void	add(java.lang.Class<? extends Migration> aMigration)	Add a Migration to the set.
void	clear()	Clear the set of migrations.
void	doMigrations()	Do migrations as needed.
void	enableMigrations()	Enable migration management in the database.
java.sql.Connection	getConnection()	Get a JDBC database connection.
ConnectionProvider	getConnectionProvider()	Gets connection provider.
static Manager	getInstance()	Gets the singleton instance.
java.util.Set<Migration>	getMigrations()	Gets the set of Migrations.
boolean	migrated(java.lang.String first)	Check if a migration has been performed.
boolean	migrationsEnabled()	Is migration management enabled in the database.
void	setConnectionProvider(ConnectionProvider connectionProvider)	Sets connection provider.

Methods inherited from interface com.github.nwillc.funjdbc.DbAccessor

dbEnrich, dbExecute, dbFind, dbInsertGetGeneratedKeys, dbQuery, dbUpdate, stream

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static Manager getInstance()

Gets the singleton instance.

Returns:

the instance

getConnectionProvider

public ConnectionProvider getConnectionProvider()

Gets connection provider.

Returns:

the connection provider

setConnectionProvider

public void setConnectionProvider(ConnectionProvider connectionProvider)

Sets connection provider.

Parameters:

connectionProvider - the connection provider

getConnection

public java.sql.Connection getConnection()
                                  throws java.sql.SQLException

Description copied from interface: ConnectionProvider

Get a JDBC database connection.

Specified by:

getConnection in interface ConnectionProvider

Returns:

A valid database connection

Throws:

java.sql.SQLException - if a connection can not be returned

add

public void add(java.lang.Class<? extends Migration> aMigration)
         throws java.lang.IllegalArgumentException

Add a Migration to the set.

Parameters:

aMigration - the a migration

Throws:

java.lang.IllegalArgumentException - the illegal argument exception

add

public void add(Migration... migrations)

Add Migrations to the set..

Parameters:

migrations - the migration

getMigrations

public java.util.Set<Migration> getMigrations()

Gets the set of Migrations.

Returns:

the migrations

clear

public void clear()

Clear the set of migrations.

migrationsEnabled

public boolean migrationsEnabled()

Is migration management enabled in the database.

Returns:

the boolean

enableMigrations

public void enableMigrations()
                      throws java.sql.SQLException

Enable migration management in the database.

Throws:

java.sql.SQLException - if the migration table can not be added to the database.

migrated

public boolean migrated(java.lang.String first)

Check if a migration has been performed.

Parameters:

first - the first

Returns:

the boolean

doMigrations

public void doMigrations()

Do migrations as needed. Perform any Migration that hasn't been completed or is designated runAlways.