Want to deploy your JVM, Node.js and Go apps effortlessly to AWS? Try our service Boxfuse

Environment Variables

Flyway optionally supports loading configuration via environment variables.

Reference

The following environment variables are supported:

Environment Variable Description
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_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 classpath: point to a package on the classpath and may contain both sql and java-based migrations.
Locations starting with filesystem: point to a directory on the filesystem and may only contain sql migrations.
FLYWAY_JAR_DIRS Comma-separated list of directories containing JDBC drivers and Java-based migrations
FLYWAY_SQL_MIGRATION_PREFIX The file name prefix for Sql migrations
FLYWAY_REPEATABLE_SQL_MIGRATION_PREFIX The file name prefix for repeatable Sql migrations
FLYWAY_SQL_MIGRATION_SEPARATOR The file name separator for Sql migrations
FLYWAY_SQL_MIGRATION_SUFFIX The file name suffix for Sql migrations
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
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 FlywayCallback 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 current designates the current version of the schema.
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_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 table. This schema will then be baselined 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!

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

Config Files