Redgate Flyway

Flyway project configurations are stored in a TOML file.

The full list of configurations can be found in the reference documentation.

Flyway Desktop also has some local settings which are stored on your local machine and not persisted to projects.

TOML configuration types and how to update them

At the root level the settings divide up into the following categories:

Root level settings
Environment configuration
Flyway settings
Flyway Desktop settings
Redgate Compare settings

All configurations can be manually edited in the TOML. For guidance on TOML syntax, see here.

Root level settings

These are set on project initialization, and other than the project name, should not be altered following project creation.

Environment configuration

The configurations for your environments. This includes any environments you need in your development processes. It is also preferable to configure any environments that you will use in your CI/CD pipelines this way, as it will simplify your build scripts.

Note that it is also possible to override many Flyway settings per environment.

Environment configurations can be added or edited via the connection dialogs in Flyway Desktop.

Flyway settings

These are all the settings which affect the behaviour of the Flyway engine. These will alter the behaviour of the Flyway commands.

By and large it is not possible to update these in the configuration file via Flyway Desktop, although they are generally accessible as advanced parameters when invoking Flyway commands from the Migrations tab.

Flyway Desktop settings

These are configurations specific to Flyway Desktop which will have no affect on the underlying Flyway engine commands.

These may be editable via the Flyway Desktop settings menu.

Redgate Compare settings

These are the configurations relating to database comparisons and deployment script generation. They will affect all commands that make use of the Redgate comparison capability.

For updating these settings, see the following tutorials:

Filter files

Comparison filtering is configured using separate filter files. The formats differ for each database. See these tutorials for guidance on how to configure them:

Upgrading configurations from .conf

Updating Flyway Desktop machine settings

Flyway Desktop settings can be updated from the top nav bar. For updating Dark mode, see here.

Relevant tutorials

Redgate University

Filtering (4 minute video)