Rivet.Migration.Manage (rivet v2.5.2)

Summary

Types

rivet_config()

rivet_error()

rivet_migration_input_any()

rivet_migration_input_external()

rivet_migration_input_include()

rivet_migration_input_model()

rivet_migration_state()

rivet_migrations()

rivet_state_result()

Functions

add_include(file, model)

add_migration(model, label, cfg)

module_parts(model, label, ver, cfg)

iex> cfg = %{app: :rivet_email, base: "Rivet.Email", base_path: "../rivet_email", models_root: "../rivet_email/lib/email", opts: [base_dir: "../rivet_email"], tests_root: "../rivet_email/test/email"} iex> ver = 2000 iex> module_parts("Template", "doctest", ver, cfg) %{base: "Doctest", name: %{migration: Rivet.Email.Template.Migrations.Doctest, model: "Rivet.Email.Template"}, path: %{migration: "priv/rivet/migrations/template/doctest.exs", migrations: "priv/rivet/migrations/template", model: "../rivet_email/lib/email/template"}, ver: 2000}

Types

rivet_config()

@type rivet_config() :: %{
  app: String.t(),
  base: atom(),
  base_path: String.t(),
  models_root: String.t(),
  opts: Keyword.t(),
  tests_root: String.t()
}

rivet_error()

@type rivet_error() :: {:error, String.t() | atom()}

rivet_migration_input_any()

@type rivet_migration_input_any() ::
  rivet_migration_input_include()
  | rivet_migration_input_external()
  | rivet_migration_input_model()

rivet_migration_input_external()

@type rivet_migration_input_external() :: %{
  external: String.t(),
  migrations: [rivet_migration_input_include()]
}

rivet_migration_input_include()

@type rivet_migration_input_include() :: %{include: module(), prefix: integer()}

rivet_migration_input_model()

@type rivet_migration_input_model() :: map()

rivet_migration_state()

@type rivet_migration_state() :: %{
  idx: %{required(integer()) => Rivet.Migration.t()},
  mods: %{required(atom()) => list()}
}

rivet_migrations()

@type rivet_migrations() :: [Rivet.Migration.t()]

rivet_state_result()

@type rivet_state_result() :: {:ok, rivet_migration_state()} | rivet_error()

Functions

add_include(file, model)

add_migration(model, label, cfg)

module_parts(model, label, ver, cfg)

iex> cfg = %{app: :rivet_email, base: "Rivet.Email", base_path: "../rivet_email", models_root: "../rivet_email/lib/email", opts: [base_dir: "../rivet_email"], tests_root: "../rivet_email/test/email"} iex> ver = 2000 iex> module_parts("Template", "doctest", ver, cfg) %{base: "Doctest", name: %{migration: Rivet.Email.Template.Migrations.Doctest, model: "Rivet.Email.Template"}, path: %{migration: "priv/rivet/migrations/template/doctest.exs", migrations: "priv/rivet/migrations/template", model: "../rivet_email/lib/email/template"}, ver: 2000}