Redgate Summit – The Database DevOps Transformation Register now

Flyway Documentation

Poll

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.
  • sqlfluff is required for Code Analysis (-code). You can install it by running pip3 install sqlfluff==1.2.1 or use the redgate/flyway Docker image that has sqlfluff pre-installed.

Flags:

  • One or more flags must be present
Parameter Description
-changes Contact us Include pending changes that will be applied to the database
-drift Contact us Include changes applied out of process to the database
-code In Preview Performs code analysis on your migrations
-dryrun Flyway Teams Performs a dry run, showing what changes would be applied in a real deployment

Configuration parameters:

Format: -key=value

Parameter Description
check.buildUrl URL for a build database.
check.buildUser Username for the build database. Defaults to ‘flyway.user’
check.buildPassword Password for the build database. Defaults to ‘flyway.password’
check.reportFilename [REQUIRED] Destination filename for reports
check.nextSnapshot A snapshot containing all migrations including those that are pending (generated via snapshot)
check.deployedSnapshot A snapshot containing all applied migrations and thus matching what should be in the target (generated via snapshot)
check.appliedMigrations A comma-separated list of migration ids (migration versions or repeatable descriptions) to apply to create snapshots (generated via info)

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.