Skip to main content
Version: v0.13

DB Migration


Starting in v0.10.0, DevLake provides a lightweight migration tool for executing migration scripts. Both framework itself and plugins define their migration scripts in their own migration folder. The migration scripts are written with gorm in Golang to support different SQL dialects.

Migration Script

Migration script describes how to do database migration. They implement the Script interface. When DevLake starts, scripts register themselves to the framework by invoking the Register function

type Script interface {
// this function will contain the business logic of the migration (e.g. DDL logic)
Up(ctx context.Context, db *gorm.DB) error
// the version number of the migration. typically in date format (YYYYMMDDHHMMSS), e.g. 20220728000001. Migrations are executed sequentially based on this number.
Version() uint64
// The name of this migration
Name() string

Migration Model

For each migration we define a "snapshot" datamodel of the model that we wish to perform the migration on. The fields on this model shall be identical to the actual model, but unlike the actual one, this one will never change in the future. The naming convention of these models is <ModelName>YYYYMMDD and they must implement the func TableName() string method, and consumed by the Script::Up method.

Table migration_history

The table tracks migration scripts execution and schemas changes. From which, DevLake could figure out the current state of database schemas.


Each plugin has a migrationscripts subpackage that lists all the migrations to be executed for that plugin. You will need to add your migration to that list for the framework to pick it up. Similarly, there is such a package for the framework-only migrations defined under the models package.

How It Works

  1. Check migration_history table, calculate all the migration scripts need to be executed.
  2. Sort scripts by Version in ascending order.
  3. Execute scripts.
  4. Save results in the migration_history table.