Description

The check -changes command produces a report indicating differences between applied migration scripts on your target database and pending migrations scripts (i.e. the set of instructions you want to use to change your target database).

The report is generated entirely using snapshots of the configured build environment which means that any drift to the production database will be ignored in this report.

Note:

• There is no requirement for the build environment to be in your production system
• Please note that the build environment may be cleaned before the operation starts
• Your Flyway instance assumes that it is the only party changing the build environment so it shouldn't be used concurrently by different developers
• If you get an ERROR: Invalid argument: -check, this is because some systems (for example, Powershell) do not like the period in the argument. You can wrap the arguments in a single or double quotes to work around this (e.g. flyway check -changes "-check.buildURL") or use namespace short-circuiting.

See Migrations - Migration validation for more information.

Usage examples

Generating report based upon environment

flyway check -changes -buildEnvironment="build" -environment="production"

This approach captures snapshots of the build database before and after pending migrations are executed, and uses these as the basis for the comparison which underlies the report.

Generating report based upon applied migrations

flyway info -infoOfState="success,out_of_order" -migrationIds > appliedMigrations.txt
flyway check -changes -buildEnvironment="build" -appliedMigrations="$(cat appliedMigrations.txt)

This approach captures snapshots of the build database before and after pending migrations are executed, and uses these as the basis for the comparison which underlies the report.

Generating report based upon snapshots

flyway check -changes -deployedSnapshot="C:\snapshot1.json" -nextSnapshot="C:\snapshot2.json"

The comparison which underlies the report is generated from the specified snapshots.

Parameters

Conditionally required

When generating report based upon configured build environment

When generating report based upon build environment defined inline

When generating report based upon snapshots

Optional

Universal commandline parameters are listed here.

Settings from the following sections of the Flyway namespace can be specified in relation to database connections:

• General settings
• Settings in database-specific namespaces
• Settings in secrets management namespaces

When a build environment is used, settings from the following sections of the Flyway namespace can also be set:

• Migration location and naming settings
• Migration reading settings
• Migration execution settings
• Flyway schema history settings
• Placeholders

JSON output format

{
  "htmlReport": "report.html",
  "jsonReport": "report.json",
  "individualResults": [
    {
      message: null,
      stackTrace: null,
      onlyInSource: [],
      onlyInTarget: [],
      differences: [
        {
          name: "Table_1",
          schema: "dbo",
          objectType: "Table",
          definitionBefore: "CREATE TABLE Table_1 (id text)",
          definitionAfter: "CREATE TABLE Table_1 (different_id text)",
        },
      ],
      timestamp: "2022-07-22T08-08-33Z",
      database: "testdb",
      operation: "changes",
      flywayVersion: undefined,
      warnings: undefined,
    }
  ]
 }

Error codes

This command can produce the following error codes:

• Generic error codes
• Check error codes