Flyway (flyway-core 5.0.0 API)

java.lang.Object
- org.flywaydb.core.Flyway

All Implemented Interfaces:

FlywayConfiguration
```
public class Flyway
extends Object
implements FlywayConfiguration
```
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.
`Flyway(ClassLoader classLoader)` Creates a new instance of Flyway.
`Flyway(FlywayConfiguration configuration)` Creates a new instance of Flyway.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`baseline()` Baselines an existing database, excluding all migrations up to and including baselineVersion.
`void`	`clean()` Drops all objects (tables, views, procedures, triggers, ...) in the configured schemas.
`void`	`configure(Map<String,String> props)` Configures Flyway with these properties.
`void`	`configure(Properties properties)` Configures Flyway with these properties.
`String`	`getBaselineDescription()` Retrieves the description to tag an existing schema with when executing baseline.
`MigrationVersion`	`getBaselineVersion()` Retrieves the version to tag an existing schema with when executing baseline.
`FlywayCallback[]`	`getCallbacks()` Gets the callbacks for lifecycle notifications.
`ClassLoader`	`getClassLoader()` Retrieves the ClassLoader to use for loading migrations, resolvers, etc from the classpath.
`DataSource`	`getDataSource()` Retrieves the dataSource to use to access the database.
`OutputStream`	`getDryRunOutput()` The stream where to output the SQL statements of a migration dry run.
`String`	`getEncoding()` Retrieves the encoding of Sql migrations.
`ErrorHandler[]`	`getErrorHandlers()` Handlers for errors and warnings that occur during a migration.
`String`	`getInstalledBy()` The username that will be recorded in the schema history table as having applied the migration.
`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.
`String`	`getRepeatableSqlMigrationPrefix()` Retrieves the file name prefix for repeatable SQL migrations.
`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()` The file name prefix for versioned SQL migrations.
`String`	`getSqlMigrationSeparator()` Retrieves the file name separator for sql migrations.
`String`	`getSqlMigrationSuffix()` Retrieves the file name suffix for sql migrations.
`String[]`	`getSqlMigrationSuffixes()` The file name suffixes for SQL migrations.
`String`	`getTable()` Retrieves the name of the schema schema history table that will be used by Flyway.
`MigrationVersion`	`getTarget()` Retrieves the target version up to which Flyway should consider migrations.
`String`	`getUndoSqlMigrationPrefix()` The file name prefix for undo SQL migrations.
`MigrationInfoService`	`info()` Retrieves the complete information about all the migrations including applied, pending and current migrations with details and status.
`boolean`	`isBaselineOnMigrate()` Whether to automatically call baseline when migrate is executed against a non-empty schema with no schema history table.
`boolean`	`isCleanDisabled()` Whether to disable clean.
`boolean`	`isCleanOnValidationError()` Whether to automatically call clean or not when a validation error occurs.
`boolean`	`isGroup()` Whether to group all pending migrations together in the same transaction when applying them (only recommended for databases with support for DDL transactions).
`boolean`	`isIgnoreFutureMigrations()` Ignore future migrations when reading the schema history table.
`boolean`	`isIgnoreMissingMigrations()` Ignore missing migrations when reading the schema history table.
`boolean`	`isMixed()` Whether to allow mixing transactional and non-transactional statements within the same migration.
`boolean`	`isOutOfOrder()` Allows migrations to be run "out of order".
`boolean`	`isPlaceholderReplacement()` Checks whether placeholders should be replaced.
`boolean`	`isSkipDefaultCallbacks()` Whether Flyway should skip the default callbacks.
`boolean`	`isSkipDefaultResolvers()` Whether Flyway should skip the default resolvers.
`boolean`	`isValidateOnMigrate()` Whether to automatically call validate or not when running migrate.
`int`	`migrate()` Starts the database migration.
`void`	`repair()` Repairs the Flyway schema history table.
`void`	`setBaselineDescription(String baselineDescription)` Sets the description to tag an existing schema with when executing baseline.
`void`	`setBaselineOnMigrate(boolean baselineOnMigrate)` Whether to automatically call baseline when migrate is executed against a non-empty schema with no schema history table.
`void`	`setBaselineVersion(MigrationVersion baselineVersion)` Sets the version to tag an existing schema with when executing baseline.
`void`	`setBaselineVersionAsString(String baselineVersion)` Sets the version to tag an existing schema with when executing baseline.
`void`	`setCallbacks(FlywayCallback... callbacks)` Set the callbacks for lifecycle notifications.
`void`	`setCallbacksAsClassNames(String... callbacks)` Set the callbacks for lifecycle notifications.
`void`	`setClassLoader(ClassLoader classLoader)` Deprecated. Will be removed in Flyway 6.0. Use `Flyway(ClassLoader)` instead.
`void`	`setCleanDisabled(boolean cleanDisabled)` Whether to disable clean.
`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`	`setDryRunOutput(OutputStream dryRunOutput)` Sets the stream where to output the SQL statements of a migration dry run.
`void`	`setDryRunOutputAsFile(File dryRunOutput)` Sets the file where to output the SQL statements of a migration dry run.
`void`	`setDryRunOutputAsFileName(String dryRunOutputFileName)` Sets the file where to output the SQL statements of a migration dry run.
`void`	`setEncoding(String encoding)` Sets the encoding of Sql migrations.
`void`	`setErrorHandlers(ErrorHandler... errorHandlers)` Handlers for errors and warnings that occur during a migration.
`void`	`setErrorHandlersAsClassNames(String... errorHandlerClassNames)` Handlers for errors and warnings that occur during a migration.
`void`	`setGroup(boolean group)` Whether to group all pending migrations together in the same transaction when applying them (only recommended for databases with support for DDL transactions).
`void`	`setIgnoreFutureMigrations(boolean ignoreFutureMigrations)` Whether to ignore future migrations when reading the schema history table.
`void`	`setIgnoreMissingMigrations(boolean ignoreMissingMigrations)` Ignore missing migrations when reading the schema history table.
`void`	`setInstalledBy(String installedBy)` The username that will be recorded in the schema history table as having applied the migration.
`void`	`setLocations(String... locations)` Sets the locations to scan recursively for migrations.
`void`	`setMixed(boolean mixed)` Whether to allow mixing transactional and non-transactional statements within the same migration.
`void`	`setOutOfOrder(boolean outOfOrder)` Allows migrations to be run "out of order".
`void`	`setPlaceholderPrefix(String placeholderPrefix)` Sets the prefix of every placeholder.
`void`	`setPlaceholderReplacement(boolean placeholderReplacement)` Sets whether placeholders should be replaced.
`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`	`setRepeatableSqlMigrationPrefix(String repeatableSqlMigrationPrefix)` Sets the file name prefix for repeatable sql migrations.
`void`	`setResolvers(MigrationResolver... resolvers)` Sets custom MigrationResolvers to be used in addition to the built-in ones for resolving Migrations to apply.
`void`	`setResolversAsClassNames(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`	`setSkipDefaultCallbacks(boolean skipDefaultCallbacks)` Whether Flyway should skip the default callbacks.
`void`	`setSkipDefaultResolvers(boolean skipDefaultResolvers)` Whether Flyway should skip the default resolvers.
`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)` Deprecated. Use `setSqlMigrationSuffixes(String...)` instead. Will be removed in Flyway 6.0.0.
`void`	`setSqlMigrationSuffixes(String... sqlMigrationSuffixes)` The file name suffixes for SQL migrations.
`void`	`setTable(String table)` Sets the name of the schema schema history table that will be used by Flyway.
`void`	`setTarget(MigrationVersion target)` Sets the target version up to which Flyway should consider migrations.
`void`	`setTargetAsString(String target)` Sets the target version up to which Flyway should consider migrations.
`void`	`setUndoSqlMigrationPrefix(String undoSqlMigrationPrefix)` Sets the file name prefix for undo SQL migrations.
`void`	`setValidateOnMigrate(boolean validateOnMigrate)` Whether to automatically call validate or not when running migrate.
`int`	`undo()` Undoes the most recently applied versioned migration.
`void`	`validate()` Validate applied migrations against resolved ones (on the filesystem or classpath) to detect accidental changes that may prevent the schema(s) from being recreated exactly.

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.
  - Flyway
```
public Flyway(ClassLoader classLoader)
```
    Creates a new instance of Flyway. This is your starting point.
    
    Parameters:
    
    classLoader - The ClassLoader to use for loading migrations, resolvers, etc from the classpath. (default: Thread.currentThread().getContextClassLoader() )
  - Flyway
```
public Flyway(FlywayConfiguration configuration)
```
    Creates a new instance of Flyway. This is your starting point.
    
    Parameters:
    
    configuration - The configuration to use.
- Method Detail
  - getLocations
```
public String[] getLocations()
```
    Description copied from interface: FlywayConfiguration
    
    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.
    
    Specified by:
    
    getLocations in interface FlywayConfiguration
    
    Returns:
    
    Locations to scan recursively for migrations. (default: db/migration)
  - getEncoding
```
public String getEncoding()
```
    Description copied from interface: FlywayConfiguration
    
    Retrieves the encoding of Sql migrations.
    
    Specified by:
    
    getEncoding in interface FlywayConfiguration
    
    Returns:
    
    The encoding of Sql migrations. (default: UTF-8)
  - getSchemas
```
public String[] getSchemas()
```
    Description copied from interface: FlywayConfiguration
    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 schema history table.
    - The schemas will be cleaned in the order of this list.
    Specified by:
    
    getSchemas in interface FlywayConfiguration
    
    Returns:
    
    The schemas managed by Flyway. (default: The default schema for the datasource connection)
  - getTable
```
public String getTable()
```
    Description copied from interface: FlywayConfiguration
    
    Retrieves the name of the schema schema history table that will be used by Flyway.
    By default (single-schema mode) the schema history 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 schema history table is placed in the first schema of the list.
    
    Specified by:
    
    getTable in interface FlywayConfiguration
    
    Returns:
    
    The name of the schema schema history table that will be used by flyway. (default: flyway_schema_history)
  - getTarget
```
public MigrationVersion getTarget()
```
    Description copied from interface: FlywayConfiguration
    
    Retrieves the target version up to which Flyway should consider migrations. Migrations with a higher version number will be ignored. The special value current designates the current version of the schema.
    
    Specified by:
    
    getTarget in interface FlywayConfiguration
    
    Returns:
    
    The target version up to which Flyway should consider migrations. (default: the latest version)
  - isPlaceholderReplacement
```
public boolean isPlaceholderReplacement()
```
    Description copied from interface: FlywayConfiguration
    
    Checks whether placeholders should be replaced.
    
    Specified by:
    
    isPlaceholderReplacement in interface FlywayConfiguration
    
    Returns:
    
    Whether placeholders should be replaced. (default: true)
  - getPlaceholders
```
public Map<String,String> getPlaceholders()
```
    Description copied from interface: FlywayConfiguration
    
    Retrieves the map of <placeholder, replacementValue> to apply to sql migration scripts.
    
    Specified by:
    
    getPlaceholders in interface FlywayConfiguration
    
    Returns:
    
    The map of <placeholder, replacementValue> to apply to sql migration scripts.
  - getPlaceholderPrefix
```
public String getPlaceholderPrefix()
```
    Description copied from interface: FlywayConfiguration
    
    Retrieves the prefix of every placeholder.
    
    Specified by:
    
    getPlaceholderPrefix in interface FlywayConfiguration
    
    Returns:
    
    The prefix of every placeholder. (default: ${ )
  - getPlaceholderSuffix
```
public String getPlaceholderSuffix()
```
    Description copied from interface: FlywayConfiguration
    
    Retrieves the suffix of every placeholder.
    
    Specified by:
    
    getPlaceholderSuffix in interface FlywayConfiguration
    
    Returns:
    
    The suffix of every placeholder. (default: } )
  - getSqlMigrationPrefix
```
public String getSqlMigrationPrefix()
```
    Description copied from interface: FlywayConfiguration
    
    The file name prefix for versioned SQL migrations.
    Versioned SQL migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix , which using the defaults translates to V1.1__My_description.sql
    
    Specified by:
    
    getSqlMigrationPrefix in interface FlywayConfiguration
    
    Returns:
    
    The file name prefix for sql migrations. (default: V)
  - getRepeatableSqlMigrationPrefix
```
public String getRepeatableSqlMigrationPrefix()
```
    Description copied from interface: FlywayConfiguration
    
    Retrieves the file name prefix for repeatable SQL migrations.
    Repeatable SQL migrations have the following file name structure: prefixSeparatorDESCRIPTIONsuffix , which using the defaults translates to R__My_description.sql
    
    Specified by:
    
    getRepeatableSqlMigrationPrefix in interface FlywayConfiguration
    
    Returns:
    
    The file name prefix for repeatable sql migrations. (default: R)
  - getSqlMigrationSeparator
```
public String getSqlMigrationSeparator()
```
    Description copied from interface: FlywayConfiguration
    
    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
    
    Specified by:
    
    getSqlMigrationSeparator in interface FlywayConfiguration
    
    Returns:
    
    The file name separator for sql migrations. (default: __)
  - getSqlMigrationSuffix
```
public String getSqlMigrationSuffix()
```
    Description copied from interface: FlywayConfiguration
    
    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
    
    Specified by:
    
    getSqlMigrationSuffix in interface FlywayConfiguration
    
    Returns:
    
    The file name suffix for sql migrations. (default: .sql)
  - getSqlMigrationSuffixes
```
public String[] getSqlMigrationSuffixes()
```
    Description copied from interface: FlywayConfiguration
    
    The file name suffixes for SQL migrations. (default: .sql)
    SQL migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix , which using the defaults translates to V1_1__My_description.sql
    
    Multiple suffixes (like .sql,.pkg,.pkb) can be specified for easier compatibility with other tools such as editors with specific file associations.
    
    Specified by:
    
    getSqlMigrationSuffixes in interface FlywayConfiguration
    
    Returns:
    
    The file name suffixes for SQL migrations.
  - isIgnoreMissingMigrations
```
public boolean isIgnoreMissingMigrations()
```
    Description copied from interface: FlywayConfiguration
    
    Ignore missing migrations when reading the schema history table. These are migrations that were performed by an older deployment of the application that are no longer available in this version. For example: we have migrations available on the classpath with versions 1.0 and 3.0. The schema history table indicates that a migration with version 2.0 (unknown to us) has also been applied. Instead of bombing out (fail fast) with an exception, a warning is logged and Flyway continues normally. This is useful for situations where one must be able to deploy a newer version of the application even though it doesn't contain migrations included with an older one anymore. Note that if the most recently applied migration is removed, Flyway has no way to know it is missing and will mark it as future instead.
    
    Specified by:
    
    isIgnoreMissingMigrations in interface FlywayConfiguration
    
    Returns:
    
    true to continue normally and log a warning, false to fail fast with an exception. (default: false)
  - isIgnoreFutureMigrations
```
public boolean isIgnoreFutureMigrations()
```
    Description copied from interface: FlywayConfiguration
    
    Ignore future migrations when reading the schema history 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 schema history table indicates that a migration to version 4.0 (unknown to us) has already been applied. Instead of bombing out (fail fast) with an exception, a warning is logged and Flyway continues normally. This is useful for situations where one must be able to redeploy an older version of the application after the database has been migrated by a newer one.
    
    Specified by:
    
    isIgnoreFutureMigrations in interface FlywayConfiguration
    
    Returns:
    
    true to continue normally and log a warning, false to fail fast with an exception. (default: true)
  - isValidateOnMigrate
```
public boolean isValidateOnMigrate()
```
    Description copied from interface: FlywayConfiguration
    
    Whether to automatically call validate or not when running migrate.
    
    Specified by:
    
    isValidateOnMigrate in interface FlywayConfiguration
    
    Returns:
    
    true if validate should be called. false if not. (default: true)
  - isCleanOnValidationError
```
public boolean isCleanOnValidationError()
```
    Description copied from interface: FlywayConfiguration
    
    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 !
    
    Specified by:
    
    isCleanOnValidationError in interface FlywayConfiguration
    
    Returns:
    
    true if clean should be called. false if not. (default: false)
  - isCleanDisabled
```
public boolean isCleanDisabled()
```
    Description copied from interface: FlywayConfiguration
    
    Whether to disable clean.
    This is especially useful for production environments where running clean can be quite a career limiting move.
    
    Specified by:
    
    isCleanDisabled in interface FlywayConfiguration
    
    Returns:
    
    true to disabled clean. false to leave it enabled. (default: false)
  - getBaselineVersion
```
public MigrationVersion getBaselineVersion()
```
    Description copied from interface: FlywayConfiguration
    
    Retrieves the version to tag an existing schema with when executing baseline.
    
    Specified by:
    
    getBaselineVersion in interface FlywayConfiguration
    
    Returns:
    
    The version to tag an existing schema with when executing baseline. (default: 1)
  - getBaselineDescription
```
public String getBaselineDescription()
```
    Description copied from interface: FlywayConfiguration
    
    Retrieves the description to tag an existing schema with when executing baseline.
    
    Specified by:
    
    getBaselineDescription in interface FlywayConfiguration
    
    Returns:
    
    The description to tag an existing schema with when executing baseline. (default: << Flyway Baseline >>)
  - isBaselineOnMigrate
```
public boolean isBaselineOnMigrate()
```
    Description copied from interface: FlywayConfiguration
    
    Whether to automatically call baseline when migrate is executed against a non-empty schema with no schema history table. This schema will then be initialized with the baselineVersion before executing the migrations. Only migrations above baselineVersion 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!
    
    Specified by:
    
    isBaselineOnMigrate in interface FlywayConfiguration
    
    Returns:
    
    true if baseline should be called on migrate for non-empty schemas, false if not. (default: false)
  - isOutOfOrder
```
public boolean isOutOfOrder()
```
    Description copied from interface: FlywayConfiguration
    
    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.
    
    Specified by:
    
    isOutOfOrder in interface FlywayConfiguration
    
    Returns:
    
    true if outOfOrder migrations should be applied, false if not. (default: false)
  - getResolvers
```
public MigrationResolver[] getResolvers()
```
    Description copied from interface: FlywayConfiguration
    
    Retrieves the The custom MigrationResolvers to be used in addition to the built-in ones for resolving Migrations to apply.
    
    Specified by:
    
    getResolvers in interface FlywayConfiguration
    
    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)
  - isSkipDefaultResolvers
```
public boolean isSkipDefaultResolvers()
```
    Description copied from interface: FlywayConfiguration
    
    Whether Flyway should skip the default resolvers. If true, only custom resolvers are used.
    
    Specified by:
    
    isSkipDefaultResolvers in interface FlywayConfiguration
    
    Returns:
    
    Whether default built-in resolvers should be skipped. (default: false)
  - getDataSource
```
public DataSource getDataSource()
```
    Description copied from interface: FlywayConfiguration
    
    Retrieves the dataSource to use to access the database. Must have the necessary privileges to execute ddl.
    
    Specified by:
    
    getDataSource in interface FlywayConfiguration
    
    Returns:
    
    The dataSource to use to access the database. Must have the necessary privileges to execute ddl.
  - getClassLoader
```
public ClassLoader getClassLoader()
```
    Description copied from interface: FlywayConfiguration
    
    Retrieves the ClassLoader to use for loading migrations, resolvers, etc from the classpath.
    
    Specified by:
    
    getClassLoader in interface FlywayConfiguration
    
    Returns:
    
    The ClassLoader to use for loading migrations, resolvers, etc from the classpath. (default: Thread.currentThread().getContextClassLoader() )
  - isMixed
```
public boolean isMixed()
```
    Description copied from interface: FlywayConfiguration
    
    Whether to allow mixing transactional and non-transactional statements within the same migration.
    
    Specified by:
    
    isMixed in interface FlywayConfiguration
    
    Returns:
    
    true if mixed migrations should be allowed. false if an error should be thrown instead. (default: false)
  - getInstalledBy
```
public String getInstalledBy()
```
    Description copied from interface: FlywayConfiguration
    
    The username that will be recorded in the schema history table as having applied the migration.
    
    Specified by:
    
    getInstalledBy in interface FlywayConfiguration
    
    Returns:
    
    The username or null for the current database user of the connection. (default: null).
  - isGroup
```
public boolean isGroup()
```
    Description copied from interface: FlywayConfiguration
    
    Whether to group all pending migrations together in the same transaction when applying them (only recommended for databases with support for DDL transactions).
    
    Specified by:
    
    isGroup in interface FlywayConfiguration
    
    Returns:
    
    true if migrations should be grouped. false if they should be applied individually instead. (default: false)
  - getErrorHandlers
```
public ErrorHandler[] getErrorHandlers()
```
    Description copied from interface: FlywayConfiguration
    
    Handlers for errors and warnings that occur during a migration. This can be used to customize Flyway's behavior by for example throwing another runtime exception, outputting a warning or suppressing the error instead of throwing a FlywayException. ErrorHandlers are invoked in order until one reports to have successfully handled the errors or warnings. If none do, or if none are present, Flyway falls back to its default handling of errors and warnings.
    Flyway Pro and Flyway Enterprise only
    
    Specified by:
    
    getErrorHandlers in interface FlywayConfiguration
    
    Returns:
    
    The ErrorHandlers or an empty array if the default internal handler should be used instead. (default: none)
  - getDryRunOutput
```
public OutputStream getDryRunOutput()
```
    Description copied from interface: FlywayConfiguration
    
    The stream where to output the SQL statements of a migration dry run. null if the SQL statements are executed against the database directly.
    Flyway Pro and Flyway Enterprise only
    
    Specified by:
    
    getDryRunOutput in interface FlywayConfiguration
    
    Returns:
    
    The stream or null if the SQL statements are executed against the database directly.
  - setDryRunOutput
```
public void setDryRunOutput(OutputStream dryRunOutput)
```
    Sets the stream where to output the SQL statements of a migration dry run. null to execute the SQL statements directly against the database. The stream when be closing when Flyway finishes writing the output.
    Flyway Pro and Flyway Enterprise only
    
    Parameters:
    
    dryRunOutput - The output file or null to execute the SQL statements directly against the database.
  - setDryRunOutputAsFile
```
public void setDryRunOutputAsFile(File dryRunOutput)
```
    Sets the file where to output the SQL statements of a migration dry run. null to execute the SQL statements directly against the database. If the file specified is in a non-existent directory, Flyway will create all directories and parent directories as needed.
    Flyway Pro and Flyway Enterprise only
    
    Parameters:
    
    dryRunOutput - The output file or null to execute the SQL statements directly against the database.
  - setDryRunOutputAsFileName
```
public void setDryRunOutputAsFileName(String dryRunOutputFileName)
```
    Sets the file where to output the SQL statements of a migration dry run. null to execute the SQL statements directly against the database. If the file specified is in a non-existent directory, Flyway will create all directories and parent directories as needed.
    Flyway Pro and Flyway Enterprise only
    
    Parameters:
    
    dryRunOutputFileName - The name of the output file or null to execute the SQL statements directly against the database.
  - setErrorHandlers
```
public void setErrorHandlers(ErrorHandler... errorHandlers)
```
    Handlers for errors and warnings that occur during a migration. This can be used to customize Flyway's behavior by for example throwing another runtime exception, outputting a warning or suppressing the error instead of throwing a FlywayException. ErrorHandlers are invoked in order until one reports to have successfully handled the errors or warnings. If none do, or if none are present, Flyway falls back to its default handling of errors and warnings.
    Flyway Pro and Flyway Enterprise only
    
    Parameters:
    
    errorHandlers - The ErrorHandlers or an empty array if the default internal handler should be used instead. (default: none)
  - setErrorHandlersAsClassNames
```
public void setErrorHandlersAsClassNames(String... errorHandlerClassNames)
```
    Handlers for errors and warnings that occur during a migration. This can be used to customize Flyway's behavior by for example throwing another runtime exception, outputting a warning or suppressing the error instead of throwing a FlywayException. ErrorHandlers are invoked in order until one reports to have successfully handled the errors or warnings. If none do, or if none are present, Flyway falls back to its default handling of errors and warnings.
    Flyway Pro and Flyway Enterprise only
    
    Parameters:
    
    errorHandlerClassNames - The fully qualified class names of ErrorHandlers or an empty array if the default internal handler should be used instead. (default: none)
  - setGroup
```
public void setGroup(boolean group)
```
    Whether to group all pending migrations together in the same transaction when applying them (only recommended for databases with support for DDL transactions).
    
    Parameters:
    
    group - true if migrations should be grouped. false if they should be applied individually instead. (default: false)
  - setInstalledBy
```
public void setInstalledBy(String installedBy)
```
    The username that will be recorded in the schema history table as having applied the migration.
    
    Parameters:
    
    installedBy - The username or null for the current database user of the connection. (default: null).
  - setMixed
```
public void setMixed(boolean mixed)
```
    Whether to allow mixing transactional and non-transactional statements within the same migration.
    
    Parameters:
    
    mixed - true if mixed migrations should be allowed. false if an error should be thrown instead. (default: false)
  - setIgnoreMissingMigrations
```
public void setIgnoreMissingMigrations(boolean ignoreMissingMigrations)
```
    Ignore missing migrations when reading the schema history table. These are migrations that were performed by an older deployment of the application that are no longer available in this version. For example: we have migrations available on the classpath with versions 1.0 and 3.0. The schema history table indicates that a migration with version 2.0 (unknown to us) has also been applied. Instead of bombing out (fail fast) with an exception, a warning is logged and Flyway continues normally. This is useful for situations where one must be able to deploy a newer version of the application even though it doesn't contain migrations included with an older one anymore. Note that if the most recently applied migration is removed, Flyway has no way to know it is missing and will mark it as future instead.
    
    Parameters:
    
    ignoreMissingMigrations - true to continue normally and log a warning, false to fail fast with an exception. (default: false)
  - setIgnoreFutureMigrations
```
public void setIgnoreFutureMigrations(boolean ignoreFutureMigrations)
```
    Whether to ignore future migrations when reading the schema history 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 schema history table indicates that a migration to version 4.0 (unknown to us) has already been applied. Instead of bombing out (fail fast) with an exception, a warning is logged and Flyway continues normally. This is useful for situations where one must be able to redeploy an older version of the application after the database has been migrated by a newer one.
    
    Parameters:
    
    ignoreFutureMigrations - true to continue normally and log a warning, false to fail fast with an exception. (default: true)
  - 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)
  - setCleanDisabled
```
public void setCleanDisabled(boolean cleanDisabled)
```
    Whether to disable clean.
    This is especially useful for production environments where running clean can be quite a career limiting move.
    
    Parameters:
    
    cleanDisabled - true to disabled clean. false to leave it enabled. (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 schema history 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 schema history table that will be used by Flyway.
    By default (single-schema mode) the schema history 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 schema history table is placed in the first schema of the list.
    
    Parameters:
    
    table - The name of the schema schema history table that will be used by flyway. (default: flyway_schema_history)
  - setTarget
```
public void setTarget(MigrationVersion target)
```
    Sets the target version up to which Flyway should consider migrations. Migrations with a higher version number will be ignored.
    
    Parameters:
    
    target - The target version up to which Flyway should consider migrations. (default: the latest version)
  - setTargetAsString
```
public void setTargetAsString(String target)
```
    Sets the target version up to which Flyway should consider migrations. Migrations with a higher version number will be ignored.
    
    Parameters:
    
    target - The target version up to which Flyway should consider migrations. The special value current designates the current version of the schema. (default: the latest version)
  - setPlaceholderReplacement
```
public void setPlaceholderReplacement(boolean placeholderReplacement)
```
    Sets whether placeholders should be replaced.
    
    Parameters:
    
    placeholderReplacement - Whether placeholders should be replaced. (default: true)
  - 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)
  - getUndoSqlMigrationPrefix
```
public String getUndoSqlMigrationPrefix()
```
    Description copied from interface: FlywayConfiguration
    
    The file name prefix for undo SQL migrations.
    Undo SQL migrations are responsible for undoing the effects of the versioned migration with the same version.
    
    They have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix , which using the defaults translates to U1.1__My_description.sql
    
    Flyway Pro and Flyway Enterprise only
    
    Specified by:
    
    getUndoSqlMigrationPrefix in interface FlywayConfiguration
    
    Returns:
    
    The file name prefix for undo sql migrations. (default: U)
  - setUndoSqlMigrationPrefix
```
public void setUndoSqlMigrationPrefix(String undoSqlMigrationPrefix)
```
    Sets the file name prefix for undo SQL migrations. (default: U)
    Undo SQL migrations are responsible for undoing the effects of the versioned migration with the same version.
    
    They have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix , which using the defaults translates to U1.1__My_description.sql
    
    Flyway Pro and Flyway Enterprise only
    
    Parameters:
    
    undoSqlMigrationPrefix - The file name prefix for undo SQL migrations. (default: U)
  - setRepeatableSqlMigrationPrefix
```
public void setRepeatableSqlMigrationPrefix(String repeatableSqlMigrationPrefix)
```
    Sets the file name prefix for repeatable sql migrations.
    Repeatable sql migrations have the following file name structure: prefixSeparatorDESCRIPTIONsuffix , which using the defaults translates to R__My_description.sql
    
    Parameters:
    
    repeatableSqlMigrationPrefix - The file name prefix for repeatable sql migrations (default: R)
  - 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
```
@Deprecated
public void setSqlMigrationSuffix(String sqlMigrationSuffix)
```
    Deprecated. Use setSqlMigrationSuffixes(String...) instead. Will be removed in Flyway 6.0.0.
    
    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)
  - setSqlMigrationSuffixes
```
public void setSqlMigrationSuffixes(String... sqlMigrationSuffixes)
```
    The file name suffixes for SQL migrations. (default: .sql)
    SQL migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix , which using the defaults translates to V1_1__My_description.sql
    
    Multiple suffixes (like .sql,.pkg,.pkb) can be specified for easier compatibility with other tools such as editors with specific file associations.
    
    Parameters:
    
    sqlMigrationSuffixes - The file name suffixes for SQL migrations.
  - 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
```
@Deprecated
public void setClassLoader(ClassLoader classLoader)
```
    Deprecated. Will be removed in Flyway 6.0. Use Flyway(ClassLoader) instead.
    
    Sets the ClassLoader to use for resolving migrations on the classpath.
    
    Parameters:
    
    classLoader - The ClassLoader to use for loading migrations, resolvers, etc from the classpath. (default: Thread.currentThread().getContextClassLoader() )
  - setBaselineVersion
```
public void setBaselineVersion(MigrationVersion baselineVersion)
```
    Sets the version to tag an existing schema with when executing baseline.
    
    Parameters:
    
    baselineVersion - The version to tag an existing schema with when executing baseline. (default: 1)
  - setBaselineVersionAsString
```
public void setBaselineVersionAsString(String baselineVersion)
```
    Sets the version to tag an existing schema with when executing baseline.
    
    Parameters:
    
    baselineVersion - The version to tag an existing schema with when executing baseline. (default: 1)
  - setBaselineDescription
```
public void setBaselineDescription(String baselineDescription)
```
    Sets the description to tag an existing schema with when executing baseline.
    
    Parameters:
    
    baselineDescription - The description to tag an existing schema with when executing baseline. (default: << Flyway Baseline >>)
  - setBaselineOnMigrate
```
public void setBaselineOnMigrate(boolean baselineOnMigrate)
```
    Whether to automatically call baseline when migrate is executed against a non-empty schema with no schema history table. This schema will then be baselined with the baselineVersion before executing the migrations. Only migrations above baselineVersion 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:
    
    baselineOnMigrate - true if baseline 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.
    
    Specified by:
    
    getCallbacks in interface FlywayConfiguration
    
    Returns:
    
    The callbacks for lifecycle notifications. An empty array if none. (default: none)
  - isSkipDefaultCallbacks
```
public boolean isSkipDefaultCallbacks()
```
    Description copied from interface: FlywayConfiguration
    
    Whether Flyway should skip the default callbacks. If true, only custom callbacks are used.
    
    Specified by:
    
    isSkipDefaultCallbacks in interface FlywayConfiguration
    
    Returns:
    
    Whether default built-in callbacks should be skipped. (default: false)
  - setCallbacks
```
public void setCallbacks(FlywayCallback... callbacks)
```
    Set the callbacks for lifecycle notifications.
    
    Parameters:
    
    callbacks - The callbacks for lifecycle notifications. (default: none)
  - setCallbacksAsClassNames
```
public void setCallbacksAsClassNames(String... callbacks)
```
    Set the callbacks for lifecycle notifications.
    
    Parameters:
    
    callbacks - The fully qualified class names of the callbacks for lifecycle notifications. (default: none)
  - setSkipDefaultCallbacks
```
public void setSkipDefaultCallbacks(boolean skipDefaultCallbacks)
```
    Whether Flyway should skip the default callbacks. If true, only custom callbacks are used.
    
    Parameters:
    
    skipDefaultCallbacks - Whether default built-in callbacks should be skipped.
    (default: false)
  - 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)
  - setResolversAsClassNames
```
public void setResolversAsClassNames(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)
  - setSkipDefaultResolvers
