Skip to content

Migrations integration

Combining the Docker integration and the migrations features from @compas/store, Compas can prompt you to migrate you Postgres database when necessary.

Getting started

Enabling this integration can be done by running:

compas init migrations

This executes a few things:

  • It creates a migration directory, if not exists.
  • Adds @compas/store as a dependency to your project.
  • Adds the following contents to your config in config/compas.json:
  "migrations": {}


There is nothing to configure for this setup. Compas automatically prompts to either migrate or rebuild the database.

  • Migrate executes the pending migrations.
  • Rebuild clears the full database and runs all migrations from scratch.