Environment Overrides

This concept page assumes you understand the following areas of Flyway:

• TOML Configuration File
• Environments
• Flyway

If you have not done so, please review these pages first.

Why is this useful ?

There are parameters that can be defined for all of Flyway however there are instances where you may want more fine-grained control to specify this for a specific environment.

For example, changing cleanDisabled may be appropriate for your test environment but not for your production environment.

How is this used ?

Environments will support configuration overrides by adding a flyway table to your environment. For example:

[flyway]
environment = "test"
locations = ["location1"]

[environments.test]
url = "jdbc:\\..."

[environments.test.flyway]
locations = ["location2","location3"]

If the current environment has an override, its override will be used, in totality, over the root or default version.

To clarify, with a toml looking like the above example, Then locations will be location1 unless using the test environment, in which case locations will be location2 and location3.

Configure via Command-line

The Environment Overrides feature can also be configured via the command-line. For example:

-environments.test.flyway.locations=location4

Note - this will take precedence over other configuration, resulting in the actual location being set to location4

This is due to the CLI Configuration Order

Environment Variable Support

Environment Overrides do not have dedicated environment variable support

Exceptions

The following are not configurable via Environments:

• Environment
• Check
• Cherry Pick
• Dapr Secrets
• Dapr URL
• Email
• Token
• Google Cloud Secret Manager Project
• Google Cloud Secret Manager Secrets
• License Key
• Oracle
• PostgreSQL
• SQL Server
• Undo SQL Migration Prefix
• Vault Secrets
• Vault Token
• Vault URL

Any Command-line only configuration parameters, including

• Working Directory
• Config Files
• Config File Encoding
• Output Type

Note

Parameters that are already part of the environment namespace cannot be overridden as they already exist exclusively in that environment (for example url or schemas).