Check
Published 16 November 2022
Check
check produces reports to increase confidence in your migrations.
For -changes and -drift, Flyway migrates against a build database and compares this against the target database in order to generate a report.
This build database will be cleaned before it is used, so you must ensure it does not contain anything of importance.
You can read more about the check concept here.
Requirements
- .NET 6 is required in order to generate reports. You can download it from here.
sqlfluffis required for Code Analysis (-code). You can install it by runningpip3 install sqlfluff==1.2.1or use theredgate/flywayDocker image that hassqlfluffpre-installed.
Flags:
- One or more flags must be present
| Parameter | Edition | Description |
|---|---|---|
| -changes | Enterprise | Include pending changes that will be applied to the database |
| -drift | Enterprise | Include changes applied out of process to the database |
| -dryrun | Teams & Enterprise | Performs a dry run, showing what changes would be applied in a real deployment |
| -code | All | Performs code analysis on your migrations |
Configuration parameters:
Format: -key=value
| Parameter | Operation | Description |
|---|---|---|
| check.buildUrl | changes, drift | URL for a build database. |
| check.buildUser | changes, drift | Username for the build database. Defaults to 'flyway.user' |
| check.buildPassword | changes, drift | Password for the build database. Defaults to 'flyway.password' |
| check.reportFilename | all | [REQUIRED] Destination filename for reports |
| check.nextSnapshot | changes, drift | A snapshot containing all migrations including those that are pending (generated via snapshot) |
| check.deployedSnapshot | changes, drift | A snapshot containing all applied migrations and thus matching what should be in the target (generated via snapshot) |
| check.appliedMigrations | changes, drift | A comma-separated list of migration ids (migration versions or repeatable descriptions) to apply to create snapshots (generated via info) |
| check.failOnDrift | drift | Will Flyway terminate with a non-zero return code if drift detected, see check.failOnDrift |
| check.majorRules | code | A comma-separated list of rule codes that are considered to be 'major' issues, see Check Concept |
| check.minorRules | code | A comma-separated list of rule codes that are considered to be 'minor' issues, see Check Concept |
| check.majorTolerance | code | The number of 'major' issues to be tolerated before throwing an error, see Check Concept |
| check.minorTolerance | code | The number of 'minor' issues to be tolerated before throwing an error, see Check Concept |
check.reportFilename
If this filename does not have the .html suffix, Flyway will add it for you. Flyway also produces a json result for programmatic consumption.
Usage Example:
flyway check -changes -url=jdbc:example:database -user=username -password=password -check.buildUrl=jdbc:example:build_database
Example configuration file
flyway.url=jdbc:example:database
flyway.user=username
flyway.password=password
flyway.check.buildUrl=jdbc:example:build_database
flyway.check.reportFilename=change_report
Database Support
-changes and -drift
Change and drift reports work on the following databases:
- SQL Server
- PostgreSQL
- Oracle
- SQLite
-code and -dryrun
Code analysis and Dry run reports work on any database supported by Flyway.
Check for Oracle
When using Check with an Oracle database there are additional requirements.
If no schemas are specified in the configuration flyway.schemas, then the database connection username will be used as the default schema, otherwise flyway.schemas will be used.
These schema names are case-sensitive.
Check for SQL Server
If you see errors about being unable to connect to your database and you are specifying localhost as the host, then this may be due to not having pipes configured. Using 127.0.0.1 instead should work.
