Versioned schema migrations for CouncilEx's opt-in Ecto-backed features (Registry, Reliability, Recorder). Modeled after Oban.Migration.

Usage

Generate a regular Ecto migration in your application and delegate the up/down to this module:

defmodule MyApp.Repo.Migrations.AddCouncilEx do
  use Ecto.Migration

  def up,   do: CouncilEx.Persistence.Migration.up()
  def down, do: CouncilEx.Persistence.Migration.down()
end

Run with mix ecto.migrate like any other migration. Subsequent schema bumps land as new versions; you call up(version: N) from a new migration file to step forward.

Options

• :version — target schema version. Defaults to the latest shipped version (Elixir.CouncilEx.Persistence.Migration.current_version/0). When stepping up/1, the module migrates from the highest applied version up to this target. When stepping down/1, it reverses from the current applied version down to one below this target.

• :components — which subsystems to install. Atom or list. Valid values:

  • :all (default) — every component
  • :registry — <prefix>registry table backing CouncilEx.Registry.Ecto
  • :reliability — <prefix>reliability table backing CouncilEx.Reliability.Ecto
  • :recorder — <prefix>runs and <prefix>run_events tables backing CouncilEx.Recorder.Ecto

  Pass a subset to opt out of components you do not use:

  CouncilEx.Persistence.Migration.up(components: [:recorder])

• :table_prefix — string prepended to every table name. Defaults to "council_ex_". Pick a different prefix if the default collides with your application's tables.

All options must match between up/1 and down/1 for a given migration. Mixing components or prefixes between paired up/down calls leaves orphaned tables.