Prepare

Flyway Enterprise

The prepare command generates a deployment script from a schemaModel, an environment, a diff artifact, or migrations

Usage examples

Generate a deployment script to update target database based on schema model

flyway prepare -source=schemaModel -target=production -scriptFilename="D__deployment.sql"

[!Important]
When the schemas are different between source and target, make sure to configure schema model schemas. If a target schema does not exist in the schema model, the generated script will contain SQL for deleting the schema.

Generate a deployment script to update target database based on source database

flyway prepare -source=env:dev -target=production -scriptFilename="D__deployment.sql"

Generate a deployment script from a diff artifact

flyway prepare -artifactFilename="myArtifactPath" -changes="-" -scriptFilename="D__deployment.sql"

Generates a deployment script which can be executed against a target database to make it match the target of the original comparison.

The artifact needed for this approach is generated by flyway diff.

This approach allows for programmatic partial selection of changes to deploy.

Generate a deployment script from migrations

flyway prepare -source=migrations -target=production-equivalent -scriptFilename="D__deployment.sql"

Generates a deployment script which can be executed against a target database to deploy all pending migrations.

This is a useful alternative to flyway migrate when you need to deploy to equivalent databases where flyway is not available, or want to review the exact script to be run before execution, but it does come with limitations:

• This approach does not handle Java migrations or other non-SQL migrations
• Callbacks are not supported

This is currently functionally equivalent to running a dry run on migrate.

Complete list of parameters for deploying from schema model or source database

Required

Optional

Note that comparison options, filters, and static data configuration are all supported, but can currently only be specified within the toml config file, and cannot yet be overridden on the command line

Complete list of options for deploying from artifact

Optional

Note that comparison options, filters, and static data configuration are all supported, but can currently only be specified within the toml config file, and cannot yet be overridden on the command line

Complete list of options for deploying from migrations

Required

Optional

JSON output format

{
  "scriptWasGenerated": true,
  "scriptFilename": "C:\\workingDirectory\\D__deployment.sql",
  "includedDependencies": [
    "dbo.someDependency"
  ],
  "warnings": [
    {
      "type": "WARNING_TYPE",
      "message": "Warning message"
    }
  ]
}