Change Report for State-based deployments
Published 02 April 2025
Description
The flyway check -changes
command produces a report indicating the differences between what is in the Schema Model on disk and the target database. This report allows you to:
- Pre-deployment - Give reviewers a quick and easy way to see the exact number of objects that will be changed in a deployment and shows how many objects will be added, modified, or deleted. It also allows reviewers to drill down into each object and see a side-by-side difference for each change.
- Post-deployment - Have a history of what objects were changed and how in each deployment.
This visual representation can give reviewers a quicker understanding of the changes instead of reading through an entire deployment script, which could be 1,000s of lines long.
Usage example
Generating a Change Report when deploying to a specific environment
- flyway check -changes -changesSource="schemaModel" -environment="production"
The target environment is defined in your TOML file and provides the connection information for the target that you would deploy to.
Use the -reportFilename
to explicitly name your report. For full details, see the flyway check -changes
command.