PhoenixMountable.Migrations.Context (PhoenixMountable v0.2.1)

Copy Markdown View Source

What a library's migration version receives.

  • :repo, :adapter (:postgres, :mysql or :sqlite), :prefix
  • :library — the library's tracking name
  • :version — the version being run
  • :install_options — the options recorded at install time, with string keys and values (as stored), such as %{"primary_key" => "binary_id"}
  • :backfills — how backfills run in this migration: :inline or :deferred (see PhoenixMountable.Backfill)
  • :opts — the options given to up/1 or down/1

Summary

Types

t()

Types

t()

@type t() :: %PhoenixMountable.Migrations.Context{
  adapter: :postgres | :mysql | :sqlite,
  backfills: :inline | :deferred | nil,
  install_options: map(),
  library: String.t(),
  migrations: module(),
  opts: keyword(),
  prefix: String.t() | nil,
  repo: module(),
  version: non_neg_integer()
}