Model - Flyway — ContextQMD

Description

{% include enterprise.html %}

The model command allows differences found by running the diff command to be applied to the schema model. The schema model must be one of the comparison sources used in the diff artifact provided to model.

See Schema Model for more information.

Usage examples

Saving changes from a database to the schema model

The diff command must first be run to discover the changes (see diff.artifactFilename) that can be saved to the schema model. The diff command can be combined with model into a single flyway call with verb chaining.

For example, the following command generates a diff between a database environment called dev and the schema model, saving the changes back into the schema model:

<pre class="console">> flyway diff model -diff.source=dev -diff.target=schemaModel</pre>

Parameters

Optional

Parameter	Namespace	Description
`artifactFilename`	model	The path to the diff artifact.
`changes`	model	A comma separated list of change ids.
`dryRun`	model	Returns the list of files that would be updated, along with the dependency information and any warnings, but no update is performed.

Universal commandline parameters are listed here.

JSON output format

json

{
  "messages" : [ ],
  "differences": [
    {
      "id": "1",
      "from": { "fullyQualifiedName": "[dbo].[Table1]", "schema": "dbo", "name": "Table1" },
      "to": null,
      "differenceType": "Add",
      "objectType": "Table",
      "selectionType": "Selected"
    },
    {
      "id": "2",
      "from": { "fullyQualifiedName": "[dbo].[View1]", "schema": "dbo", "name": "View1" },
      "to": null,
      "differenceType": "Add",
      "objectType": "View",
      "selectionType": "Dependency"
    }
  ],
  "filesChanged" : [ "C:\\Users\\Project\\schema-model\\MySchema\\Tables\\country.rgm" ]
}

Error codes

This command can produce the following error codes: