org.flywaydb.core

Class Flyway

java.lang.Object

org.flywaydb.core.Flyway

public class Flyway
extends Object

This is the centre point of Flyway, and for most users, the only class they will ever have to deal with.

It is THE public API from which all important Flyway functions such as clean, validate and migrate can be called.

Constructor Summary

Constructors

Constructor and Description
Flyway() Creates a new instance of Flyway.

Method Summary

Methods

Modifier and Type	Method and Description
void	clean() Drops all objects (tables, views, procedures, triggers, ...) in the configured schemas.
void	configure(Properties properties) Configures Flyway with these properties.
FlywayCallback[]	getCallbacks() Gets the callbacks for lifecycle notifications.
ClassLoader	getClassLoader() Retrieves the ClassLoader to use for resolving migrations on the classpath.
DataSource	getDataSource() Retrieves the dataSource to use to access the database.
String	getEncoding() Retrieves the encoding of Sql migrations.
String	getInitDescription() Retrieves the description to tag an existing schema with when executing init.
MigrationVersion	getInitVersion() Retrieves the version to tag an existing schema with when executing init.
String[]	getLocations() Retrieves the locations to scan recursively for migrations.
String	getPlaceholderPrefix() Retrieves the prefix of every placeholder.
Map<String,String>	getPlaceholders() Retrieves the map of <placeholder, replacementValue> to apply to sql migration scripts.
String	getPlaceholderSuffix() Retrieves the suffix of every placeholder.
MigrationResolver[]	getResolvers() Retrieves the The custom MigrationResolvers to be used in addition to the built-in ones for resolving Migrations to apply.
String[]	getSchemas() Retrieves the schemas managed by Flyway.
String	getSqlMigrationPrefix() Retrieves the file name prefix for sql migrations.
String	getSqlMigrationSeparator() Retrieves the file name separator for sql migrations.
String	getSqlMigrationSuffix() Retrieves the file name suffix for sql migrations.
String	getTable() Retrieves the name of the schema metadata table that will be used by Flyway.
MigrationVersion	getTarget() Retrieves the target version up to which Flyway should run migrations.
MigrationInfoService	info() Retrieves the complete information about all the migrations including applied, pending and current migrations with details and status.
void	init() Creates and initializes the Flyway metadata table.
boolean	isCleanOnValidationError() Whether to automatically call clean or not when a validation error occurs.
boolean	isIgnoreFailedFutureMigration() Whether to ignore failed future migrations when reading the metadata table.
boolean	isInitOnMigrate() Whether to automatically call init when migrate is executed against a non-empty schema with no metadata table.
boolean	isOutOfOrder() Allows migrations to be run "out of order".
boolean	isValidateOnMigrate() Whether to automatically call validate or not when running migrate.
int	migrate() Starts the database migration.
void	repair() Repairs the Flyway metadata table.
void	setCallbacks(FlywayCallback... callbacks) Set the callbacks for lifecycle notifications.
void	setCallbacks(String... callbacks) Set the callbacks for lifecycle notifications.
void	setClassLoader(ClassLoader classLoader) Sets the ClassLoader to use for resolving migrations on the classpath.
void	setCleanOnValidationError(boolean cleanOnValidationError) Whether to automatically call clean or not when a validation error occurs.
void	setDataSource(DataSource dataSource) Sets the datasource to use.
void	setDataSource(String url, String user, String password, String... initSqls) Sets the datasource to use.
void	setEncoding(String encoding) Sets the encoding of Sql migrations.
void	setIgnoreFailedFutureMigration(boolean ignoreFailedFutureMigration) Ignores failed future migrations when reading the metadata table.
void	setInitDescription(String initDescription) Sets the description to tag an existing schema with when executing init.
void	setInitOnMigrate(boolean initOnMigrate) Whether to automatically call init when migrate is executed against a non-empty schema with no metadata table.
void	setInitVersion(MigrationVersion initVersion) Sets the version to tag an existing schema with when executing init.
void	setInitVersion(String initVersion) Sets the version to tag an existing schema with when executing init.
void	setLocations(String... locations) Sets the locations to scan recursively for migrations.
void	setOutOfOrder(boolean outOfOrder) Allows migrations to be run "out of order".
void	setPlaceholderPrefix(String placeholderPrefix) Sets the prefix of every placeholder.
void	setPlaceholders(Map<String,String> placeholders) Sets the placeholders to replace in sql migration scripts.
void	setPlaceholderSuffix(String placeholderSuffix) Sets the suffix of every placeholder.
void	setResolvers(MigrationResolver... resolvers) Sets custom MigrationResolvers to be used in addition to the built-in ones for resolving Migrations to apply.
void	setResolvers(String... resolvers) Sets custom MigrationResolvers to be used in addition to the built-in ones for resolving Migrations to apply.
void	setSchemas(String... schemas) Sets the schemas managed by Flyway.
void	setSqlMigrationPrefix(String sqlMigrationPrefix) Sets the file name prefix for sql migrations.
void	setSqlMigrationSeparator(String sqlMigrationSeparator) Sets the file name separator for sql migrations.
void	setSqlMigrationSuffix(String sqlMigrationSuffix) Sets the file name suffix for sql migrations.
void	setTable(String table) Sets the name of the schema metadata table that will be used by Flyway.
void	setTarget(MigrationVersion target) Sets the target version up to which Flyway should run migrations.
void	setTarget(String target) Sets the target version up to which Flyway should run migrations.
void	setValidateOnMigrate(boolean validateOnMigrate) Whether to automatically call validate or not when running migrate.
void	validate() Validate applied migration with classpath migrations to detect accidental changes.

