Ecto SQL
v3.10.2

View Source mix ecto.migrate (Ecto SQL v3.10.2)

Runs the pending migrations for the given repository.

Migrations are expected at "priv/YOUR_REPO/migrations" directory of the current application, where "YOUR_REPO" is the last segment in your repository name. For example, the repository MyApp.Repo will use "priv/repo/migrations". The repository Whatever.MyRepo will use "priv/my_repo/migrations".

You can configure a repository to use another directory by specifying the :priv key under the repository configuration. The "migrations" part will be automatically appended to it. For instance, to use "priv/custom_repo/migrations":

config :my_app, MyApp.Repo, priv: "priv/custom_repo"

This task runs all pending migrations by default. To migrate up to a specific version number, supply --to version_number. To migrate a specific number of times, use --step n.

The repositories to migrate are the ones specified under the :ecto_repos option in the current app configuration. However, if the -r option is given, it replaces the :ecto_repos config.

Since Ecto tasks can only be executed once, if you need to migrate multiple repositories, set :ecto_repos accordingly or pass the -r flag multiple times.

If a repository has not yet been started, one will be started outside your application supervision tree and shutdown afterwards.

Examples 

$ mix ecto.migrate
$ mix ecto.migrate -r Custom.Repo

$ mix ecto.migrate -n 3
$ mix ecto.migrate --step 3

$ mix ecto.migrate --to 20080906120000

Command line options

  • --all - run all pending migrations

  • --log-migrations-sql - log SQL generated by migration commands

  • --log-migrator-sql - log SQL generated by the migrator, such as transactions, table locks, etc

  • --migrations-path - the path to load the migrations from, defaults to "priv/repo/migrations". This option may be given multiple times in which case the migrations are loaded from all the given directories and sorted as if they were in the same one

  • --no-compile - does not compile applications before migrating

  • --no-deps-check - does not check dependencies before migrating

  • --pool-size - the pool size if the repository is started only for the task (defaults to 2)

  • --prefix - the prefix to run migrations on

  • --quiet - do not log migration commands

  • -r, --repo - the repo to migrate

  • --step, -n - run n number of pending migrations

  • --strict-version-order - abort when applying a migration with old timestamp (otherwise it emits a warning)

  • --to - run all migrations up to and including version

  • --to-exclusive - run all migrations up to and excluding version