Skip to content

Commit 02beb19

Browse files
Update docs
1 parent 29c3af3 commit 02beb19

File tree

1 file changed

+28
-3
lines changed

1 file changed

+28
-3
lines changed

lib/ecto/migrator.ex

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,7 @@ defmodule Ecto.Migrator do
190190
insufficient permissions to create the table. Note that migrations
191191
commands may fail if this is set to true. Defaults to `false`. Accepts a
192192
boolean.
193+
* `:telemetry_options` - extra options to attach to telemetry events.
193194
"""
194195
@spec migrated_versions(Ecto.Repo.t, Keyword.t) :: [integer]
195196
def migrated_versions(repo, opts \\ []) do
@@ -213,6 +214,7 @@ defmodule Ecto.Migrator do
213214
See `c:Ecto.Repo.put_dynamic_repo/1`.
214215
* `:strict_version_order` - abort when applying a migration with old timestamp
215216
(otherwise it emits a warning)
217+
* `:telemetry_options` - extra options to attach to telemetry events.
216218
"""
217219
@spec up(Ecto.Repo.t, integer, module, Keyword.t) :: :ok | :already_up
218220
def up(repo, version, module, opts \\ []) do
@@ -282,7 +284,7 @@ defmodule Ecto.Migrator do
282284
* `:prefix` - the prefix to run the migrations on
283285
* `:dynamic_repo` - the name of the Repo supervisor process.
284286
See `c:Ecto.Repo.put_dynamic_repo/1`.
285-
287+
* `:telemetry_options` - extra options to attach to telemetry events.
286288
"""
287289
@spec down(Ecto.Repo.t, integer, module) :: :ok | :already_down
288290
def down(repo, version, module, opts \\ []) do
@@ -448,16 +450,39 @@ defmodule Ecto.Migrator do
448450
Equivalent to:
449451
450452
Ecto.Migrator.migrations(repo, [Ecto.Migrator.migrations_path(repo)])
453+
454+
## Options
451455
456+
* `:prefix` - the prefix to run the migrations on
457+
* `:dynamic_repo` - the name of the Repo supervisor process.
458+
See `c:Ecto.Repo.put_dynamic_repo/1`.
459+
* `:skip_table_creation` - skips any attempt to create the migration table
460+
Useful for situations where user needs to check migrations but has
461+
insufficient permissions to create the table. Note that migrations
462+
commands may fail if this is set to true. Defaults to `false`. Accepts a
463+
boolean.
464+
* `:telemetry_options` - extra options to attach to telemetry events.
452465
"""
453466
@spec migrations(Ecto.Repo.t) :: [{:up | :down, id :: integer(), name :: String.t}]
454-
def migrations(repo) do
455-
migrations(repo, [migrations_path(repo)])
467+
def migrations(repo, opts \\ []) do
468+
migrations(repo, [migrations_path(repo)], opts)
456469
end
457470

458471
@doc """
459472
Returns an array of tuples as the migration status of the given repo,
460473
without actually running any migrations.
474+
475+
## Options
476+
477+
* `:prefix` - the prefix to run the migrations on
478+
* `:dynamic_repo` - the name of the Repo supervisor process.
479+
See `c:Ecto.Repo.put_dynamic_repo/1`.
480+
* `:skip_table_creation` - skips any attempt to create the migration table
481+
Useful for situations where user needs to check migrations but has
482+
insufficient permissions to create the table. Note that migrations
483+
commands may fail if this is set to true. Defaults to `false`. Accepts a
484+
boolean.
485+
* `:telemetry_options` - extra options to attach to telemetry events.
461486
"""
462487
@spec migrations(Ecto.Repo.t, String.t | [String.t], Keyword.t) ::
463488
[{:up | :down, id :: integer(), name :: String.t}]

0 commit comments

Comments
 (0)