Package org.flywaydb.core.api.configuration

Class ClassicConfiguration

java.lang.Object
org.flywaydb.core.api.configuration.ClassicConfiguration
All Implemented Interfaces:
Configuration
public class ClassicConfiguration extends Object implements Configuration
JavaBean-style configuration for Flyway. This is primarily meant for compatibility with scenarios where the new FluentConfiguration isn't an easy fit, such as Spring XML bean configuration.

This configuration can then be passed to Flyway using the new Flyway(Configuration) constructor.

  • Field Details

  • Constructor Details

    • ClassicConfiguration

      public ClassicConfiguration(org.flywaydb.core.internal.configuration.models.ConfigurationModel modernConfig)

    • ClassicConfiguration

      public ClassicConfiguration()

    • ClassicConfiguration

      public ClassicConfiguration(ClassLoader classLoader)
      Parameters:
      classLoader - The ClassLoader to use for loading migrations, resolvers, etc. from the classpath. (default: Thread.currentThread().getContextClassLoader())

    • ClassicConfiguration

      public ClassicConfiguration(Configuration configuration)
      Creates a new configuration with the same values as this existing one.

  • Method Details

    • setDefaultSchema

      public void setDefaultSchema(String defaultSchema)

    • getDefaultSchema

      public String getDefaultSchema()
      Description copied from interface: Configuration
      The default schema managed by Flyway. This schema name is case-sensitive. If not specified, but schemas is, Flyway uses the first schema in that list. If that is also not specified, Flyway uses 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).
      Specified by:
      getDefaultSchema in interface Configuration
      Returns:
      The default schema managed by Flyway, which is where the schema history table will reside. (default: The first schema specified in getSchemas(), and failing that the default schema for the database connection)

    • getCurrentResolvedEnvironment

      public org.flywaydb.core.internal.configuration.models.ResolvedEnvironment getCurrentResolvedEnvironment()

    • getResolvedEnvironment

      public org.flywaydb.core.internal.configuration.models.ResolvedEnvironment getResolvedEnvironment(String envName)

    • getSchemas

      public String[] getSchemas()
      Description copied from interface: Configuration
      The schemas managed by Flyway. These schema names are case-sensitive. If not specified, Flyway uses the default schema for the database connection. If defaultSchema is not specified, then the first of this list also acts as the default schema.

      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.
      Specified by:
      getSchemas in interface Configuration
      Returns:
      The schemas managed by Flyway. (default: The default schema for the database connection)

    • isReportEnabled

      public boolean isReportEnabled()
      Specified by:
      isReportEnabled in interface Configuration

    • getEncoding

      public Charset getEncoding()
      Description copied from interface: Configuration
      Retrieves the encoding of Sql migrations.
      Specified by:
      getEncoding in interface Configuration
      Returns:
      The encoding of Sql migrations. (default: UTF-8)

    • isDetectEncoding

      public boolean isDetectEncoding()
      Description copied from interface: Configuration
      Whether Flyway should try to automatically detect SQL migration file encoding
      Specified by:
      isDetectEncoding in interface Configuration
      Returns:
      true to enable auto detection, false otherwise Flyway Teams only

    • getReportFilename

      public String getReportFilename()
      Description copied from interface: Configuration
      Get the filename of generated reports
      Specified by:
      getReportFilename in interface Configuration
      Returns:
      report filename;

    • getCallbacks

      public Callback[] getCallbacks()
      Description copied from interface: Configuration
      Gets the callbacks for lifecycle notifications.
      Specified by:
      getCallbacks in interface Configuration
      Returns:
      The callbacks for lifecycle notifications. An empty array if none. (default: none)

    • getUrl

      public String getUrl()
      Description copied from interface: Configuration
      Retrieves the url used to construct the dataSource. May be null if the dataSource was passed in directly.
      Specified by:
      getUrl in interface Configuration
      Returns:
      The url used to construct the dataSource. May be null if the dataSource was passed in directly.

    • getUser

      public String getUser()
      Description copied from interface: Configuration
      Retrieves the user used to construct the dataSource. May be null if the dataSource was passed in directly, or if dataSource did not need a user.
      Specified by:
      getUser in interface Configuration
      Returns:
      The user used to construct the dataSource. May be null if the dataSource was passed in directly, or if dataSource did not need a user.

    • getPassword

      public String getPassword()
      Description copied from interface: Configuration
      Retrieves the password used to construct the dataSource. May be null if the dataSource was passed in directly, or if dataSource did not need a password.
      Specified by:
      getPassword in interface Configuration
      Returns:
      The password used to construct the dataSource. May be null if the dataSource was passed in directly, or if dataSource did not need a password.

    • getLocations

      public Location[] getLocations()
      Description copied from interface: Configuration
      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.
      Specified by:
      getLocations in interface Configuration
      Returns:
      Locations to scan recursively for migrations. (default: classpath:db/migration)

    • isBaselineOnMigrate

      public boolean isBaselineOnMigrate()
      Description copied from interface: Configuration
      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 Configuration
      Returns:
      true if baseline should be called on migrate for non-empty schemas, false if not. (default: false)

    • isSkipExecutingMigrations

      public boolean isSkipExecutingMigrations()
      Description copied from interface: Configuration
      Whether Flyway should skip actually executing the contents of the migrations and only update the schema history table. This should be used when you have applied a migration manually (via executing the sql yourself, or via an ide), and just want the schema history table to reflect this. Use in conjunction with cherryPick to skip specific migrations instead of all pending ones. Flyway Teams only
      Specified by:
      isSkipExecutingMigrations in interface Configuration
      Returns:
      true if executing the migrations should be skipped on migrate, false if not. (default: false)

    • isOutOfOrder

      public boolean isOutOfOrder()
      Description copied from interface: Configuration
      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 Configuration
      Returns:
      true if outOfOrder migrations should be applied, false if not. (default: false)

    • getIgnoreMigrationPatterns

      public ValidatePattern[] getIgnoreMigrationPatterns()
      Description copied from interface: Configuration
      Ignore migrations that match this comma-separated list of patterns when validating migrations. Each pattern is of the form : See https://documentation.red-gate.com/fd/ignore-migration-patterns-184127507.html for full details Example: repeatable:missing,versioned:pending,*:failed (default: *:future) Flyway Teams only
      Specified by:
      getIgnoreMigrationPatterns in interface Configuration

    • isValidateMigrationNaming

      public boolean isValidateMigrationNaming()
      Description copied from interface: Configuration
      Whether to validate migrations and callbacks whose scripts do not obey the correct naming convention. A failure can be useful to check that errors such as case sensitivity in migration prefixes have been corrected.
      Specified by:
      isValidateMigrationNaming in interface Configuration
      Returns:
      false to continue normally, true to fail fast with an exception. (default: false)

    • isValidateOnMigrate

      public boolean isValidateOnMigrate()
      Description copied from interface: Configuration
      Whether to automatically call validate or not when running migrate.
      Specified by:
      isValidateOnMigrate in interface Configuration
      Returns:
      true if validate should be called. false if not. (default: true)

    • isCleanOnValidationError

      public boolean isCleanOnValidationError()
      Description copied from interface: Configuration
      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!
      Specified by:
      isCleanOnValidationError in interface Configuration
      Returns:
      true if clean should be called. false if not. (default: false)

    • isCleanDisabled

      public boolean isCleanDisabled()
      Description copied from interface: Configuration
      Whether to disable clean. This is especially useful for production environments where running clean can be a career limiting move.
      Specified by:
      isCleanDisabled in interface Configuration
      Returns:
      true to disable clean. false to be able to clean. (default: true)

    • isMixed

      public boolean isMixed()
      Description copied from interface: Configuration
      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.
      Specified by:
      isMixed in interface Configuration
      Returns:
      true if mixed migrations should be allowed. false if an error should be thrown instead. (default: false)

    • isGroup

      public boolean isGroup()
      Description copied from interface: Configuration
      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 Configuration
      Returns:
      true if migrations should be grouped. false if they should be applied individually instead. (default: false)

    • getInstalledBy

      public String getInstalledBy()
      Description copied from interface: Configuration
      The username that will be recorded in the schema history table as having applied the migration.
      Specified by:
      getInstalledBy in interface Configuration
      Returns:
      The username or null for the current database user of the connection. (default: null).

    • getErrorOverrides

      public String[] getErrorOverrides()
      Description copied from interface: Configuration
      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 Teams only
      Specified by:
      getErrorOverrides in interface Configuration
      Returns:
      The ErrorOverrides or an empty array if none are defined. (default: none)

    • getDryRunOutput

      public OutputStream getDryRunOutput()
      Description copied from interface: Configuration
      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 Teams only
      Specified by:
      getDryRunOutput in interface Configuration
      Returns:
      The stream or null if the SQL statements are executed against the database directly.

    • isStream

      public boolean isStream()
      Description copied from interface: Configuration
      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 Teams only
      Specified by:
      isStream in interface Configuration
      Returns:
      true to stream SQL migrations. false to fully loaded them in memory instead. (default: false)

    • isBatch

      public boolean isBatch()
      Description copied from interface: Configuration
      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 Teams only
      Specified by:
      isBatch in interface Configuration
      Returns:
      true to batch SQL statements. false to execute them individually instead. (default: false)

    • isOracleSqlplus

      public boolean isOracleSqlplus()
      Description copied from interface: Configuration
      Whether to Flyway's support for Oracle SQL*Plus commands should be activated. Flyway Teams only
      Specified by:
      isOracleSqlplus in interface Configuration
      Returns:
      true to active SQL*Plus support. false to fail fast instead. (default: false)

    • isOracleSqlplusWarn

      public boolean isOracleSqlplusWarn()
      Description copied from interface: Configuration
      Whether Flyway should issue a warning instead of an error whenever it encounters an Oracle SQL*Plus statement it doesn't yet support. Flyway Teams only
      Specified by:
      isOracleSqlplusWarn in interface Configuration
      Returns:
      true to issue a warning. false to fail fast instead. (default: false)

    • getKerberosConfigFile

      public String getKerberosConfigFile()
      Description copied from interface: Configuration
      The path to the Kerberos config file. Flyway Teams only
      Specified by:
      getKerberosConfigFile in interface Configuration

    • getOracleKerberosCacheFile

      public String getOracleKerberosCacheFile()
      Specified by:
      getOracleKerberosCacheFile in interface Configuration

    • getLicenseKey

      public String getLicenseKey()
      Description copied from interface: Configuration
      Your Flyway license key (FL01...). Not yet a Flyway Teams Edition customer? Request your Flyway trial license key to try out Flyway Teams Edition features free for 30 days. Flyway Teams only
      Specified by:
      getLicenseKey in interface Configuration
      Returns:
      Your Flyway license key.

    • isOutputQueryResults

      public boolean isOutputQueryResults()
      Description copied from interface: Configuration
      Whether Flyway should output a table with the results of queries when executing migrations. Flyway Teams only
      Specified by:
      isOutputQueryResults in interface Configuration
      Returns:
      true to output the results table (default: true)

    • isCreateSchemas

      public boolean isCreateSchemas()
      Description copied from interface: Configuration
      Whether Flyway should attempt to create the schemas specified in the schemas property.
      Specified by:
      isCreateSchemas in interface Configuration
      Returns:

    • getLockRetryCount

      public int getLockRetryCount()
      Description copied from interface: Configuration
      The maximum number of retries when trying to obtain a lock. -1 indicates attempting to repeat indefinitely.
      Specified by:
      getLockRetryCount in interface Configuration

    • getJdbcProperties

      public Map<String,String> getJdbcProperties()
      Description copied from interface: Configuration
      Properties to pass to the JDBC driver object Flyway Teams only
      Specified by:
      getJdbcProperties in interface Configuration
      Returns:
      Properties that will be passed to the JDBC driver object

    • isFailOnMissingLocations

      public boolean isFailOnMissingLocations()
      Description copied from interface: Configuration
      Whether to fail if a location specified in the flyway.locations option doesn't exist
      Specified by:
      isFailOnMissingLocations in interface Configuration
      Returns:

    • getOracleWalletLocation

      public String getOracleWalletLocation()
      Description copied from interface: Configuration
      The location of your Oracle wallet, used to automatically sign in to your databases. Flyway Teams only
      Specified by:
      getOracleWalletLocation in interface Configuration

    • getLoggers

      public String[] getLoggers()
      Description copied from interface: Configuration
      The loggers Flyway should use. Valid options are:
      • auto: Auto detect the logger (default behavior)
      • console: Use stdout/stderr (only available when using the CLI)
      • slf4j: Use the slf4j logger
      • log4j2: Use the log4j2 logger
      • apache-commons: Use the Apache Commons logger
      Alternatively you can provide the fully qualified class name for any other logger to use that.
      Specified by:
      getLoggers in interface Configuration

    • getConnectRetries

      public int getConnectRetries()
      Description copied from interface: Configuration
      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. The interval between retries doubles with each subsequent attempt.
      Specified by:
      getConnectRetries in interface Configuration
      Returns:
      The maximum number of retries when attempting to connect to the database. (default: 0)

    • getConnectRetriesInterval

      public int getConnectRetriesInterval()
      Description copied from interface: Configuration
      The maximum time between retries when attempting to connect to the database in seconds. This will cap the interval between connect retry to the value provided.
      Specified by:
      getConnectRetriesInterval in interface Configuration
      Returns:
      The maximum time between retries in seconds (default: 120)

    • getInitSql

      public String getInitSql()
      Description copied from interface: Configuration
      The SQL statements to run to initialize a new database connection immediately after opening it.
      Specified by:
      getInitSql in interface Configuration
      Returns:
      The SQL statements. (default: null)

    • getBaselineVersion

      public MigrationVersion getBaselineVersion()
      Description copied from interface: Configuration
      Retrieves the version to tag an existing schema with when executing baseline.
      Specified by:
      getBaselineVersion in interface Configuration
      Returns:
      The version to tag an existing schema with when executing baseline. (default: 1)

    • getBaselineDescription

      public String getBaselineDescription()
      Description copied from interface: Configuration
      Retrieves the description to tag an existing schema with when executing baseline.
      Specified by:
      getBaselineDescription in interface Configuration
      Returns:
      The description to tag an existing schema with when executing baseline. (default: << Flyway Baseline >>)

    • isSkipDefaultResolvers

      public boolean isSkipDefaultResolvers()
      Description copied from interface: Configuration
      Whether Flyway should skip the default resolvers. If true, only custom resolvers are used.
      Specified by:
      isSkipDefaultResolvers in interface Configuration
      Returns:
      Whether default built-in resolvers should be skipped. (default: false)

    • isSkipDefaultCallbacks

      public boolean isSkipDefaultCallbacks()
      Description copied from interface: Configuration
      Whether Flyway should skip the default callbacks. If true, only custom callbacks are used.
      Specified by:
      isSkipDefaultCallbacks in interface Configuration
      Returns:
      Whether default built-in callbacks should be skipped. (default: false)

    • getSqlMigrationPrefix

      public String getSqlMigrationPrefix()
      Description copied from interface: Configuration
      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 Configuration
      Returns:
      The file name prefix for sql migrations. (default: V)

    • getUndoSqlMigrationPrefix

      public String getUndoSqlMigrationPrefix()
      Description copied from interface: Configuration
      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 Teams only
      Specified by:
      getUndoSqlMigrationPrefix in interface Configuration
      Returns:
      The file name prefix for undo sql migrations. (default: U)

    • isExecuteInTransaction

      public boolean isExecuteInTransaction()
      Description copied from interface: Configuration
      Checks whether SQL is executed in a transaction.
      Specified by:
      isExecuteInTransaction in interface Configuration
      Returns:
      Whether SQL is executed in a transaction. (default: true)

    • getRepeatableSqlMigrationPrefix

      public String getRepeatableSqlMigrationPrefix()
      Description copied from interface: Configuration
      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 Configuration
      Returns:
      The file name prefix for repeatable sql migrations. (default: R)

    • getSqlMigrationSeparator

      public String getSqlMigrationSeparator()
      Description copied from interface: Configuration
      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 Configuration
      Returns:
      The file name separator for sql migrations. (default: __)

    • getSqlMigrationSuffixes

      public String[] getSqlMigrationSuffixes()
      Description copied from interface: Configuration
      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 Configuration
      Returns:
      The file name suffixes for SQL migrations.

    • isPlaceholderReplacement

      public boolean isPlaceholderReplacement()
      Description copied from interface: Configuration
      Checks whether placeholders should be replaced.
      Specified by:
      isPlaceholderReplacement in interface Configuration
      Returns:
      Whether placeholders should be replaced. (default: true)

    • getPlaceholderSuffix

      public String getPlaceholderSuffix()
      Description copied from interface: Configuration
      Retrieves the suffix of every placeholder.
      Specified by:
      getPlaceholderSuffix in interface Configuration
      Returns:
      The suffix of every placeholder. (default: } )

    • getPlaceholderPrefix

      public String getPlaceholderPrefix()
      Description copied from interface: Configuration
      Retrieves the prefix of every placeholder.
      Specified by:
      getPlaceholderPrefix in interface Configuration
      Returns:
      The prefix of every placeholder. (default: ${ )

    • getPlaceholderSeparator

      public String getPlaceholderSeparator()
      Description copied from interface: Configuration
      Retrieves the separator of default placeholders.
      Specified by:
      getPlaceholderSeparator in interface Configuration
      Returns:
      The separator of default placeholders. (default: : )

    • getScriptPlaceholderSuffix

      public String getScriptPlaceholderSuffix()
      Description copied from interface: Configuration
      Retrieves the suffix of every script placeholder.
      Specified by:
      getScriptPlaceholderSuffix in interface Configuration
      Returns:
      The suffix of every script placeholder. (default: __ )

    • getScriptPlaceholderPrefix

      public String getScriptPlaceholderPrefix()
      Description copied from interface: Configuration
      Retrieves the prefix of every script placeholder.
      Specified by:
      getScriptPlaceholderPrefix in interface Configuration
      Returns:
      The prefix of every script placeholder. (default: FP__ )

    • getPlaceholders

      public Map<String,String> getPlaceholders()
      Description copied from interface: Configuration
      Retrieves the map of <placeholder, replacementValue> to apply to sql migration scripts.
      Specified by:
      getPlaceholders in interface Configuration
      Returns:
      The map of <placeholder, replacementValue> to apply to sql migration scripts.

    • getTarget

      public MigrationVersion getTarget()
      Description copied from interface: Configuration
      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
      • next: The next version of the schema, as defined by the first pending migration
      • <version>? (end with a '?'): Instructs Flyway not to fail if the target version doesn't exist. In this case, Flyway will go up to but not beyond the specified target (default: fail if the target version doesn't exist) Flyway Teams only
      Specified by:
      getTarget in interface Configuration
      Returns:
      The target version up to which Flyway should consider migrations. Defaults to latest

    • isFailOnMissingTarget

      public boolean isFailOnMissingTarget()
      Description copied from interface: Configuration
      Whether to fail if no migration with the configured target version exists (default: true)
      Specified by:
      isFailOnMissingTarget in interface Configuration

    • getCherryPick

      public MigrationPattern[] getCherryPick()
      Description copied from interface: Configuration
      Gets the migrations that Flyway should consider when migrating or undoing. Leave empty to consider all available migrations. Migrations not in this list will be ignored. Flyway Teams only
      Specified by:
      getCherryPick in interface Configuration
      Returns:
      The migrations that Flyway should consider when migrating or undoing.

    • getTable

      public String getTable()
      Description copied from interface: Configuration
      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, or in the schema specified to flyway.defaultSchema.
      Specified by:
      getTable in interface Configuration
      Returns:
      The name of the schema history table that will be used by Flyway. (default: flyway_schema_history)

    • getTablespace

      public String getTablespace()
      Description copied from interface: Configuration
      The tablespace where to create the schema history table that will be used by Flyway. If not specified, Flyway uses the default tablespace for the database connection. This setting is only relevant for databases that do support the notion of tablespace. Its value is simply ignored for all others.
      Specified by:
      getTablespace in interface Configuration
      Returns:
      The tablespace where to create the schema history table that will be used by Flyway.

    • 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 will be closed when Flyway finishes writing the output. Flyway Teams 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 Teams 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. Paths starting with s3: point to a bucket in AWS S3, which must exist. They are in the format s3:(/optionalfolder/subfolder)/filename.sql Paths starting with gcs: point to a bucket in Google Cloud Storage, which must exist. They are in the format gcs:(/optionalfolder/subfolder)/filename.sql Flyway Teams only
      Parameters:
      dryRunOutputFileName - The name of the output file or null to execute the SQL statements directly against the database.

    • setErrorOverrides

      public void setErrorOverrides(String... errorOverrides)
      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 Teams only
      Parameters:
      errorOverrides - The ErrorOverrides or an empty array if none are defined. (default: none)

    • 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).

    • setLoggers

      public void setLoggers(String... loggers)
      The loggers Flyway should use. Valid options are:
      • auto: Auto detect the logger (default behavior)
      • console: Use stdout/stderr (only available when using the CLI)
      • slf4j: Use the slf4j logger
      • log4j2: Use the log4j2 logger
      • apache-commons: Use the Apache Commons logger
      Alternatively you can provide the fully qualified class name for any other logger to use that.

    • setIgnoreMigrationPatterns

      public void setIgnoreMigrationPatterns(String... ignoreMigrationPatterns)
      Ignore migrations that match this comma-separated list of patterns when validating migrations. Each pattern is of the form : See https://documentation.red-gate.com/fd/ignore-migration-patterns-184127507.html for full details Example: repeatable:missing,versioned:pending,*:failed Flyway Teams only

    • setIgnoreMigrationPatterns

      public void setIgnoreMigrationPatterns(ValidatePattern... ignoreMigrationPatterns)
      Ignore migrations that match this array of ValidatePatterns when validating migrations. See https://documentation.red-gate.com/fd/ignore-migration-patterns-184127507.html for full details Flyway Teams only

    • setLocationsAsStrings

      public void setLocationsAsStrings(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, may only contain SQL migrations and are only scanned recursively down non-hidden directories.
      Parameters:
      locations - Locations to scan recursively for migrations. (default: db/migration)

    • setLocations

      public void setLocations(Location... 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, may only contain SQL migrations and are only scanned recursively down non-hidden directories.
      Parameters:
      locations - Locations to scan recursively for migrations. (default: db/migration)

    • setDetectEncoding

      public void setDetectEncoding(boolean detectEncoding)
      Whether Flyway should try to automatically detect SQL migration file encoding
      Parameters:
      detectEncoding - true to enable auto detection, false otherwise Flyway Teams only

    • setReportFilename

      public void setReportFilename(String reportFilename)

    • setExecuteInTransaction

      public void setExecuteInTransaction(boolean executeInTransaction)
      Sets whether SQL should be executed within a transaction.
      Parameters:
      executeInTransaction - true to enable execution of SQL in a transaction, false otherwise

    • setEncodingAsString

      public void setEncodingAsString(String encoding)
      Sets the encoding of SQL migrations.
      Parameters:
      encoding - The encoding of SQL migrations. (default: UTF-8)

    • 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. 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
      • next: The next version of the schema, as defined by the first pending migration
      • <version>? (end with a '?'): Instructs Flyway not to fail if the target version doesn't exist. In this case, Flyway will go up to but not beyond the specified target (default: fail if the target version doesn't exist) Flyway Teams only
      Defaults to latest.

    • setCherryPick

      public void setCherryPick(MigrationPattern... cherryPick)
      Gets the migrations that Flyway should consider when migrating or undoing. Leave empty to consider all available migrations. Migrations not in this list will be ignored. Flyway Teams only

    • setCherryPick

      public void setCherryPick(String... cherryPickAsString)
      Gets the migrations that Flyway should consider when migrating or undoing. Leave empty to consider all available migrations. Migrations not in this list will be ignored. Values should be the version for versioned migrations (e.g. 1, 2.4, 6.5.3) or the description for repeatable migrations (e.g. Insert_Data, Create_Table) Flyway Teams only

    • setPlaceholderPrefix

      public void setPlaceholderPrefix(String placeholderPrefix)
      Sets the prefix of every placeholder.
      Parameters:
      placeholderPrefix - The prefix of every placeholder. (default: ${ )

    • setScriptPlaceholderPrefix

      public void setScriptPlaceholderPrefix(String scriptPlaceholderPrefix)
      Sets the prefix of every script placeholder.
      Parameters:
      scriptPlaceholderPrefix - The prefix of every placeholder. (default: FP__ )

    • setPlaceholderSuffix

      public void setPlaceholderSuffix(String placeholderSuffix)
      Sets the suffix of every placeholder.
      Parameters:
      placeholderSuffix - The suffix of every placeholder. (default: } )

    • setPlaceholderSeparator

      public void setPlaceholderSeparator(String placeholderSeparator)
      Sets the separator of default placeholders.
      Parameters:
      placeholderSeparator - The separator of default placeholders. (default: : )

    • setScriptPlaceholderSuffix

      public void setScriptPlaceholderSuffix(String scriptPlaceholderSuffix)
      Sets the suffix of every placeholder.
      Parameters:
      scriptPlaceholderSuffix - 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)

    • 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 Teams only
      Parameters:
      undoSqlMigrationPrefix - The file name prefix for undo SQL migrations. (default: U)

    • setJavaMigrations

      public void setJavaMigrations(JavaMigration... javaMigrations)
      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.
      Parameters:
      javaMigrations - The manually added Java-based migrations. An empty array if none. (default: none)

    • setStream

      public void setStream(boolean stream)
      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 Teams only
      Parameters:
      stream - true to stream SQL migrations. false to fully loaded them in memory instead. (default: false)

    • setBatch

      public void setBatch(boolean batch)
      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 Teams only
      Parameters:
      batch - true to batch SQL statements. false to execute them individually instead. (default: false)

    • 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: __)

    • 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(String url, String user, String password)
      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.

    • setConnectRetries

      public void setConnectRetries(int connectRetries)
      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. The interval between retries doubles with each subsequent attempt.
      Parameters:
      connectRetries - The maximum number of retries (default: 0).

    • setConnectRetriesInterval

      public void setConnectRetriesInterval(int connectRetriesInterval)
      The maximum time between retries when attempting to connect to the database in seconds. This will cap the interval between connect retry to the value provided.
      Parameters:
      connectRetriesInterval - The maximum time between retries in seconds (default: 120).

    • 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)

    • setSkipExecutingMigrations

      public void setSkipExecutingMigrations(boolean skipExecutingMigrations)
      Whether Flyway should skip actually executing the contents of the migrations and only update the schema history table. This should be used when you have applied a migration manually (via executing the sql yourself, or via an IDE), and just want the schema history table to reflect this. Use in conjunction with cherryPick to skip specific migrations instead of all pending ones. Flyway Teams only

    • setCallbacks

      public void setCallbacks(Callback... callbacks)

    • setCallbacksAsClassNames

      public void setCallbacksAsClassNames(String... callbacks)
      Set the callbacks for lifecycle notifications.
      Parameters:
      callbacks - The fully qualified class names, or full qualified package to scan, of the callbacks for lifecycle notifications. (default: none)

    • loadCallbackLocation

      public List<Callback> loadCallbackLocation(String path, boolean errorOnNotFound)
      Scan this location for classes that implement Callback.
      Parameters:
      path - The path to scan.
      errorOnNotFound - Whether to show an error if the location is not found.

    • 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)

    • setOracleSqlplus

      public void setOracleSqlplus(boolean oracleSqlplus)
      Whether Flyway's support for Oracle SQL*Plus commands should be activated. Flyway Teams only
      Parameters:
      oracleSqlplus - true to active SQL*Plus support. false to fail fast instead. (default: false)

    • setOracleSqlplusWarn

      public void setOracleSqlplusWarn(boolean oracleSqlplusWarn)
      Whether Flyway should issue a warning instead of an error whenever it encounters an Oracle SQL*Plus statementit doesn't yet support. Flyway Teams only
      Parameters:
      oracleSqlplusWarn - true to issue a warning. false to fail fast instead. (default: false)

    • setOracleKerberosCacheFile

      public void setOracleKerberosCacheFile(String oracleKerberosCacheFile)
      When Oracle needs to connect to a Kerberos service to authenticate, the location of the Kerberos cache. Flyway Teams only

    • setKerberosConfigFile

      public void setKerberosConfigFile(String kerberosConfigFile)
      When connecting to a Kerberos service to authenticate, the path to the Kerberos config file. Flyway Teams only

    • setOracleWalletLocation

      public void setOracleWalletLocation(String oracleWalletLocation)
      The location of your Oracle wallet, used to automatically sign in to your databases. Flyway Teams only
      Parameters:
      oracleWalletLocation - The path to your Oracle Wallet

    • setShouldCreateSchemas

      public void setShouldCreateSchemas(boolean createSchemas)
      Whether Flyway should attempt to create the schemas specified in the schemas property.
      Parameters:
      createSchemas -

    • setLicenseKey

      public void setLicenseKey(String licenseKey)
      Your Flyway license key (FL01...). Not yet a Flyway Teams Edition customer? Request your Flyway trial license key to try out Flyway Teams Edition features free for 30 days. Flyway Teams only

    • setOutputQueryResults

      public void setOutputQueryResults(boolean outputQueryResults)
      Whether Flyway should output a table with the results of queries when executing migrations. Flyway Teams only

    • setJdbcProperties

      public void setJdbcProperties(Map<String,String> jdbcProperties)
      Properties to pass to the JDBC driver object. Flyway Teams only

    • configure

      public void configure(Configuration configuration)
      Configure with the same values as this existing configuration.

    • configure

      public void configure(Properties properties)
      Configures Flyway with these properties. This overwrites any existing configuration. Properties are documented here: https://documentation.red-gate.com/fd/parameters-184127474.html

      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.

    • setUrl

      public void setUrl(String url)

    • setUser

      public void setUser(String user)

    • setPassword

      public void setPassword(String password)

    • setDriver

      public void setDriver(String driver)

    • configure

      public void configure(Map<String,String> props)
      Configures Flyway with these properties. This overwrites any existing configuration. Properties are documented here: https://documentation.red-gate.com/fd/parameters-184127474.html

      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.

    • setFailOnMissingLocations

      public void setFailOnMissingLocations(Boolean failOnMissingLocationsProp)

    • getDriver

      public String getDriver()
      Description copied from interface: Configuration
      The JDBC driver of the configuration
      Specified by:
      getDriver in interface Configuration

    • setGroup

      public void setGroup(Boolean groupProp)

    • setMixed

      public void setMixed(Boolean mixedProp)

    • setEncoding

      public void setEncoding(Charset encoding)

    • setPlaceholders

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

    • setSkipDefaultCallbacks

      public void setSkipDefaultCallbacks(Boolean skipDefaultCallbacksProp)

    • setSkipDefaultResolvers

      public void setSkipDefaultResolvers(Boolean skipDefaultResolversProp)

    • setOutOfOrder

      public void setOutOfOrder(Boolean outOfOrderProp)

    • setLockRetryCount

      public void setLockRetryCount(Integer lockRetryCount)

    • setValidateMigrationNaming

      public void setValidateMigrationNaming(Boolean validateMigrationNamingProp)

    • setBaselineOnMigrate

      public void setBaselineOnMigrate(Boolean baselineOnMigrateProp)

    • setBaselineDescription

      public void setBaselineDescription(String baselineDescriptionProp)

    • setBaselineVersion

      public void setBaselineVersion(String baselineVersionProp)

    • setBaselineVersion

      public void setBaselineVersion(MigrationVersion baselineVersion)

    • setValidateOnMigrate

      public void setValidateOnMigrate(Boolean validateOnMigrateProp)

    • setCleanDisabled

      public void setCleanDisabled(Boolean cleanDisabledProp)

    • setReportEnabled

      public void setReportEnabled(Boolean reportEnabled)

    • setCleanOnValidationError

      public void setCleanOnValidationError(Boolean cleanOnValidationErrorProp)

    • setTablespace

      public void setTablespace(String tablespaceProp)

    • setTable

      public void setTable(String tableProp)

    • setSchemas

      public void setSchemas(String[] tokenizeToStringArray)

    • setRepeatableSqlMigrationPrefix

      public void setRepeatableSqlMigrationPrefix(String repeatableSqlMigrationPrefixProp)

    • setPlaceholderReplacement

      public void setPlaceholderReplacement(Boolean placeholderReplacementProp)

    • setInitSql

      public void setInitSql(String initSqlProp)

    • configureUsingEnvVars

      public void configureUsingEnvVars()
      Configures Flyway using FLYWAY_* environment variables.

    • setTarget

      public void setTarget(MigrationVersion target)

    • getModernConfig

      public org.flywaydb.core.internal.configuration.models.ConfigurationModel getModernConfig()
      Specified by:
      getModernConfig in interface Configuration

    • setModernConfig

      public void setModernConfig(org.flywaydb.core.internal.configuration.models.ConfigurationModel modernConfig)

    • getDataSource

      public DataSource getDataSource()
      Description copied from interface: Configuration
      Retrieves the dataSource to use to access the database. Must have the necessary privileges to execute DDL.
      Specified by:
      getDataSource in interface Configuration
      Returns:
      The dataSource to use to access the database. Must have the necessary privileges to execute DDL.

    • setDataSource

      public void setDataSource(DataSource dataSource)

    • getClassLoader

      public ClassLoader getClassLoader()
      Description copied from interface: Configuration
      Retrieves the ClassLoader to use for loading migrations, resolvers, etc. from the classpath.
      Specified by:
      getClassLoader in interface Configuration
      Returns:
      The ClassLoader to use for loading migrations, resolvers, etc. from the classpath. (default: Thread.currentThread().getContextClassLoader() )

    • setClassLoader

      public void setClassLoader(ClassLoader classLoader)

    • getResourceProvider

      public ResourceProvider getResourceProvider()
      Description copied from interface: Configuration
      Retrieves the custom ResourceProvider to be used to look up resources. If not set, the default strategy will be used.
      Specified by:
      getResourceProvider in interface Configuration
      Returns:
      The custom ResourceProvider to be used to look up resources (default: null)

    • setResourceProvider

      public void setResourceProvider(ResourceProvider resourceProvider)

    • getJavaMigrationClassProvider

      public ClassProvider<JavaMigration> getJavaMigrationClassProvider()
      Description copied from interface: Configuration
      Retrieves the custom ClassProvider to be used to look up JavaMigration classes. If not set, the default strategy will be used.
      Specified by:
      getJavaMigrationClassProvider in interface Configuration
      Returns:
      The custom ClassProvider to be used to look up JavaMigration classes (default: null)

    • setJavaMigrationClassProvider

      public void setJavaMigrationClassProvider(ClassProvider<JavaMigration> javaMigrationClassProvider)

    • getJavaMigrations

      public JavaMigration[] getJavaMigrations()
      Description copied from interface: Configuration
      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.
      Specified by:
      getJavaMigrations in interface Configuration
      Returns:
      The manually added Java-based migrations. An empty array if none. (default: none)

    • getResolvers

      public MigrationResolver[] getResolvers()
      Description copied from interface: Configuration
      Retrieves the custom MigrationResolvers to be used in addition to the built-in ones for resolving Migrations to apply.
      Specified by:
      getResolvers in interface Configuration
      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)

    • getPluginRegister

      public org.flywaydb.core.internal.plugin.PluginRegister getPluginRegister()
      Specified by:
      getPluginRegister in interface Configuration

    • setPluginRegister

      public void setPluginRegister(org.flywaydb.core.internal.plugin.PluginRegister pluginRegister)