Tutorial - Generate a deployment changes report from migrations
Published 15 September 2025
Pre-requisites
- Ensure that Flyway is installed and available on your path
- Ensure that Flyway is authenticated to use enterprise features
- Ensure that any secrets necessary for database connection auth are avaialbale
Commands to run
If your target environment and build environment, here with id production and id build respoectively, are defined in your toml configuration run the following
flyway check -changes -buildEnvironment=build -environment=production
If you instead want to pass in the target connection information inline, instead run the following
flyway check -changes "-buildUrl==<JDBC URL>" "-url=<JDBC URL>"
Related command reference
- Navigate to the Environments page
- Ensure that you have both a build environment and your target environment saved and that you can successfully connect to them. Make sure you assign them a sensible id which you can reference from the check command (e.g. build and production).
- Navigate to the Migration scripts page
- Connect to your target environment, by selecting the relevant connection from the Target database dropdown.
- Select Check from the command dropdown in the right hand pane
- Check the changes flag under the command dropdown
- Expand the Advanced settings and click Add parameters
- Select check.buildEnvironment from the drop down. You can start typing to limit the results and find the parameter you need easier.
- Enter build (or whatever id name you gave the build environment) for the parameter value.
- Click Add parameter.
- Click Back.
- Click Run check
