Pass up/4 opts to Ecto.Migrator (#499)

Author: leandrocp

lib/ecto/migrator.ex

@@ -85,10 +85,19 @@ defmodule Ecto.Migrator do
        repos: Application.fetch_env!(:my_app, :ecto_repos),
        skip: System.get_env("SKIP_MIGRATIONS") == "true"}
 
-  To skip migrations you can also pass `skip: true` or as in the example 
+  To skip migrations you can also pass `skip: true` or as in the example
   set the environment variable `SKIP_MIGRATIONS` to a truthy value.
 
-  To roll back you'd do it normally: 
+  And all other options described in `up/4` are allowed,
+  for example if you want to log the SQL commands,
+  and run migrations in a prefix:
+
+      {Ecto.Migrator,
+       repos: Application.fetch_env!(:my_app, :ecto_repos),
+       log_migrator_sql: true,
+       prefix: "my_app"}
+
+  To roll back you'd do it normally:
 
       $ mix ecto.rollback
 
@@ -466,33 +475,37 @@ defmodule Ecto.Migrator do
     |> collect_migrations(directories)
     |> Enum.sort_by(fn {_, version, _} -> version end)
   end
-  
+
   use GenServer
 
   @doc """
   Runs migrations as part of your supervision tree.
 
   ## Options
 
-    * `:repos` - Required option to tell the migrator which Repo's to 
+    * `:repos` - Required option to tell the migrator which Repo's to
       migrate. Example: `repos: [MyApp.Repo]`
-    * `:skip` - Option to skip migrations.
-      Defaults to `false`.
+
+    * `:skip` - Option to skip migrations. Defaults to `false`.
+
+  Plus all other options described in `up/4`.
+
+  See "Example: Running migrations on application startup" for more info.
   """
   def start_link(opts) do
     GenServer.start_link(__MODULE__, opts, name: __MODULE__)
   end
 
   @impl true
   def init(opts) do
-    repos = Keyword.fetch!(opts, :repos)
-
-    skip? = Keyword.get(opts, :skip, false)
-    migrator = Keyword.get(opts, :migrator, &Ecto.Migrator.run/3)
+    {repos, opts} = Keyword.pop!(opts, :repos)
+    {skip?, opts} = Keyword.pop(opts, :skip, false)
+    {migrator, opts} = Keyword.pop(opts, :migrator, &Ecto.Migrator.run/3)
+    opts = Keyword.put(opts, :all, true)
 
     unless skip? do
       for repo <- repos do
-        {:ok, _, _} = with_repo(repo, &migrator.(&1, :up, all: true))
+        {:ok, _, _} = with_repo(repo, &migrator.(&1, :up, opts))
       end
     end
 

test/ecto/migrator_test.exs

@@ -861,7 +861,7 @@ defmodule Ecto.MigratorTest do
     end
   end
 
-  describe "gen_server" do 
+  describe "gen_server" do
     test "runs the migrator with repos config" do
       migrator = fn repo, _, _ ->
         assert TestRepo == repo
@@ -871,6 +871,16 @@ defmodule Ecto.MigratorTest do
       assert {:ok, :undefined} = start_supervised({Ecto.Migrator, [repos: [TestRepo], migrator: migrator]})
     end
 
+    test "runs the migrator with extra opts" do
+      migrator = fn repo, _, opts ->
+        assert TestRepo == repo
+        assert opts == [all: true, prefix: "foo"]
+        []
+      end
+
+      assert {:ok, :undefined} = start_supervised({Ecto.Migrator, [repos: [TestRepo], migrator: migrator, skip: false, prefix: "foo"]})
+    end
+
     test "skip is set" do
       migrator = fn repo, _, _ ->
         refute TestRepo == repo