```
public void setSkipDefaultResolvers(boolean skipDefaultResolvers)
```
    Whether Flyway should skip the default resolvers. If true, only custom resolvers are used.
    
    Parameters:
    
    skipDefaultResolvers - Whether default built-in resolvers should be skipped.
    (default: false)
  - 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.
  - undo
```
public int undo()
         throws FlywayException
```
    Undoes the most recently applied versioned migration. If target is specified, Flyway will attempt to undo versioned migrations in the order they were applied until it hits one with a version below the target. If there is no versioned migration to undo, calling undo has no effect.
    
    Flyway Pro and Flyway Enterprise only
    
    Returns:
    
    The number of successfully undone migrations.
    
    Throws:
    
    FlywayException - when the undo failed.
  - validate
```
public void validate()
              throws FlywayException
```
    Validate applied migrations against resolved ones (on the filesystem or classpath) to detect accidental changes that may prevent the schema(s) from being recreated exactly.
    
    Validation fails if
    - differences in migration names, types or checksums are found
    - versions have been applied that aren't resolved locally anymore
    - versions have been resolved that haven't been applied yet
    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.
  - baseline
```
public void baseline()
              throws FlywayException
```
    Baselines an existing database, excluding all migrations up to and including baselineVersion.
    
    Throws:
    
    FlywayException - when the schema baselining failed.
  - repair
