Module io.ebean.migration

Package io.ebean.migration

Class MigrationRunner

java.lang.Object

io.ebean.migration.MigrationRunner

public class MigrationRunner
extends Object

Runs the DB migration typically on application start.

Field Summary

Fields

Modifier and Type	Field	Description
protected final MigrationConfig	migrationConfig

Constructor Summary

Constructors

Constructor	Description
MigrationRunner(MigrationConfig migrationConfig)

Method Summary

Modifier and Type	Method	Description
List<MigrationResource>	checkState()	Return the migrations that would be applied if the migration is run.
List<MigrationResource>	checkState(MigrationContext context)	Return the migrations that would be applied if the migration is run.
List<MigrationResource>	checkState(Connection connection)	Return the migrations that would be applied if the migration is run.
List<MigrationResource>	checkState(DataSource dataSource)	Return the migrations that would be applied if the migration is run.
void	run()	Run by creating a DB connection from driver, url, username defined in MigrationConfig.
void	run(MigrationContext context)	Run the migrations if there are any that need running.
void	run(Connection connection)	Run the migrations if there are any that need running.
void	run(DataSource dataSource)	Run using the connection from the DataSource.

Methods inherited from class java.lang.Object

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

Field Details

migrationConfig

protected final MigrationConfig migrationConfig

Constructor Details

MigrationRunner

public MigrationRunner(MigrationConfig migrationConfig)

Method Details

checkState

public List<MigrationResource> checkState()

Return the migrations that would be applied if the migration is run.

checkState

public List<MigrationResource> checkState(DataSource dataSource)

Return the migrations that would be applied if the migration is run.

checkState

public List<MigrationResource> checkState(Connection connection)

Return the migrations that would be applied if the migration is run.

checkState

public List<MigrationResource> checkState(MigrationContext context)

Return the migrations that would be applied if the migration is run.

run

public void run()

Run by creating a DB connection from driver, url, username defined in MigrationConfig.

run

public void run(DataSource dataSource)

Run using the connection from the DataSource.

run

public void run(Connection connection)

Run the migrations if there are any that need running.

run

public void run(MigrationContext context)

Run the migrations if there are any that need running.