FlywayConfiguration (flyway-core 4.0.3 API)

All Known Implementing Classes:

Flyway
```
public interface FlywayConfiguration
```
Readonly interface for main flyway configuration. Can be used to provide configuration data to migrations and callbacks.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`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 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[]`	`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()` 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 consider migrations.
`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.

- Method Detail
  - getClassLoader
```
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() )
  - getDataSource
```
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.
  - 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
```
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 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
```
FlywayCallback[] 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)
  - getSqlMigrationSuffix
```
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)
  - getRepeatableSqlMigrationPrefix
```
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
```
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: __)
  - getSqlMigrationPrefix
```
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)
  - isPlaceholderReplacement
```
boolean isPlaceholderReplacement()
```
    Checks whether placeholders should be replaced.
    
    Returns:
    
    Whether placeholders should be replaced. (default: true)
  - getPlaceholderSuffix
```
String getPlaceholderSuffix()
```
    Retrieves the suffix of every placeholder.
    
    Returns:
    
    The suffix of every placeholder. (default: } )
  - getPlaceholderPrefix
```
String getPlaceholderPrefix()
```
    Retrieves the prefix of every placeholder.
    
    Returns:
    
    The prefix of every placeholder. (default: ${ )
  - getPlaceholders
```
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.
  - getTarget
```
MigrationVersion getTarget()
```
    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.
    
    Returns:
    
    The target version up to which Flyway should consider migrations. (default: the latest version)
  - getTable
```
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)
  - getSchemas
```
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)
  - getEncoding
```
String getEncoding()
```
    Retrieves the encoding of Sql migrations.
    
    Returns:
    
    The encoding of Sql migrations. (default: UTF-8)
  - getLocations
```
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)

Interface FlywayConfiguration

Method Summary

Method Detail

getClassLoader

getDataSource

getBaselineVersion

getBaselineDescription

getResolvers

isSkipDefaultResolvers

getCallbacks

isSkipDefaultCallbacks

getSqlMigrationSuffix

getRepeatableSqlMigrationPrefix

getSqlMigrationSeparator

getSqlMigrationPrefix

isPlaceholderReplacement

getPlaceholderSuffix

getPlaceholderPrefix

getPlaceholders

getTarget

getTable

getSchemas

getEncoding

getLocations