Back to Flyway

Configuration

documentation/Reference/Configuration.md

latest2.1 KB
Original Source

Here is a complete list of Flyway configurations, organized according to their hierarchy in the TOML configuration file.

Root level settings:

SettingTierTypeDescription
idCommunityStringA unique identifier for the project. This should not be altered.
nameCommunityStringThe display name of the project.
databaseTypeCommunityStringThe type of database being managed by this project.

Root level namespaces:

NamespaceDescription
environmentsAll the database environments used in the development or deployment of this project.
flywayThe configurations relating to the flyway engine. These are parameters for flyway CLI commands.
flywayDesktopThe configurations specific to Flyway Desktop.
redgateCompareThe configurations relating to database comparisons and deployment script generation.

Each individual settings page will list how it can be configured. Settings may be configurable via:

  • TOML configuration
  • CONF configuration
  • Command Line
  • Environment variable
  • Maven
  • Gradle
  • API
  • Flyway Desktop