Script Configuration
Published 04 June 2024
Script Configuration
It is possible to configure SQL migrations on a per-script basis.
This is achieved by creating a script configuration file in the same folder as the migration. The script configuration
file name must match the migration file name, with the .conf suffix added.
Script configuration files do not need to be explicitly listed in the main configuration or the command line.
For example, a migration file V2__my_script.sql would have a script configuration file V2__my_script.sql.conf.
Script Configuration files have a subset of the options from the other ways of configuring Flyway. These parameters are effective at the level of a specific migration rather than globally.
Structure
Script config files have the following structure:
# Settings are simple key-value pairs
key=value
Available Parameters
Should Execute
Whether this migration should be executed or ignored.
See shouldExecute parameter for further details.
Usage
shouldExecute=(${environment}==test)
Placeholder Replacement
Whether this SQL migration should have its Flyway placeholders replaced. This behaves exactly like the global placeholderReplacement parameter but applies only to this script.
See the global placeholders parameter for valid values.
Usage
placeholderReplacement=true
Execute In Transaction
Manually determine whether to execute this migration in a transaction.
See the global executeInTransaction parameter for valid values.
This is useful for databases like PostgreSQL and SQL Server where certain statements can only execute outside a transaction.
Usage
executeInTransaction=false
Encoding
Encoding of this SQL migration.
See the global encoding parameter for valid values.
Caution: changing the encoding after this migration has been run will invalidate the calculated checksum and require a Repair to be run.
Usage
encoding=ISO_8859_1
