Class FlywayExtension
-
Field Summary
Modifier and TypeFieldDescriptionThe description to tag an existing schema with when executing baseline.Whether to automatically call baseline when migrate is executed against a non-empty schema with no schema history table.The version to tag an existing schema with when executing baseline.Whether to batch SQL statements when executing them.String[]
An array of fully qualified FlywayCallback class implementations, or packages to scan for FlywayCallback implementations.String[]
Gets the migrations that Flyway should consider when migrating or undoing.Whether to disable clean.Whether to automatically call clean or not when a validation error occurs.The encoding of the external config files specified with theflyway.configFiles
property.String[]
Config files from which to load the Flyway configuration.String[]
Gradle configurations that will be added to the classpath for running Flyway tasks.int
The maximum number of retries when attempting to connect to the database.int
The maximum time between retries when attempting to connect to the database in seconds.Whether Flyway should attempt to create the schemas specified in the schemas propertThe default schema managed by Flyway.Whether Flyway should try to automatically detect SQL migration file encoding Flyway Teams onlyThe fully qualified classname of the JDBC driver to use to connect to the database.The file where to output the SQL statements of a migration dry run.The encoding of SQL migrations.String[]
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.Whether to fail if a location specified in the flyway.locations option doesn't existWhether to group all pending migrations together in the same transaction when applying them (only recommended for databases with support for DDL transactions).String[]
Ignore migrations that match this comma-separated list of patterns when validating migrations.The SQL statements to run to initialize a new database connection immediately after opening it.The username that will be recorded in the schema history table as having applied the migration.Properties to pass to the JDBC driver object.When connecting to a Kerberos service to authenticate, the path to the Kerberos config file.Your Flyway license key (FL01...).String[]
Locations to scan recursively for migrations.The maximum number of retries when trying to obtain a lock.String[]
The loggers Flyway should use.Whether to allow mixing transactional and non-transactional statements within the same migration.Whether to Flyway's support for Oracle SQL*Plus commands should be activated.Whether Flyway should issue a warning instead of an error whenever it encounters an Oracle SQL*Plus statement it doesn't yet support.The location of your Oracle wallet, used to automatically sign in to your databases.Allows migrations to be run "out of order".Whether Flyway should output a table with the results of queries when executing migrations (default: true).The password to use to connect to the database.The prefix of every placeholder.Whether placeholders should be replaced.Placeholders to replace in SQL migrations.The separator of default placeholders.The suffix of every placeholder.The configuration for plugins You will need to configure this with the key and value specific to your pluginThe file name prefix for repeatable SQL migrations (default: R).String[]
The fully qualified class names of the custom MigrationResolvers to be used in addition (default) or as a replacement (using skipDefaultResolvers) to the built-in ones for resolving Migrations to apply.String[]
The schemas managed by Flyway.The prefix of every script placeholder.The suffix of every script placeholder.If set to true, default built-in callbacks will be skipped, only custom migration callbacks will be used.If set to true, default built-in resolvers will be skipped, only custom migration resolvers will be used.Whether Flyway should skip actually executing the contents of the migrations and only update the schema history table.The file name prefix for versioned SQL migrations.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.sqlString[]
The file name suffixes for SQL migrations.Whether to stream SQL migrations when executing them.The name of the schema history table that will be used by Flyway.The tablespace where to create the schema history table that will be used by Flyway.The target version up to which Flyway should consider migrations.The file name prefix for undo SQL migrations.The JDBC url to use to connect to the database.The user to use to connect to the database.Whether to validate migrations and callbacks whose scripts do not obey the correct naming convention.Whether to automatically call validate or not when running migrate.The working directory to consider when dealing with relative paths for both config files and locations. -
Constructor Summary
-
Method Summary
-
Field Details
-
driver
The fully qualified classname of the JDBC driver to use to connect to the database. -
url
The JDBC url to use to connect to the database. -
user
The user to use to connect to the database. -
password
The password to use to connect to the database. -
connectRetries
public int connectRetriesThe 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. (default: 0)Also configurable with Gradle or System Property: ${flyway.connectRetries}
-
connectRetriesInterval
public int connectRetriesIntervalThe 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. (default: 120)Also configurable with Gradle or System Property: ${flyway.connectRetriesInterval}
-
initSql
The SQL statements to run to initialize a new database connection immediately after opening it. (default:null
)Also configurable with Gradle or System Property: ${flyway.initSql}
-
table
The name of the schema history table that will be used by Flyway. (default: flyway_schema_history) By default, (single-schema mode) the schema history table is placed in the default schema for the connection provided by the datasource. When theflyway.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 toflyway.defaultSchema
.Also configurable with Gradle or System Property: ${flyway.table}
-
tablespace
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 tablespaces. Its value is simply ignored for all others.Also configurable with Gradle or System Property: ${flyway.tablespace}
-
defaultSchema
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).
Also configurable with Gradle or System Property: ${flyway.defaultSchema}
-
schemas
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 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.
Also configurable with Gradle or System Property: ${flyway.schemas} (comma-separated list)
-
baselineVersion
The version to tag an existing schema with when executing baseline. (default: 1) -
baselineDescription
The description to tag an existing schema with when executing baseline. (default: << Flyway Baseline >>) -
locations
Locations to scan recursively for migrations. The location type is determined by its prefix. Unprefixed locations or locations starting withclasspath:
point to a package on the classpath and may contain both SQL and Java-based migrations. Locations starting withfilesystem:
point to a directory on the filesystem, may only contain SQL migrations and are only scanned recursively down non-hidden directories. (default: filesystem:src/main/resources/db/migration) -
resolvers
The fully qualified class names of the custom MigrationResolvers to be used in addition (default) or as a replacement (using skipDefaultResolvers) to the built-in ones for resolving Migrations to apply. (default: none)< -
skipDefaultResolvers
If set to true, default built-in resolvers will be skipped, only custom migration resolvers will be used. (default: false) -
sqlMigrationPrefix
The file name prefix for versioned SQL migrations. (default: V) Versioned SQL migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix, which using the defaults translates to V1_1__My_description.sqlAlso configurable with Gradle or System Property: ${flyway.sqlMigrationPrefix}
-
undoSqlMigrationPrefix
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 onlyAlso configurable with Gradle or System Property: ${flyway.undoSqlMigrationPrefix}
-
repeatableSqlMigrationPrefix
The file name prefix for repeatable SQL migrations (default: R). Repeatable SQL migrations have the following file name structure: prefixSeparatorDESCRIPTIONsuffix, which using the defaults translates to R__My_description.sqlAlso configurable with Gradle or System Property: ${flyway.repeatableSqlMigrationPrefix}
-
sqlMigrationSeparator
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 -
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.Also configurable with Gradle or System Property: ${flyway.sqlMigrationSuffixes}
-
encoding
The encoding of SQL migrations. -
detectEncoding
Whether Flyway should try to automatically detect SQL migration file encoding Flyway Teams onlyAlso configurable with Gradle or System Property: ${flyway.detectEncoding}
-
lockRetryCount
The maximum number of retries when trying to obtain a lock. (default: 50) -
placeholders
Placeholders to replace in SQL migrations. -
jdbcProperties
Properties to pass to the JDBC driver object. Flyway Teams onlyAlso configurable with Gradle or System Property: ${flyway.jdbcProperties}
-
placeholderReplacement
Whether placeholders should be replaced. -
placeholderPrefix
The prefix of every placeholder. -
placeholderSuffix
The suffix of every placeholder. -
placeholderSeparator
The separator of default placeholders. -
scriptPlaceholderPrefix
The prefix of every script placeholder. -
scriptPlaceholderSuffix
The suffix of every script placeholder. -
target
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 schemalatest
: The latest version of the schema, as defined by the migration with the highest versionnext
: 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
latest
. -
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. 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 -
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
-
callbacks
An array of fully qualified FlywayCallback class implementations, or packages to scan for FlywayCallback implementations. -
skipDefaultCallbacks
If set to true, default built-in callbacks will be skipped, only custom migration callbacks will be used. (default: false) -
outOfOrder
Allows migrations to be run "out of order". -
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 withcherryPick
to skip specific migrations instead of all pending ones. -
outputQueryResults
Whether Flyway should output a table with the results of queries when executing migrations (default: true). Flyway Teams onlyAlso configurable with Gradle or System Property: ${flyway.outputQueryResults}
-
validateOnMigrate
Whether to automatically call validate or not when running migrate. (default: true) -
cleanOnValidationError
Whether to automatically call clean or not when a validation error occurs. (default:false
)
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!Also configurable with Gradle or System Property: ${flyway.cleanOnValidationError}
-
ignoreMigrationPatterns
Ignore migrations that match this comma-separated list of patterns when validating migrations. Each pattern is of the form: See https://flywaydb.org/documentation/configuration/parameters/ignoreMigrationPatterns for full details Example: repeatable:missing,versioned:pending,*:failed (default: *:future) Flyway Teams only -
validateMigrationNaming
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.false
to continue normally,true
to fail fast with an exception. (default:false
)Also configurable with Gradle or System Property: ${flyway.validateMigrationNaming}
-
cleanDisabled
Whether to disable clean. (default:false
) This is especially useful for production environments where running clean can be a career limiting move. -
baselineOnMigrate
Whether to automatically call baseline when migrate is executed against a non-empty schema with no schema history table. This schema will then be baselined with thebaselineVersion
before executing the migrations. Only migrations abovebaselineVersion
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!true
if baseline should be called on migrate for non-empty schemas,false
if not. (default:false
) -
mixed
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.true
if mixed migrations should be allowed.false
if an error should be thrown instead. (default:false
) -
group
Whether to group all pending migrations together in the same transaction when applying them (only recommended for databases with support for DDL transactions).true
if migrations should be grouped.false
if they should be applied individually instead. (default:false
) -
installedBy
The username that will be recorded in the schema history table as having applied the migration.null
for the current database user of the connection. (default:null
). -
configurations
Gradle configurations that will be added to the classpath for running Flyway tasks. (default:compile
,runtime
,testCompile
,testRuntime
)Also configurable with Gradle or System Property: ${flyway.configurations}
-
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 messageD-
to force a debug message, but do not show the original sql state and error codeI
to force an info messageI-
to force an info message, but do not show the original sql state and error codeW
to force a warningW-
to force a warning, but do not show the original sql state and error codeE
to force an errorE-
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:
Flyway Teams only*:123:W
Also configurable with Gradle or System Property: ${flyway.errorOverrides}
-
dryRunOutput
The file where to output the SQL statements of a migration dry run. 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 onlynull
to execute the SQL statements directly against the database. (default:null
)Also configurable with Gradle or System Property: ${flyway.dryRunOutput}
-
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. (default:false
Flyway Teams onlyAlso configurable with Gradle or System Property: ${flyway.stream}
-
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. (default:false
) Flyway Teams onlyAlso configurable with Gradle or System Property: ${flyway.batch}
-
oracleSqlplus
Whether to Flyway's support for Oracle SQL*Plus commands should be activated. (default:false
) Flyway Teams onlyAlso configurable with Gradle or System Property: ${flyway.oracle.sqlplus}
-
oracleSqlplusWarn
Whether Flyway should issue a warning instead of an error whenever it encounters an Oracle SQL*Plus statement it doesn't yet support. (default:false
) Flyway Teams onlyAlso configurable with Gradle or System Property: ${flyway.oracle.sqlplusWarn}
-
oracleWalletLocation
The location of your Oracle wallet, used to automatically sign in to your databases. Flyway Teams onlyAlso configurable with Gradle or System Property: ${flyway.oracle.walletLocation}
-
kerberosConfigFile
When connecting to a Kerberos service to authenticate, the path to the Kerberos config file. Flyway Teams only -
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 onlyAlso configurable with Gradle or System Property: ${flyway.licenseKey}
-
configFileEncoding
The encoding of the external config files specified with theflyway.configFiles
property. (default: UTF-8).Also configurable with Gradle or System Property: ${flyway.configFileEncoding}
-
configFiles
Config files from which to load the Flyway configuration. The names of the individual properties match the ones you would use as Gradle or System properties. The encoding of the files is defined by the flyway.configFileEncoding property, which is UTF-8 by default. Relative paths are relative to the project root.Also configurable with Gradle or System Property: ${flyway.configFiles}
-
workingDirectory
The working directory to consider when dealing with relative paths for both config files and locations. (default: basedir, the directory where the POM resides)Also configurable with Gradle or System Property: ${flyway.workingDirectory}
-
createSchemas
Whether Flyway should attempt to create the schemas specified in the schemas propertAlso configurable with Gradle or System Property: ${flyway.createSchemas}
-
failOnMissingLocations
Whether to fail if a location specified in the flyway.locations option doesn't exist -
pluginConfiguration
The configuration for plugins You will need to configure this with the key and value specific to your plugin
-
-
Constructor Details
-
FlywayExtension
public FlywayExtension()
-