Should Execute
Published 15 January 2025
Description
shouldExecute
is a script configuration option that lets you define when a migration should execute.
This consists of an expression which evaluates to a Boolean value. Flyway will change behavior for this migration depending on the expression evaluation:
- If it evaluates to true, this migration is executed
- If it evaluates to false, this migration is ignored
- If it fails to evaluate, an error will be returned
This evaluation will be reflected in the migration state for all flyway commands, such as the info command.
Unlike skipExecutingMigrations, this will not update the schema history table when a script is not executed.
Valid values
- Either
true
orfalse
<A>==<B>
or<A>!=<B>
where<A>
and<B>
are placeholders or literal values.- Combinations of these using
&&
(AND),||
(OR) and parentheses( )
Default
true
Usage
Script configuration File
shouldExecute=${flyway:defaultSchema}==A