Skip to main content

Database Migrations

After making any changes in the server/src/schema, a database migration need to run in order to register the changes in the database. Follow the steps below to create a new migration.

  1. Run the command
mise //server:migrations generate <migration-name>
  1. Check if the migration file makes sense.
  2. Move the migration file to folder ./server/src/schema/migrations in your code editor.
  3. Run the command
mise //server:migrations sync-order

The last step adds the migration to the ORDER manifest, which records the order migrations run in. It is committed so that two branches adding a migration conflict in git instead of silently merging out of order, which would stop the server from starting for anyone who ran them in the wrong order.

The server will automatically detect *.ts file changes and restart. Part of the server start-up process includes running any new migrations, so it will be applied immediately.

Reverting a Migration​

If you need to undo the most recently applied migration—for example, when developing or testing on schema changes—run:

mise //server:migrations revert

This command rolls back the latest migration and brings the database schema back to its previous state.