The Flyway command-line tool, Maven plugin and
Gradle plugin optionally support loading configuration via environment variables.
This also possible using the Flyway API by calling the
envVars() method on the configuration.
The following environment variables are supported:
|FLYWAY_CONFIG_FILES||Comma-separated list of configuration files to load|
|FLYWAY_CONFIG_FILE_ENCODING||The encoding to use when loading configuration files|
|FLYWAY_URL||The jdbc url to use to connect to the database|
|FLYWAY_DRIVER||The fully qualified classname of the JDBC driver to use to connect to the database|
|FLYWAY_USER||The user to use to connect to the database|
|FLYWAY_PASSWORD||The password to use to connect to the database|
|FLYWAY_CONNECT_RETRIES||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.|
|FLYWAY_INIT_SQL||The SQL statements to run to initialize a new database connection immediately after opening it.|
|FLYWAY_SCHEMAS||Comma-separated case-sensitive list of schemas managed by Flyway.
The first schema in the list will be automatically set as the default one during the migration. It will also be the one containing the schema history table.
|FLYWAY_TABLE||The name of Flyway's schema history table.
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.
|FLYWAY_LOCATIONS||Comma-separated list of locations to scan recursively for migrations. The location type is determined by its prefix.
Unprefixed locations or locations starting with
Locations starting with
|FLYWAY_JAR_DIRS||Comma-separated list of directories containing JDBC drivers and Java-based migrations|
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
|FLYWAY_UNDO_SQL_MIGRATION_PREFIX Flyway Pro||
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
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
|FLYWAY_SQL_MIGRATION_SEPARATOR||The file name separator for Sql migrations|
Comma-separated list of file name suffixes for SQL migrations.
SQL migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix , which using the defaults translates to V1_1__My_description.sqlMultiple suffixes (like .sql,.pkg,.pkb) can be specified for easier compatibility with other tools such as editors with specific file associations.
|FLYWAY_STREAM Flyway Pro||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_BATCH Flyway Pro||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_MIXED||Whether to allow mixing transactional and non-transactional statements within the same migration|
|FLYWAY_GROUP||Whether to group all pending migrations together in the same transaction when applying them (only recommended for databases with support for DDL transactions)|
|FLYWAY_ENCODING||The encoding of Sql migrations|
|FLYWAY_PLACEHOLDER_REPLACEMENT||Whether placeholders should be replaced|
|FLYWAY_PLACEHOLDERS_<NAME>||Placeholders to replace in SQL migrations. For example to replace a placeholder named
|FLYWAY_PLACEHOLDER_PREFIX||The prefix of every placeholder|
|FLYWAY_PLACEHOLDER_SUFFIX||The suffix of every placeholder|
|FLYWAY_RESOLVERS||Comma-separated list of fully qualified class names of custom MigrationResolver implementations to be used in addition to the built-in ones for resolving Migrations to apply.|
|FLYWAY_SKIP_DEFAULT_RESOLVERS||Whether default built-in resolvers (sql, jdbc and spring-jdbc) should be skipped. If true, only custom resolvers are used.|
|FLYWAY_CALLBACKS||Comma-separated list of fully qualified class names of Callback implementations to use to hook into the Flyway lifecycle.|
|FLYWAY_SKIP_DEFAULT_CALLBACKS||Whether default built-in callbacks (sql) should be skipped. If true, only custom callbacks are used.|
|FLYWAY_TARGET||The target version up to which Flyway should consider migrations. Migrations with a higher version number will be ignored. The special value
|FLYWAY_OUT_OF_ORDER||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.
|FLYWAY_VALIDATE_ON_MIGRATE||Whether to automatically call validate or not when running migrate.
For each sql migration a CRC32 checksum is calculated when the sql script is executed. The validate mechanism checks if the sql migration in the classpath still has the same checksum as the sql migration already executed in the database.
|FLYWAY_CLEAN_ON_VALIDATION_ERROR||Whether to automatically call clean or not when a validation error occurs.
This is exclusively intended as a convenience for development. Even tough 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 !
|FLYWAY_IGNORE_MISSING_MIGRATIONS||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.|
|FLYWAY_IGNORE_IGNORED_MIGRATIONS||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.|
|FLYWAY_IGNORE_PENDING_MIGRATIONS||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.|
|FLYWAY_IGNORE_FUTURE_MIGRATIONS||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.|
|FLYWAY_CLEAN_DISABLED||Whether to disable clean. This is especially useful for production environments where running clean can be quite a career limiting move.|
|FLYWAY_BASELINE_ON_MIGRATE||Whether to automatically call baseline when migrate is executed against a non-empty schema with no metadata
This schema will then be baselined with the
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!
|FLYWAY_BASELINE_VERSION||The version to tag an existing schema with when executing baseline|
|FLYWAY_BASELINE_DESCRIPTION||The description to tag an existing schema with when executing baseline|
|FLYWAY_INSTALLED_BY||The username that will be recorded in the schema history table as having applied the migration|
|FLYWAY_ERROR_OVERRIDES Flyway Pro||
Comma-sparated list of rules for the built-in error handling that lets you override specific SQL states and errors codes from error to warning or from warning to error.
Each error override has the following format:
For example, to force Oracle stored procedure compilation issues to produce
errors instead of warnings, the following errorOverride can be used:
|FLYWAY_DRYRUN_OUTPUT Flyway Pro||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. Omit to use the default mode of executing the SQL statements directly against the database.|
|FLYWAY_ORACLE_SQLPLUS Flyway Pro||Whether to Flyway's support for Oracle SQL*Plus commands should be activated.|
|FLYWAY_LICENSE_KEY Flyway Pro||Flyway's license key.|