Run database migrations

Get ready to…

• Check migration status
• Run database migrations
• Verify migrations completed successfully

Run database migrations

Paideia LMS uses database migrations to set up and update your database schema. When you first run Paideia LMS, migrations are automatically applied during startup. However, you can also run migrations manually using the CLI.

Check migration status

1. Check the current migration status:

   ./paideia migrate status

   This will show you which migrations have been applied and which are pending.

Run migrations

2. Run all pending migrations:

   ./paideia migrate up

   This will apply any migrations that haven’t been executed yet.

   Automatic migrations

   When you start Paideia LMS with ./paideia server, migrations are automatically applied during startup. You only need to run migrations manually if you want to apply them before starting the server.

3. Verify migrations completed successfully:

   ./paideia migrate status

   All migrations should now show as “Applied”.

Database backup

4. (Optional) Create a database backup before proceeding:

   ./paideia migrate dump -o backup-before-setup.sql

   This creates a backup of your database that you can restore if needed.

Migration best practices

• Always check migration status before and after applying migrations
• Create backups before running migrations in production
• Test migrations in a development environment first
• Review the CLI Reference for more migration commands

Checklist

• I can check migration status.
• I can run database migrations.
• I have verified migrations completed successfully.
• I have created a database backup (optional).

Resources

• CLI Reference internal — complete reference for Paideia LMS CLI commands

• Upgrading Paideia LMS internal — guide for upgrading and managing migrations