All Known Implementing Classes:

ClassicConfiguration, FluentConfiguration
```
public interface Configuration
```
Flyway configuration.

Method Summary

Modifier and Type	Method	Description
`java.lang.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.
`Callback[]`	`getCallbacks()`	Gets the callbacks for lifecycle notifications.
`java.lang.ClassLoader`	`getClassLoader()`	Retrieves the ClassLoader to use for loading migrations, resolvers, etc from the classpath.
`int`	`getConnectRetries()`	The maximum number of retries when attempting to connect to the database.
`javax.sql.DataSource`	`getDataSource()`	Retrieves the dataSource to use to access the database.
`java.lang.String`	`getDefaultSchema()`	Retrieves the default schema managed by Flyway.
`java.io.OutputStream`	`getDryRunOutput()`	The stream where to output the SQL statements of a migration dry run.
`java.nio.charset.Charset`	`getEncoding()`	Retrieves the encoding of Sql migrations.
`java.lang.String[]`	`getErrorOverrides()`	Rules for the built-in error handler that let you override specific SQL states and errors codes in order to force specific errors or warnings to be treated as debug messages, info messages, warnings or errors.
`java.lang.String`	`getInitSql()`	The SQL statements to run to initialize a new database connection immediately after opening it.
`java.lang.String`	`getInstalledBy()`	The username that will be recorded in the schema history table as having applied the migration.
`JavaMigration[]`	`getJavaMigrations()`	The manually added Java-based migrations.
`java.lang.String`	`getLicenseKey()`	Your Flyway license key (FL01...).
`Location[]`	`getLocations()`	Retrieves the locations to scan recursively for migrations.
`java.lang.String`	`getPlaceholderPrefix()`	Retrieves the prefix of every placeholder.
`java.util.Map<java.lang.String,java.lang.String>`	`getPlaceholders()`	Retrieves the map of <placeholder, replacementValue> to apply to sql migration scripts.
`java.lang.String`	`getPlaceholderSuffix()`	Retrieves the suffix of every placeholder.
`java.lang.String`	`getRepeatableSqlMigrationPrefix()`	Retrieves the file name prefix for repeatable SQL migrations.
`MigrationResolver[]`	`getResolvers()`	Retrieves the custom MigrationResolvers to be used in addition to the built-in ones for resolving Migrations to apply.
`java.lang.String[]`	`getSchemas()`	Retrieves the schemas managed by Flyway.
`java.lang.String`	`getSqlMigrationPrefix()`	The file name prefix for versioned SQL migrations.
`java.lang.String`	`getSqlMigrationSeparator()`	Retrieves the file name separator for sql migrations.
`java.lang.String[]`	`getSqlMigrationSuffixes()`	The file name suffixes for SQL migrations.
`java.lang.String`	`getTable()`	Retrieves the name of the schema history table that will be used by Flyway.
`java.lang.String`	`getTablespace()`	Retrieves the tablespace where to create the schema history table that will be used by Flyway.
`MigrationVersion`	`getTarget()`	Gets the target version up to which Flyway should consider migrations.
`java.lang.String`	`getUndoSqlMigrationPrefix()`	The file name prefix for undo SQL migrations.
`boolean`	`isBaselineOnMigrate()`	Whether to automatically call baseline when migrate is executed against a non-empty schema with no schema history table.
`boolean`	`isBatch()`	Whether to batch SQL statements when executing them.
`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`	`isIgnoreIgnoredMigrations()`	Ignore ignored migrations when reading the schema history table.
`boolean`	`isIgnoreMissingMigrations()`	Ignore missing migrations when reading the schema history table.
`boolean`	`isIgnorePendingMigrations()`	Ignore pending migrations when reading the schema history table.
`boolean`	`isMixed()`	Whether to allow mixing transactional and non-transactional statements within the same migration.
`boolean`	`isOracleSqlplus()`	Whether to Flyway's support for Oracle SQL*Plus commands should be activated.
`boolean`	`isOracleSqlplusWarn()`	Whether Flyway should issue a warning instead of an error whenever it encounters an Oracle SQL*Plus statement it doesn't yet support.
`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`	`isStream()`	Whether to stream SQL migrations when executing them.
`boolean`	`isValidateOnMigrate()`	Whether to automatically call validate or not when running migrate.
`boolean`	`outputQueryResults()`	Whether Flyway should output a table with the results of queries when executing migrations.

- Method Detail
  - getClassLoader
```
java.lang.ClassLoader getClassLoader()
```
    Retrieves the ClassLoader to use for loading migrations, resolvers, etc from the classpath.
    
    Returns:
    
    The ClassLoader to use for loading migrations, resolvers, etc from the classpath. (default: Thread.currentThread().getContextClassLoader() )
  - getDataSource
```
javax.sql.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.
  - getConnectRetries
