Skip to content

System Migrations

Track and manage database migrations that update the database structure.

⚠️ Developer Access Only

This page is only accessible to users with developer privileges.

Overview

Migrations update database structure as the application evolves. Track which migrations have run and manage pending migrations.

Page Layout

  • Migration Status - Overview
  • Applied Migrations - Completed migrations
  • Pending Migrations - Not yet applied
  • Run Migration - Execute pending

Migration Information

FieldDescription
Migration NameIdentifier (usually dated)
DescriptionWhat changes it makes
StatusApplied/Pending
Applied AtWhen executed
DurationExecution time

Common Tasks

Viewing Migration Status

  1. Go to DeveloperToolsSystem Migrations
  2. View applied migrations
  3. Check for pending migrations
  4. Review migration history

Running Pending Migrations

  1. View pending migrations
  2. Review what each will do
  3. Click Run Migrations
  4. Monitor progress
  5. Verify changes

Viewing Migration Details

  1. Click on migration
  2. View:
    • Full description
    • SQL changes
    • Execution log
    • Any errors

Migration Status

StatusMeaning
AppliedSuccessfully executed
PendingNot yet run
FailedError during execution
Rolled BackMigration reversed

Best Practices

Before Migrating

  • Backup database
  • Review migration changes
  • Test in staging first
  • Schedule maintenance window

During Migration

  • Monitor progress
  • Watch for errors
  • Don't interrupt

After Migration

  • Verify data integrity
  • Test application
  • Monitor for issues

Tips

  • Always Backup - Before any migration
  • Test First - Run in staging
  • Schedule Carefully - During low usage
  • Keep History - Track all migrations
  • Rollback Plan - Know how to reverse

💡 Note: Migrations are critical operations. Always ensure proper backups before running.

Released under the MIT License.