Class FlywayExtension
- java.lang.Object
-
- org.flywaydb.gradle.FlywayExtension
-
public class FlywayExtension extends java.lang.Object
The flyway's configuration properties.More info: https://flywaydb.org/documentation/gradle
-
-
Field Summary
Fields Modifier and Type Field Description java.lang.String
baselineDescription
The description to tag an existing schema with when executing baseline.java.lang.Boolean
baselineOnMigrate
Whether to automatically call baseline when migrate is executed against a non-empty schema with no schema history table.java.lang.String
baselineVersion
The version to tag an existing schema with when executing baseline.java.lang.Boolean
batch
Whether to batch SQL statements when executing them.java.lang.String[]
callbacks
An array of fully qualified FlywayCallback class implementationsjava.lang.Boolean
cleanDisabled
Whether to disable clean.java.lang.Boolean
cleanOnValidationError
Whether to automatically call clean or not when a validation error occurs.java.lang.String
configFileEncoding
The encoding of the external config files specified with theflyway.configFiles
property.java.lang.String[]
configFiles
Config files from which to load the Flyway configuration.java.lang.String[]
configurations
Gradle configurations that will be added to the classpath for running Flyway tasks.int
connectRetries
The maximum number of retries when attempting to connect to the database.java.lang.String
defaultSchema
The default schema managed by Flyway.java.lang.String
driver
The fully qualified classname of the jdbc driver to use to connect to the databasejava.lang.String
dryRunOutput
The file where to output the SQL statements of a migration dry run.java.lang.String
encoding
The encoding of Sql migrationsjava.lang.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.java.lang.Boolean
group
Whether to group all pending migrations together in the same transaction when applying them (only recommended for databases with support for DDL transactions).java.lang.Boolean
ignoreFutureMigrations
Ignore future migrations when reading the schema history table.java.lang.Boolean
ignoreIgnoredMigrations
Ignore ignored migrations when reading the schema history table.java.lang.Boolean
ignoreMissingMigrations
Ignore missing migrations when reading the schema history table.java.lang.Boolean
ignorePendingMigrations
Ignore pending migrations when reading the schema history table.java.lang.String
initSql
The SQL statements to run to initialize a new database connection immediately after opening it.java.lang.String
installedBy
The username that will be recorded in the schema history table as having applied the migration.java.lang.String
licenseKey
Your Flyway license key (FL01...).java.lang.String[]
locations
Locations to scan recursively for migrations.java.lang.Boolean
mixed
Whether to allow mixing transactional and non-transactional statements within the same migration.java.lang.Boolean
oracleSqlplus
Whether to Flyway's support for Oracle SQL*Plus commands should be activated.java.lang.Boolean
oracleSqlplusWarn
Whether Flyway should issue a warning instead of an error whenever it encounters an Oracle SQL*Plus statement it doesn't yet support.java.lang.Boolean
outOfOrder
Allows migrations to be run "out of order"java.lang.Boolean
outputQueryResults
Whether Flyway should output a table with the results of queries when executing migrations (default: true).java.lang.String
password
The password to use to connect to the databasejava.lang.String
placeholderPrefix
The prefix of every placeholderjava.lang.Boolean
placeholderReplacement
Whether placeholders should be replaced.java.util.Map<java.lang.Object,java.lang.Object>
placeholders
Placeholders to replace in Sql migrationsjava.lang.String
placeholderSuffix
The suffix of every placeholderjava.lang.String
repeatableSqlMigrationPrefix
The file name prefix for repeatable SQL migrations (default: R).java.lang.String[]
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.java.lang.String[]
schemas
The schemas managed by Flyway.java.lang.Boolean
skipDefaultCallbacks
If set to true, default built-in callbacks will be skipped, only custom migration callbacks will be used.java.lang.Boolean
skipDefaultResolvers
If set to true, default built-in resolvers will be skipped, only custom migration resolvers will be used.java.lang.String
sqlMigrationPrefix
The file name prefix for versioned SQL migrations.java.lang.String
sqlMigrationSeparator
The file name prefix for Sql migrationsjava.lang.String[]
sqlMigrationSuffixes
The file name suffixes for SQL migrations.java.lang.Boolean
stream
Whether to stream SQL migrations when executing them.java.lang.String
table
The name of the schema history table that will be used by Flyway.java.lang.String
tablespace
The tablespace where to create the schema history table that will be used by Flyway.java.lang.String
target
The target version up to which Flyway should consider migrations.java.lang.String
undoSqlMigrationPrefix
The file name prefix for undo SQL migrations.java.lang.String
url
The jdbc url to use to connect to the databasejava.lang.String
user
The user to use to connect to the databasejava.lang.Boolean
validateMigrationNaming
Whether to validate migrations and callbacks whose scripts do not obey the correct naming convention.java.lang.Boolean
validateOnMigrate
Whether to automatically call validate or not when running migrate.java.lang.String
workingDirectory
The working directory to consider when dealing with relative paths for both config files and locations.
-
Constructor Summary
Constructors Constructor Description FlywayExtension()
-
-
-
Field Detail
-
driver
public java.lang.String driver
The fully qualified classname of the jdbc driver to use to connect to the database
-
url
public java.lang.String url
The jdbc url to use to connect to the database
-
user
public java.lang.String user
The user to use to connect to the database
-
password
public java.lang.String password
The password to use to connect to the database
-
connectRetries
public 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. (default: 0)Also configurable with Gradle or System Property: ${flyway.connectRetries}
-
initSql
public java.lang.String 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
public java.lang.String 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 the flyway.schemas property is set (multi-schema mode), the schema history table is placed in the first schema of the list.
Also configurable with Gradle or System Property: ${flyway.table}
-
tablespace
public java.lang.String 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
public java.lang.String 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 Maven or System Property: ${flyway.defaultSchema}
-
schemas
public java.lang.String[] 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 Maven or System Property: ${flyway.schemas} (comma-separated list)
-
baselineVersion
public java.lang.String baselineVersion
The version to tag an existing schema with when executing baseline. (default: 1)
-
baselineDescription
public java.lang.String baselineDescription
The description to tag an existing schema with when executing baseline. (default: << Flyway Baseline >>)
-
locations
public java.lang.String[] locations
Locations to scan recursively for migrations.The location type is determined by its prefix. Unprefixed locations or locations starting with
(default: filesystem:src/main/resources/db/migration)classpath:
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.
-
resolvers
public java.lang.String[] 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
public java.lang.Boolean skipDefaultResolvers
If set to true, default built-in resolvers will be skipped, only custom migration resolvers will be used.(default: false)
-
sqlMigrationPrefix
public java.lang.String 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.sql
Also configurable with Gradle or System Property: ${flyway.sqlMigrationPrefix}
-
undoSqlMigrationPrefix
public java.lang.String 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 Pro and Flyway Enterprise only
Also configurable with Gradle or System Property: ${flyway.undoSqlMigrationPrefix}
-
repeatableSqlMigrationPrefix
public java.lang.String 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.sql
Also configurable with Gradle or System Property: ${flyway.repeatableSqlMigrationPrefix}
-
sqlMigrationSeparator
public java.lang.String sqlMigrationSeparator
The file name prefix for Sql migrationsSql migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix , which using the defaults translates to V1_1__My_description.sql
-
sqlMigrationSuffixes
public java.lang.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.
Also configurable with Gradle or System Property: ${flyway.sqlMigrationSuffixes}
-
encoding
public java.lang.String encoding
The encoding of Sql migrations
-
placeholders
public java.util.Map<java.lang.Object,java.lang.Object> placeholders
Placeholders to replace in Sql migrations
-
placeholderReplacement
public java.lang.Boolean placeholderReplacement
Whether placeholders should be replaced.
-
placeholderPrefix
public java.lang.String placeholderPrefix
The prefix of every placeholder
-
placeholderSuffix
public java.lang.String placeholderSuffix
The suffix of every placeholder
-
target
public java.lang.String 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 version
latest
.
-
callbacks
public java.lang.String[] callbacks
An array of fully qualified FlywayCallback class implementations
-
skipDefaultCallbacks
public java.lang.Boolean skipDefaultCallbacks
If set to true, default built-in callbacks will be skipped, only custom migration callbacks will be used.(default: false)
-
outOfOrder
public java.lang.Boolean outOfOrder
Allows migrations to be run "out of order"
-
outputQueryResults
public java.lang.Boolean outputQueryResults
Whether Flyway should output a table with the results of queries when executing migrations (default: true).Flyway Pro and Flyway Enterprise only
Also configurable with Gradle or System Property: ${flyway.outputQueryResults}
-
validateOnMigrate
public java.lang.Boolean validateOnMigrate
Whether to automatically call validate or not when running migrate. (default: true)
-
cleanOnValidationError
public java.lang.Boolean 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}
-
ignoreMissingMigrations
public java.lang.Boolean ignoreMissingMigrations
Ignore missing migrations when reading the schema history table. These are migrations that were performed by an older deployment of the application that are no longer available in this version. For example: we have migrations available on the classpath with versions 1.0 and 3.0. The schema history table indicates that a migration with version 2.0 (unknown to us) has also been applied. Instead of bombing out (fail fast) with an exception, a warning is logged and Flyway continues normally. This is useful for situations where one must be able to deploy a newer version of the application even though it doesn't contain migrations included with an older one anymore. Note that if the most recently applied migration is removed, Flyway has no way to know it is missing and will mark it as future instead.(default:false
)Also configurable with Gradle or System Property: ${flyway.ignoreMissingMigrations}
-
ignoreIgnoredMigrations
public java.lang.Boolean ignoreIgnoredMigrations
Ignore ignored migrations when reading the schema history table. These are migrations that were added in between already migrated migrations in this version. For example: we have migrations available on the classpath with versions from 1.0 to 3.0. The schema history table indicates that version 1 was finished on 1.0.15, and the next one was 2.0.0. But with the next release a new migration was added to version 1: 1.0.16. Such scenario is ignored by migrate command, but by default is rejected by validate. When ignoreIgnoredMigrations is enabled, such case will not be reported by validate command. This is useful for situations where one must be able to deliver complete set of migrations in a delivery package for multiple versions of the product, and allows for further development of older versions.(default:false
)Also configurable with Gradle or System Property: ${flyway.ignoreIgnoredMigrations}
-
ignorePendingMigrations
public java.lang.Boolean ignorePendingMigrations
Ignore pending migrations when reading the schema history table. These are migrations that are available but have not yet been applied. This can be useful for verifying that in-development migration changes don't contain any validation-breaking changes of migrations that have already been applied to a production environment, e.g. as part of a CI/CD process, without failing because of the existence of new migration versions. (default:false
)Also configurable with Gradle or System Property: ${flyway.ignorePendingMigrations}
-
ignoreFutureMigrations
public java.lang.Boolean ignoreFutureMigrations
Ignore future migrations when reading the schema history table. These are migrations that were performed by a newer deployment of the application that are not yet available in this version. For example: we have migrations available on the classpath up to version 3.0. The schema history table indicates that a migration to version 4.0 (unknown to us) has already been applied. Instead of bombing out (fail fast) with an exception, a warning is logged and Flyway continues normally. This is useful for situations where one must be able to redeploy an older version of the application after the database has been migrated by a newer one. (default:true
)Also configurable with Gradle or System Property: ${flyway.ignoreFutureMigrations}
-
validateMigrationNaming
public java.lang.Boolean 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
public java.lang.Boolean cleanDisabled
Whether to disable clean. (default:false
)This is especially useful for production environments where running clean can be quite a career limiting move.
-
baselineOnMigrate
public java.lang.Boolean baselineOnMigrate
Whether to automatically call baseline when migrate is executed against a non-empty schema with no schema history table. This schema will then be baselined with the
baselineVersion
before executing the migrations. Only migrations 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
public java.lang.Boolean 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
public java.lang.Boolean group
Whether to group all pending migrations together in the same transaction when applying them (only recommended for databases with support for DDL transactions).true
if migrations should be grouped.false
if they should be applied individually instead. (default:false
)
-
installedBy
public java.lang.String 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
public java.lang.String[] 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
public java.lang.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 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:
*:123:W
Also configurable with Gradle or System Property: ${flyway.errorOverrides}
Flyway Pro and Flyway Enterprise only
-
dryRunOutput
public java.lang.String 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.null
to execute the SQL statements directly against the database. (default:null
)Also configurable with Gradle or System Property: ${flyway.dryRunOutput}
Flyway Pro and Flyway Enterprise only
-
stream
public java.lang.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. (default:false
Also configurable with Gradle or System Property: ${flyway.stream}
Flyway Pro and Flyway Enterprise only
-
batch
public java.lang.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. (default:false
)Also configurable with Gradle or System Property: ${flyway.batch}
Flyway Pro and Flyway Enterprise only
-
oracleSqlplus
public java.lang.Boolean oracleSqlplus
Whether to Flyway's support for Oracle SQL*Plus commands should be activated. (default:false
)Also configurable with Gradle or System Property: ${flyway.oracle.sqlplus}
Flyway Pro and Flyway Enterprise only
-
oracleSqlplusWarn
public java.lang.Boolean 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
)Also configurable with Gradle or System Property: ${flyway.oracle.sqlplusWarn}
Flyway Pro and Flyway Enterprise only
-
licenseKey
public java.lang.String licenseKey
Your Flyway license key (FL01...). Not yet a Flyway Pro or Enterprise Edition customer? Request your Flyway trial license key to try out Flyway Pro and Enterprise Edition features free for 30 days.Also configurable with Gradle or System Property: ${flyway.licenseKey}
Flyway Pro and Flyway Enterprise only
-
configFileEncoding
public java.lang.String 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
public java.lang.String[] 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
public java.lang.String 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}
-
-