```
int getConnectRetries()
```
    The maximum number of retries when attempting to connect to the database. After each failed attempt, Flyway will wait 1 second before attempting to connect again, up to the maximum number of times specified by connectRetries.
    
    Returns:
    
    The maximum number of retries when attempting to connect to the database. (default: 0)
  - getInitSql
```
java.lang.String getInitSql()
```
    The SQL statements to run to initialize a new database connection immediately after opening it.
    
    Returns:
    
    The SQL statements. (default: null)
  - getBaselineVersion
```
MigrationVersion getBaselineVersion()
```
    Retrieves the version to tag an existing schema with when executing baseline.
    
    Returns:
    
    The version to tag an existing schema with when executing baseline. (default: 1)
  - getBaselineDescription
```
java.lang.String getBaselineDescription()
```
    Retrieves the description to tag an existing schema with when executing baseline.
    
    Returns:
    
    The description to tag an existing schema with when executing baseline. (default: << Flyway Baseline >>)
  - getResolvers
```
MigrationResolver[] getResolvers()
```
    Retrieves 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)
  - isSkipDefaultResolvers
```
boolean isSkipDefaultResolvers()
```
    Whether Flyway should skip the default resolvers. If true, only custom resolvers are used.
    
    Returns:
    
    Whether default built-in resolvers should be skipped. (default: false)
  - getCallbacks
```
Callback[] getCallbacks()
```
    Gets the callbacks for lifecycle notifications.
    
    Returns:
    
    The callbacks for lifecycle notifications. An empty array if none. (default: none)
  - isSkipDefaultCallbacks
```
boolean isSkipDefaultCallbacks()
```
    Whether Flyway should skip the default callbacks. If true, only custom callbacks are used.
    
    Returns:
    
    Whether default built-in callbacks should be skipped. (default: false)
  - getSqlMigrationPrefix
```
java.lang.String getSqlMigrationPrefix()
```
    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
    
    Returns:
    
    The file name prefix for sql migrations. (default: V)
  - getUndoSqlMigrationPrefix
```
java.lang.String getUndoSqlMigrationPrefix()
```
    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
    
    Returns:
    
    The file name prefix for undo sql migrations. (default: U)
  - getRepeatableSqlMigrationPrefix
```
java.lang.String getRepeatableSqlMigrationPrefix()
```
    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
    
    Returns:
    
    The file name prefix for repeatable sql migrations. (default: R)
  - getSqlMigrationSeparator