Methods inherited from class java.lang.Object

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

Constructor Detail

Flyway

public Flyway()

Creates a new instance of Flyway. This is your starting point.

Method Detail

getLocations

public String[] getLocations()

Retrieves the locations to scan recursively for migrations.

The location type is determined by its prefix. Unprefixed locations or locations starting with classpath: point to a package on the classpath and may contain both sql and java-based migrations. Locations starting with filesystem: point to a directory on the filesystem and may only contain sql migrations.

Returns:

Locations to scan recursively for migrations. (default: db/migration)

getEncoding

public String getEncoding()

Retrieves the encoding of Sql migrations.

Returns:

The encoding of Sql migrations. (default: UTF-8)

getSchemas

public String[] getSchemas()

Retrieves the schemas managed by Flyway. These schema names are case-sensitive.

Consequences:

• The first schema in the list will be automatically set as the default one during the migration.
• The first schema in the list will also be the one containing the metadata table.
• The schemas will be cleaned in the order of this list.

Returns:

The schemas managed by Flyway. (default: The default schema for the datasource connection)

getTable

public String getTable()

Retrieves the name of the schema metadata table that will be used by Flyway.

By default (single-schema mode) the metadata table is placed in the default schema for the connection provided by the datasource.

When the flyway.schemas property is set (multi-schema mode), the metadata table is placed in the first schema of the list.

Returns:

The name of the schema metadata table that will be used by flyway. (default: schema_version)

getTarget

public MigrationVersion getTarget()

Retrieves the target version up to which Flyway should run migrations. Migrations with a higher version number will not be applied.

Returns:

The target version up to which Flyway should run migrations. Migrations with a higher version number will not be applied. (default: the latest version)

getPlaceholders

public Map<String,String> getPlaceholders()

Retrieves the map of <placeholder, replacementValue> to apply to sql migration scripts.

Returns:

The map of <placeholder, replacementValue> to apply to sql migration scripts.

getPlaceholderPrefix

public String getPlaceholderPrefix()

Retrieves the prefix of every placeholder.

Returns:

The prefix of every placeholder. (default: ${ )

getPlaceholderSuffix

public String getPlaceholderSuffix()

Retrieves the suffix of every placeholder.

Returns:

The suffix of every placeholder. (default: } )

getSqlMigrationPrefix

public String getSqlMigrationPrefix()

Retrieves the file name prefix for sql migrations.

Sql migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix , which using the defaults translates to V1_1__My_description.sql

Returns:

The file name prefix for sql migrations. (default: V)

getSqlMigrationSeparator

public String getSqlMigrationSeparator()

Retrieves the file name separator for sql migrations.

Sql migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix , which using the defaults translates to V1_1__My_description.sql

Returns:

The file name separator for sql migrations. (default: __)

getSqlMigrationSuffix

public String getSqlMigrationSuffix()

Retrieves the file name suffix for sql migrations.

Sql migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix , which using the defaults translates to V1_1__My_description.sql

Returns:

The file name suffix for sql migrations. (default: .sql)

isIgnoreFailedFutureMigration

public boolean isIgnoreFailedFutureMigration()

