Flyway settings
Published 21 July 2023
These are the Flyway configuration parameters, and are read by both Flyway Desktop and the Flyway CLI.
Elements
| Name | Required? | Type | Description |
|---|---|---|---|
| batch | No | Boolean | See here |
| callbacks | No | String array | See here |
| cherryPick | No | String array | See here |
| configFileEncoding | No | String | See here |
| detectEncoding | No | Boolean | See here |
| dryRunOutput | No | String | See here |
| encoding | No | String | See here |
| errorOverrides | No | String array | See here |
| executeInTransaction | No | Boolean | See here |
| group | No | Boolean | See here |
| installedBy | No | String | See here |
| jarDirs | No | String array | See here |
| kerberosConfigFile | No | String | See here |
| licenseKey | No | String | See here |
| locations | No | String array | See here |
| failOnMissingLocations | No | Boolean | See here |
| lockRetryCount | No | Integer | See here |
| loggers | No | String array | See here |
| mixed | No | Boolean | See here |
| outOfOrder | No | Boolean | See here |
| outputQueryResults | No | Boolean | See here |
| skipDefaultCallbacks | No | Boolean | See here |
| skipDefaultResolvers | No | Boolean | See here |
| skipExecutingMigrations | No | Boolean | See here |
| stream | No | Boolean | See here |
| table | No | String | See here |
| tablespace | No | String | See here |
| target | No | String | See here |
| validateMigrationNaming | No | Boolean | See here |
| validateOnMigrate | No | Boolean | See here |
| workingDirectory | No | String | See here |
| createSchemas | No | Boolean | See here |
| defaultSchema | No | String | See here |
| baselineDescription | No | String | See here |
| baselineOnMigrate | No | Boolean | See here |
| baselineVersion | No | String | See here |
| cleanDisabled | No | Boolean | See here |
| cleanOnValidationError | No | Boolean | See here |
| ignoreMigrationPatterns | No | String array | See here |
| baselineMigrationPrefix | No | String | See here |
| repeatableSqlMigrationPrefix | No | String | See here |
| resolvers | No | String array | See here |
| sqlMigrationPrefix | No | String | See here |
| sqlMigrationSeparator | No | String | See here |
| sqlMigrationSuffixes | No | String array | See here |
| undoSqlMigrationPrefix | No | String | See here |
| placeholders | No | String, String map | See here |
| placeholderPrefix | No | String | See here |
| placeholderSeparator | No | String | See here |
| placeholderReplacement | No | Boolean | See here |
| placeholderSuffix | No | String | See here |
| scriptPlaceholderPrefix | No | String | See here |
| scriptPlaceholderSuffix | No | String | See here |
| plugins.sqlserver | No | SQL Server table | Configuration parameters specific to SQL Server |
| oracle | No | Oracle table | Configuration parameters specific to Oracle |
| postgresql | No | PostgreSQL table | Configuration parameters specific to PostgreSQL |
Oracle table
| sqlplus | No | Boolean | See here |
| sqlplusWarn | No | Boolean | See here |
| kerberosCacheFile | No | String | See here |
| walletLocation | No | String | See here |
PostgreSQL table
| transactionalLock | No | Boolean | See here |
SQL Server table
kerberosLoginFile | No | String | See here |
Example
[flyway] defaultSchema = "dbo" locations = ["filesystem:migrations"] validateMigrationNaming = true [flyway.placeholders] placeholderA = "A" placeholderB = "B" [flyway.plugins.sqlserver] kerberosLoginFile = "kerberos-login-file" [flyway.oracle] sqlplus = true [flyway.postgresql] transactionalLock = true