```
java.lang.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: __)
  - getSqlMigrationSuffixes
```
java.lang.String[] getSqlMigrationSuffixes()
```
    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.
    
    Returns:
    
    The file name suffixes for SQL migrations.
  - getJavaMigrations
```
JavaMigration[] getJavaMigrations()
```
    The manually added Java-based migrations. These are not Java-based migrations discovered through classpath scanning and instantiated by Flyway. Instead these are manually added instances of JavaMigration. This is particularly useful when working with a dependency injection container, where you may want the DI container to instantiate the class and wire up its dependencies for you.
    
    Returns:
    
    The manually added Java-based migrations. An empty array if none. (default: none)
  - isPlaceholderReplacement
```
boolean isPlaceholderReplacement()
```
    Checks whether placeholders should be replaced.
    
    Returns:
    
    Whether placeholders should be replaced. (default: true)
  - getPlaceholderSuffix
```
java.lang.String getPlaceholderSuffix()
```
    Retrieves the suffix of every placeholder.
    
    Returns:
    
    The suffix of every placeholder. (default: } )
  - getPlaceholderPrefix
```
java.lang.String getPlaceholderPrefix()
```
    Retrieves the prefix of every placeholder.
    
    Returns:
    
    The prefix of every placeholder. (default: ${ )
  - getPlaceholders
```
java.util.Map<java.lang.String,java.lang.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.
  - getTarget
```
MigrationVersion getTarget()
```
    Gets the target version up to which Flyway should consider migrations. Migrations with a higher version number will be ignored. Special values:
    
    current: designates the current version of the schema
    
    latest: the latest version of the schema, as defined by the migration with the highest version
    
    Defaults to latest.
    Returns:
    
    The target version up to which Flyway should consider migrations. Defaults to latest
  - getTable
```
java.lang.String getTable()
```
    Retrieves the name of the 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.
    
    Returns:
    
    The name of the schema history table that will be used by Flyway. (default: flyway_schema_history)
  - getTablespace
```
java.lang.String getTablespace()
```
    Retrieves the tablespace where to create the schema history table that will be used by Flyway.
    
    This setting is only relevant for databases that do support the notion of tablespaces. It's value is simply ignored for all others.
    
    Returns:
    
    The tablespace where to create the schema history table that will be used by Flyway. (default: The default tablespace for the database connection)
  - getDefaultSchema
```
java.lang.String getDefaultSchema()
```
    Retrieves the default schema managed by Flyway. This schema name is case-sensitive. If not specified, but flyway.schemas is, we use the first schema in that list. In Flyway 7, you will need to specify this value and not rely on flyway.schemas (default: The default schema for the database connection)
    Consequences:
    
    This schema will be the one containing the schema history table.
    
    This schema will be the default for the database connection (provided the database supports this concept).
    Returns:
    
    The schemas managed by Flyway. (default: The first schema specified in getSchemas(), and failing that the default schema for the database connection)
  - getSchemas
```
java.lang.String[] getSchemas()
```
    Retrieves the schemas managed by Flyway. These schema names are case-sensitive.
    Consequences:
    
    Flyway will automatically attempt to create all these schemas, unless they already exist.
    
    The schemas will be cleaned in the order of this list.
    
    If Flyway created them, the schemas themselves will be dropped when cleaning.
    Returns:
    
    The schemas managed by Flyway. (default: The default schema for the database connection)
  - getEncoding
```
java.nio.charset.Charset getEncoding()
```
    Retrieves the encoding of Sql migrations.
    
    Returns:
    
    The encoding of Sql migrations. (default: UTF-8)
  - getLocations
```
Location[] 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, may only contain SQL migrations and are only scanned recursively down non-hidden directories.
    
    Returns:
    
    Locations to scan recursively for migrations. (default: classpath:db/migration)
  - isBaselineOnMigrate
```
boolean isBaselineOnMigrate()
```
    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!
    
    Returns:
    
    true if baseline should be called on migrate for non-empty schemas, false if not. (default: false)
  - isOutOfOrder
```
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)
  - isIgnoreMissingMigrations
```
boolean isIgnoreMissingMigrations()
```
    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.
    
    Returns:
    
    true to continue normally and log a warning, false to fail fast with an exception. (default: false)
  - isIgnoreIgnoredMigrations