Whether to ignore failed future migrations when reading the metadata table. These are migrations that were performed by a newer deployment of the application that are not yet available in this version. For example: we have migrations available on the classpath up to version 3.0. The metadata table indicates that a migration to version 4.0 (unknown to us) has already been attempted and failed. Instead of bombing out (fail fast) with an exception, a warning is logged and Flyway terminates normally. This is useful for situations where a database rollback is not an option. An older version of the application can then be redeployed, even though a newer one failed due to a bad migration.

Returns:

true to terminate normally and log a warning, false to fail fast with an exception. (default: false)

isValidateOnMigrate

public boolean isValidateOnMigrate()

Whether to automatically call validate or not when running migrate.

Returns:

true if validate should be called. false if not. (default: true)

isCleanOnValidationError

public boolean isCleanOnValidationError()

Whether to automatically call clean or not when a validation error occurs.

This is exclusively intended as a convenience for development. Even tough we strongly recommend not to change migration scripts once they have been checked into SCM and run, this provides a way of dealing with this case in a smooth manner. The database will be wiped clean automatically, ensuring that the next migration will bring you back to the state checked into SCM.

Warning ! Do not enable in production !

Returns:

true if clean should be called. false if not. (default: false)

getInitVersion

public MigrationVersion getInitVersion()

Retrieves the version to tag an existing schema with when executing init.

Returns:

The version to tag an existing schema with when executing init. (default: 1)

getInitDescription

public String getInitDescription()

Retrieves the description to tag an existing schema with when executing init.

Returns:

The description to tag an existing schema with when executing init. (default: << Flyway Init >>)

isInitOnMigrate

public boolean isInitOnMigrate()

Whether to automatically call init when migrate is executed against a non-empty schema with no metadata table. This schema will then be initialized with the initialVersion before executing the migrations. Only migrations above initialVersion will then be applied.

This is useful for initial Flyway production deployments on projects with an existing DB.

Be careful when enabling this as it removes the safety net that ensures Flyway does not migrate the wrong database in case of a configuration mistake!

Returns:

true if init should be called on migrate for non-empty schemas, false if not. (default: false)

isOutOfOrder

public boolean isOutOfOrder()

Allows migrations to be run "out of order".

If you already have versions 1 and 3 applied, and now a version 2 is found, it will be applied too instead of being ignored.

Returns:

true if outOfOrder migrations should be applied, false if not. (default: false)

getResolvers

public MigrationResolver[] getResolvers()

Retrieves the The custom MigrationResolvers to be used in addition to the built-in ones for resolving Migrations to apply.

Returns:

The custom MigrationResolvers to be used in addition to the built-in ones for resolving Migrations to apply. An empty array if none. (default: none)

getDataSource

public DataSource getDataSource()

Retrieves the dataSource to use to access the database. Must have the necessary privileges to execute ddl.

Returns:

The dataSource to use to access the database. Must have the necessary privileges to execute ddl.

getClassLoader

public ClassLoader getClassLoader()

Retrieves the ClassLoader to use for resolving migrations on the classpath.

Returns:

The ClassLoader to use for resolving migrations on the classpath. (default: Thread.currentThread().getContextClassLoader() )

setIgnoreFailedFutureMigration

public void setIgnoreFailedFutureMigration(boolean ignoreFailedFutureMigration)

Ignores failed future migrations when reading the metadata table. These are migrations that were performed by a newer deployment of the application that are not yet available in this version. For example: we have migrations available on the classpath up to version 3.0. The metadata table indicates that a migration to version 4.0 (unknown to us) has already been attempted and failed. Instead of bombing out (fail fast) with an exception, a warning is logged and Flyway terminates normally. This is useful for situations where a database rollback is not an option. An older version of the application can then be redeployed, even though a newer one failed due to a bad migration.

Parameters:

ignoreFailedFutureMigration - true to terminate normally and log a warning, false to fail fast with an exception. (default: false)

setValidateOnMigrate

public void setValidateOnMigrate(boolean validateOnMigrate)

Whether to automatically call validate or not when running migrate.

Parameters:

validateOnMigrate - true if validate should be called. false if not. (default: true)

setCleanOnValidationError

public void setCleanOnValidationError(boolean cleanOnValidationError)

Whether to automatically call clean or not when a validation error occurs.

This is exclusively intended as a convenience for development. Even tough we strongly recommend not to change migration scripts once they have been checked into SCM and run, this provides a way of dealing with this case in a smooth manner. The database will be wiped clean automatically, ensuring that the next migration will bring you back to the state checked into SCM.

