Type to start searching...

Upgrade

The set of changes to a model's Relational Datasource(s) from version to version.

Description

Upgrade files maintain all of the changes that have taken place to the model's database schema(s) over time. They require a special Version table in the datasource. They are used by tools like the Data Load Tool and the Database Schema Tool to bring databases up to date in different environments.

Each step in the Upgrade file has a version property. The upgrade process determines the current version of the database - by looking at the version column in the Version table - and applies all later version steps to the database to make any required data changes, schema changes, or data seeding needed to update the database to the most recent version.

Steps include Labels, Load Steps, Scripts, and RelationalDatabaseUpgrade steps.

The RelationalDatabaseUpgrade steps are very similar to the structure of the Relational DataSource metadata. They specify the changes to make and the target datasource from the model.

Properties
description : string

The upgrade description.

Content
  • Choice of:

    • Label [1..1] - Label steps document new version numbers resulting from base model merges.

    • Load [1..1] - A Load step enables a reload of the database and seed data.

    • Script [1..1] - A Script step allows you to run script against the model to "fix up" data

    • RelationalDatabaseUpgrade [1..1] - The set of Relational Upgrade steps to describe what schema changes took place in this version

    • any [1..1]