```
boolean isIgnoreIgnoredMigrations()
```
    Ignore ignored migrations when reading the schema history table. These are migrations that were added in between already migrated migrations in this version. For example: we have migrations available on the classpath with versions from 1.0 to 3.0. The schema history table indicates that version 1 was finished on 1.0.15, and the next one was 2.0.0. But with the next release a new migration was added to version 1: 1.0.16. Such scenario is ignored by migrate command, but by default is rejected by validate. When ignoreIgnoredMigrations is enabled, such case will not be reported by validate command. This is useful for situations where one must be able to deliver complete set of migrations in a delivery package for multiple versions of the product, and allows for further development of older versions.
    
    Returns:
    
    true to continue normally, false to fail fast with an exception. (default: false)
  - isIgnorePendingMigrations
```
boolean isIgnorePendingMigrations()
```
    Ignore pending migrations when reading the schema history table. These are migrations that are available but have not yet been applied. This can be useful for verifying that in-development migration changes don't contain any validation-breaking changes of migrations that have already been applied to a production environment, e.g. as part of a CI/CD process, without failing because of the existence of new migration versions.
    
    Returns:
    
    true to continue normally, false to fail fast with an exception. (default: false)
  - isIgnoreFutureMigrations
```
boolean isIgnoreFutureMigrations()
```
    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.
    
    Returns:
    
    true to continue normally and log a warning, false to fail fast with an exception. (default: true)
  - isValidateOnMigrate
```
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
```
boolean isCleanOnValidationError()
```
    Whether to automatically call clean or not when a validation error occurs.
    This is exclusively intended as a convenience for development. even though 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)
  - isCleanDisabled
```
boolean isCleanDisabled()
```
    Whether to disable clean.
    This is especially useful for production environments where running clean can be quite a career limiting move.
    
    Returns:
    
    true to disable clean. false to leave it enabled. (default: false)
  - isMixed
```
boolean isMixed()
```
    Whether to allow mixing transactional and non-transactional statements within the same migration. Enabling this automatically causes the entire affected migration to be run without a transaction.
    Note that this is only applicable for PostgreSQL, Aurora PostgreSQL, SQL Server and SQLite which all have statements that do not run at all within a transaction.
    
    This is not to be confused with implicit transaction, as they occur in MySQL or Oracle, where even though a DDL statement was run within a transaction, the database will issue an implicit commit before and after its execution.
    
    Returns:
    
    true if mixed migrations should be allowed. false if an error should be thrown instead. (default: false)
  - isGroup
```
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).
    
    Returns:
    
    true if migrations should be grouped. false if they should be applied individually instead. (default: false)
  - getInstalledBy
```
java.lang.String getInstalledBy()
```
    The username that will be recorded in the schema history table as having applied the migration.
    
    Returns:
    
    The username or null for the current database user of the connection. (default: null).
  - getErrorOverrides
```
java.lang.String[] getErrorOverrides()
```
    Rules for the built-in error handler that let you override specific SQL states and errors codes in order to force specific errors or warnings to be treated as debug messages, info messages, warnings or errors.
    Each error override has the following format: STATE:12345:W. It is a 5 character SQL state (or * to match all SQL states), a colon, the SQL error code (or * to match all SQL error codes), a colon and finally the desired behavior that should override the initial one.
    
    The following behaviors are accepted:
    
    D to force a debug message
    
    D- to force a debug message, but do not show the original sql state and error code
    
    I to force an info message
    
    I- to force an info message, but do not show the original sql state and error code
    
    W to force a warning
    
    W- to force a warning, but do not show the original sql state and error code
    
    E to force an error
    
    E- to force an error, but do not show the original sql state and error code
    
    Example 1: to force Oracle stored procedure compilation issues to produce errors instead of warnings, the following errorOverride can be used: 99999:17110:E
    
    Example 2: to force SQL Server PRINT messages to be displayed as info messages (without SQL state and error code details) instead of warnings, the following errorOverride can be used: S0001:0:I-
    
    Example 3: to force all errors with SQL error code 123 to be treated as warnings instead, the following errorOverride can be used: *:123:W
    
    Flyway Pro and Flyway Enterprise only
    Returns:
    
    The ErrorOverrides or an empty array if none are defined. (default: none)
  - getDryRunOutput