Warning ! Do not enable in production !

Parameters:

cleanOnValidationError - true if clean should be called. false if not. (default: false)

setLocations

public void setLocations(String... locations)

Sets the locations to scan recursively for migrations.

The location type is determined by its prefix. Unprefixed locations or locations starting with classpath: point to a package on the classpath and may contain both sql and java-based migrations. Locations starting with filesystem: point to a directory on the filesystem and may only contain sql migrations.

Parameters:

locations - Locations to scan recursively for migrations. (default: db/migration)

setEncoding

public void setEncoding(String encoding)

Sets the encoding of Sql migrations.

Parameters:

encoding - The encoding of Sql migrations. (default: UTF-8)

setSchemas

public void setSchemas(String... schemas)

Sets the schemas managed by Flyway. These schema names are case-sensitive. (default: The default schema for the datasource connection)

Consequences:

• The first schema in the list will be automatically set as the default one during the migration.
• The first schema in the list will also be the one containing the metadata table.
• The schemas will be cleaned in the order of this list.

Parameters:

schemas - The schemas managed by Flyway. May not be null. Must contain at least one element.

setTable

public void setTable(String table)

Sets the name of the schema metadata table that will be used by Flyway.

By default (single-schema mode) the metadata table is placed in the default schema for the connection provided by the datasource.

When the flyway.schemas property is set (multi-schema mode), the metadata table is placed in the first schema of the list.

Parameters:

table - The name of the schema metadata table that will be used by flyway. (default: schema_version)

setTarget

public void setTarget(MigrationVersion target)

Sets the target version up to which Flyway should run migrations. Migrations with a higher version number will not be applied.

Parameters:

target - The target version up to which Flyway should run migrations. Migrations with a higher version number will not be applied. (default: the latest version)

setTarget

public void setTarget(String target)

Sets the target version up to which Flyway should run migrations. Migrations with a higher version number will not be applied.

Parameters:

target - The target version up to which Flyway should run migrations. Migrations with a higher version number will not be applied. (default: the latest version)

setPlaceholders

public void setPlaceholders(Map<String,String> placeholders)

Sets the placeholders to replace in sql migration scripts.

Parameters:

placeholders - The map of <placeholder, replacementValue> to apply to sql migration scripts.

setPlaceholderPrefix

public void setPlaceholderPrefix(String placeholderPrefix)

Sets the prefix of every placeholder.

Parameters:

placeholderPrefix - The prefix of every placeholder. (default: ${ )

setPlaceholderSuffix

public void setPlaceholderSuffix(String placeholderSuffix)

Sets the suffix of every placeholder.

Parameters:

placeholderSuffix - The suffix of every placeholder. (default: } )

setSqlMigrationPrefix

public void setSqlMigrationPrefix(String sqlMigrationPrefix)

Sets the file name prefix for sql migrations.

Sql migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix , which using the defaults translates to V1_1__My_description.sql

Parameters:

sqlMigrationPrefix - The file name prefix for sql migrations (default: V)

setSqlMigrationSeparator

public void setSqlMigrationSeparator(String sqlMigrationSeparator)

Sets the file name separator for sql migrations.

Sql migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix , which using the defaults translates to V1_1__My_description.sql

Parameters:

sqlMigrationSeparator - The file name separator for sql migrations (default: __)

setSqlMigrationSuffix

public void setSqlMigrationSuffix(String sqlMigrationSuffix)

Sets the file name suffix for sql migrations.

Sql migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix , which using the defaults translates to V1_1__My_description.sql

Parameters:

sqlMigrationSuffix - The file name suffix for sql migrations (default: .sql)

setDataSource

public void setDataSource(DataSource dataSource)

Sets the datasource to use. Must have the necessary privileges to execute ddl.

Parameters:

dataSource - The datasource to use. Must have the necessary privileges to execute ddl.

setDataSource

public void setDataSource(String url,
                 String user,
                 String password,
                 String... initSqls)

Sets the datasource to use. Must have the necessary privileges to execute ddl.

To use a custom ClassLoader, setClassLoader() must be called prior to calling this method.

Parameters:

url - The JDBC URL of the database.

user - The user of the database.

password - The password of the database.

initSqls - The (optional) sql statements to execute to initialize a connection immediately after obtaining it.

setClassLoader

public void setClassLoader(ClassLoader classLoader)

Sets the ClassLoader to use for resolving migrations on the classpath.

