Skip to main content

Initialize mig

To start using mig, you need to initialize it. This process creates few things:

  • A db/migrations folder where you will write your migrations.
  • A db folder where mig stores its configuration and the main file to run migrations.
  • A migrations inside db/migrations file to setup the table that will store the migration versions.

To initialize mig, run the following command:

amigo init

You can also create a context to the repository to avoid passing flags each time you run a command. To do so, run the following command:

Postgres:​

amigo context --dsn "postgres://user:password@localhost:5432/dbname"

SQLite:​

amigo context --dsn "sqlite:/path/to/db.sqlite"

Configuration​

A config.yml file will be created in the $amigo_folder folder. You can edit it to add more configurations.

It contains the following fields:

dsn: postgres://user:password@localhost:5432/dbname
folder: db/migrations
json: false
package: migrations
pg-dump-path: pg_dump
schema-version-table: public.mig_schema_versions
shell-path: /bin/bash
debug: false
show-sql: false
show-sql-highlighting: true