```
java.io.OutputStream getDryRunOutput()
```
    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
    
    Returns:
    
    The stream or null if the SQL statements are executed against the database directly.
  - isStream
```
boolean isStream()
```
    Whether to stream SQL migrations when executing them. Streaming doesn't load the entire migration in memory at once. Instead each statement is loaded individually. This is particularly useful for very large SQL migrations composed of multiple MB or even GB of reference data, as this dramatically reduces Flyway's memory consumption.
    Flyway Pro and Flyway Enterprise only
    
    Returns:
    
    true to stream SQL migrations. false to fully loaded them in memory instead. (default: false)
  - isBatch
```
boolean isBatch()
```
    Whether to batch SQL statements when executing them. Batching can save up to 99 percent of network roundtrips by sending up to 100 statements at once over the network to the database, instead of sending each statement individually. This is particularly useful for very large SQL migrations composed of multiple MB or even GB of reference data, as this can dramatically reduce the network overhead. This is supported for INSERT, UPDATE, DELETE, MERGE and UPSERT statements. All other statements are automatically executed without batching.
    Flyway Pro and Flyway Enterprise only
    
    Returns:
    
    true to batch SQL statements. false to execute them individually instead. (default: false)
  - isOracleSqlplus
```
boolean isOracleSqlplus()
```
    Whether to Flyway's support for Oracle SQL*Plus commands should be activated.
    Flyway Pro and Flyway Enterprise only
    
    Returns:
    
    true to active SQL*Plus support. false to fail fast instead. (default: false)
  - isOracleSqlplusWarn
```
boolean isOracleSqlplusWarn()
```
    Whether Flyway should issue a warning instead of an error whenever it encounters an Oracle SQL*Plus statement it doesn't yet support.
    Flyway Pro and Flyway Enterprise only
    
    Returns:
    
    true to issue a warning. false to fail fast instead. (default: false)
  - getLicenseKey
```
java.lang.String getLicenseKey()
```
    Your Flyway license key (FL01...). Not yet a Flyway Pro or Enterprise Edition customer? Request your Flyway trial license key to try out Flyway Pro and Enterprise Edition features free for 30 days.
    Flyway Pro and Flyway Enterprise only
    
    Returns:
    
    Your Flyway license key.
  - outputQueryResults
```
boolean outputQueryResults()
```
    Whether Flyway should output a table with the results of queries when executing migrations.
    Flyway Pro and Flyway Enterprise only
    
    Returns:
    
    true to output the results table (default: true)

Interface Configuration

Method Summary

Method Detail

getClassLoader

getDataSource

getConnectRetries

getInitSql

getBaselineVersion

getBaselineDescription

getResolvers

isSkipDefaultResolvers

getCallbacks

isSkipDefaultCallbacks

getSqlMigrationPrefix

getUndoSqlMigrationPrefix

getRepeatableSqlMigrationPrefix

getSqlMigrationSeparator

getSqlMigrationSuffixes

getJavaMigrations

isPlaceholderReplacement

getPlaceholderSuffix

getPlaceholderPrefix

getPlaceholders

getTarget

getTable

getTablespace

getDefaultSchema

getSchemas

getEncoding

getLocations

isBaselineOnMigrate

isOutOfOrder

isIgnoreMissingMigrations

isIgnoreIgnoredMigrations

isIgnorePendingMigrations

isIgnoreFutureMigrations

isValidateOnMigrate

isCleanOnValidationError

isCleanDisabled

isMixed

isGroup

getInstalledBy

getErrorOverrides

getDryRunOutput

isStream

isBatch

isOracleSqlplus

isOracleSqlplusWarn

getLicenseKey

outputQueryResults