Parameters:

classLoader - The ClassLoader to use for resolving migrations on the classpath. (default: Thread.currentThread().getContextClassLoader() )

setInitVersion

public void setInitVersion(MigrationVersion initVersion)

Sets the version to tag an existing schema with when executing init.

Parameters:

initVersion - The version to tag an existing schema with when executing init. (default: 1)

setInitVersion

public void setInitVersion(String initVersion)

Sets the version to tag an existing schema with when executing init.

Parameters:

initVersion - The version to tag an existing schema with when executing init. (default: 1)

setInitDescription

public void setInitDescription(String initDescription)

Sets the description to tag an existing schema with when executing init.

Parameters:

initDescription - The description to tag an existing schema with when executing init. (default: << Flyway Init >>)

setInitOnMigrate

public void setInitOnMigrate(boolean initOnMigrate)

Whether to automatically call init when migrate is executed against a non-empty schema with no metadata table. This schema will then be initialized with the initialVersion before executing the migrations. Only migrations above initialVersion will then be applied.

This is useful for initial Flyway production deployments on projects with an existing DB.

Be careful when enabling this as it removes the safety net that ensures Flyway does not migrate the wrong database in case of a configuration mistake!

Parameters:

initOnMigrate - true if init should be called on migrate for non-empty schemas, false if not. (default: false)

setOutOfOrder

public void setOutOfOrder(boolean outOfOrder)

Allows migrations to be run "out of order".

If you already have versions 1 and 3 applied, and now a version 2 is found, it will be applied too instead of being ignored.

Parameters:

outOfOrder - true if outOfOrder migrations should be applied, false if not. (default: false)

getCallbacks

public FlywayCallback[] getCallbacks()

Gets the callbacks for lifecycle notifications.

Returns:

The callbacks for lifecycle notifications. An empty array if none. (default: none)

setCallbacks

public void setCallbacks(FlywayCallback... callbacks)

Set the callbacks for lifecycle notifications.

Parameters:

callbacks - The callbacks for lifecycle notifications. (default: none)

setCallbacks

public void setCallbacks(String... callbacks)

Set the callbacks for lifecycle notifications.

Parameters:

callbacks - The fully qualified class names of the callbacks for lifecycle notifications. (default: none)

setResolvers

public void setResolvers(MigrationResolver... resolvers)

Sets custom MigrationResolvers to be used in addition to the built-in ones for resolving Migrations to apply.

Parameters:

resolvers - The custom MigrationResolvers to be used in addition to the built-in ones for resolving Migrations to apply. (default: empty list)

setResolvers

public void setResolvers(String... resolvers)

Sets custom MigrationResolvers to be used in addition to the built-in ones for resolving Migrations to apply.

Parameters:

resolvers - The fully qualified class names of the custom MigrationResolvers to be used in addition to the built-in ones for resolving Migrations to apply. (default: empty list)

migrate

public int migrate()
            throws FlywayException

Starts the database migration. All pending migrations will be applied in order. Calling migrate on an up-to-date database has no effect.

Returns:

The number of successfully applied migrations.

Throws:

FlywayException - when the migration failed.

validate

public void validate()
              throws FlywayException

Validate applied migration with classpath migrations to detect accidental changes.

Throws:

FlywayException - when the validation failed.

clean

public void clean()

Drops all objects (tables, views, procedures, triggers, ...) in the configured schemas. The schemas are cleaned in the order specified by the schemas property.

Throws:

FlywayException - when the clean fails.

info

public MigrationInfoService info()

Retrieves the complete information about all the migrations including applied, pending and current migrations with details and status.

Returns:

All migrations sorted by version, oldest first.

Throws:

FlywayException - when the info retrieval failed.

init

public void init()
          throws FlywayException

Creates and initializes the Flyway metadata table.

Throws:

FlywayException - when the schema initialization failed.

repair

public void repair()
            throws FlywayException

Repairs the Flyway metadata table. This will perform the following actions:

• Remove any failed migrations on databases without DDL transactions (User objects left behind must still be cleaned up manually)
• Correct wrong checksums

Throws:

FlywayException - when the metadata table repair failed.

configure

public void configure(Properties properties)

Configures Flyway with these properties. This overwrites any existing configuration. Property names are documented in the flyway maven plugin.

To use a custom ClassLoader, setClassLoader() must be called prior to calling this method.

Parameters:

properties - Properties used for configuration.

Throws:

FlywayException - when the configuration failed.