```
public void repair()
            throws FlywayException
```
    Repairs the Flyway schema history 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)
    - Realign the checksums, descriptions and types of the applied migrations with the ones of the available migrations
    Throws:
    
    FlywayException - when the schema history 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.
  - configure
```
public void configure(Map<String,String> props)
```
    Configures Flyway with these properties. This overwrites any existing configuration. Property names are documented in the flyway maven plugin.
    To use a custom ClassLoader, it must be passed to the Flyway constructor prior to calling this method.
    
    Parameters:
    
    props - Properties used for configuration.
    
    Throws:
    
    FlywayException - when the configuration failed.

Class Flyway

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Flyway

Flyway

Flyway

Method Detail

getLocations

getEncoding

getSchemas

getTable

getTarget

isPlaceholderReplacement

getPlaceholders

getPlaceholderPrefix

getPlaceholderSuffix

getSqlMigrationPrefix

getRepeatableSqlMigrationPrefix

getSqlMigrationSeparator

getSqlMigrationSuffix

getSqlMigrationSuffixes

isIgnoreMissingMigrations

isIgnoreFutureMigrations

isValidateOnMigrate

isCleanOnValidationError

isCleanDisabled

getBaselineVersion

getBaselineDescription

isBaselineOnMigrate

isOutOfOrder

getResolvers

isSkipDefaultResolvers

getDataSource

getClassLoader

isMixed

getInstalledBy

isGroup

getErrorHandlers

getDryRunOutput

setDryRunOutput

setDryRunOutputAsFile

setDryRunOutputAsFileName

setErrorHandlers

setErrorHandlersAsClassNames

setGroup

setInstalledBy

setMixed

setIgnoreMissingMigrations

setIgnoreFutureMigrations

setValidateOnMigrate

setCleanOnValidationError

setCleanDisabled

setLocations

setEncoding

setSchemas

setTable

setTarget

setTargetAsString

setPlaceholderReplacement

setPlaceholders

setPlaceholderPrefix

setPlaceholderSuffix

setSqlMigrationPrefix

getUndoSqlMigrationPrefix

setUndoSqlMigrationPrefix

setRepeatableSqlMigrationPrefix

setSqlMigrationSeparator

setSqlMigrationSuffix

setSqlMigrationSuffixes

setDataSource

setDataSource

setClassLoader

setBaselineVersion

setBaselineVersionAsString

setBaselineDescription

setBaselineOnMigrate

setOutOfOrder

getCallbacks