Ga naar hoofdinhoud

Migrations

Database migrations manage schema changes across environments in a controlled, versioned manner.

Overview​

ORMMigration SystemDirectory
TypeORMTypeORM migrationspackages/core/src/lib/database/migrations/
MikroORMMikroORM migrationspackages/core/src/lib/database/migrations/
KnexKnex migrationspackages/core/src/lib/database/knex-migrations/

TypeORM Migrations​

Generate a Migration​

# Auto-generate from entity changes
yarn typeorm migration:generate -n AddEmployeeSkillsColumn

TypeORM compares the current entity definitions with the database schema and generates the necessary SQL.

Create an Empty Migration​

# Create empty migration shell
yarn typeorm migration:create -n CustomMigration

Migration File Format​

import { MigrationInterface, QueryRunner } from "typeorm";

export class AddEmployeeSkillsColumn1704067200000
  implements MigrationInterface
{
  name = "AddEmployeeSkillsColumn1704067200000";

  public async up(queryRunner: QueryRunner): Promise<void> {
    await queryRunner.query(`
      ALTER TABLE "employee"
      ADD COLUMN "skills" text
    `);
  }

  public async down(queryRunner: QueryRunner): Promise<void> {
    await queryRunner.query(`
      ALTER TABLE "employee"
      DROP COLUMN "skills"
    `);
  }
}

Running Migrations​

# Run all pending migrations
yarn typeorm migration:run

# Revert the last migration
yarn typeorm migration:revert

# Show migration status
yarn typeorm migration:show

Database-Specific Migrations​

Migrations are organized by database type:

packages/core/src/lib/database/migrations/
β”œβ”€β”€ postgres/           # PostgreSQL-specific migrations
β”œβ”€β”€ mysql/              # MySQL-specific migrations
└── sqlite/             # SQLite-specific migrations

MikroORM Migrations​

Generate a Migration​

yarn mikro-orm migration:create --initial     # First migration
yarn mikro-orm migration:create               # Subsequent migrations

Running Migrations​

yarn mikro-orm migration:up                   # Run pending
yarn mikro-orm migration:down                 # Revert last
yarn mikro-orm migration:list                 # Show status
yarn mikro-orm migration:fresh                # Drop all & re-run (dev only)

Knex Migrations​

Creating a Knex Migration​

yarn knex migrate:make migration_name

Knex Migration Format​

import { Knex } from "knex";

export async function up(knex: Knex): Promise<void> {
  await knex.schema.createTable("custom_table", (table) => {
    table.uuid("id").primary().defaultTo(knex.raw("uuid_generate_v4()"));
    table.string("name").notNullable();
    table.uuid("tenant_id").notNullable().references("tenant.id");
    table.timestamps(true, true);
  });
}

export async function down(knex: Knex): Promise<void> {
  await knex.schema.dropTable("custom_table");
}

Running Knex Migrations​

yarn knex migrate:latest          # Run all pending
yarn knex migrate:rollback        # Rollback last batch
yarn knex migrate:status          # Show status

Migration Best Practices​

DO​

  • βœ… Always write both up and down methods
  • βœ… Test migrations against all supported databases (PostgreSQL, MySQL, SQLite)
  • βœ… Include tenantId columns and foreign keys for new tables
  • βœ… Use transactions for data migrations
  • βœ… Name migrations descriptively with timestamps

DON'T​

  • ❌ Use DB_SYNCHRONIZE=true in production
  • ❌ Modify existing migrations (create new ones instead)
  • ❌ Delete migration files from version control
  • ❌ Run production migrations without backup

Production Checklist​

  1. βœ… Backup the database
  2. βœ… Run migrations in staging first
  3. βœ… Verify migration:show status
  4. βœ… Monitor migration execution time
  5. βœ… Test rollback procedure

Configuration​

# Auto-synchronize (development only!)
DB_SYNCHRONIZE=false

# Migration logging
DB_LOGGING=schema,migration