Generating a deployment changes report
Published 15 September 2025
EDITION: ENTERPRISE
Whether using state-based or migrations-based deployment, flyway can generate a deployment report, listing all the schema changes which will be made as a result of running the deployment.
This is a common step in an automated deployment pipeline. It can either be run as a validation step before proceeding with the deployment and/or persisted afterwards as part of an audit trail for the deployment.
Drift analysis and code analysis output can also be added to the same report as separate tabs.
State-based deployment reports
Generating state-based deployment reports requires running the same comparison as generating the deployment script.
It is done by running the check changes command with the check.source parameter set to "schemaModel".
For more information, see this tutorial.
Migrations-based deployment reports
Generating migrations-based deployment reports requires a build database which the migrations can be deployed to, so that the target database can be compared against the result of deploying all the migrations.
It is done by running the check changes command with the check.source parameter set to "migrations" and configuring a build environment, most easily done by adding the configuration to toml and setting the check.buildEnvironment parameter.
For more information, see this tutorial.
