Manages PgFlowDashboard database migrations with version tracking.
This module provides versioned migrations for PgFlowDashboard, allowing incremental upgrades and rollbacks.
Usage in Ecto Migrations
defmodule MyApp.Repo.Migrations.AddPgflowDashboard do
use Ecto.Migration
def up, do: PgFlowDashboard.Migration.up()
def down, do: PgFlowDashboard.Migration.down()
endOptions
:prefix- The schema prefix to use. Defaults to "pgflow_dashboard".:version- Target version for up/down migrations. Defaults to current/0.
Version Tracking
Versions are tracked via PostgreSQL comments on the runs_with_progress view:
COMMENT ON VIEW schema.runs_with_progress IS 'PgFlowDashboard version=1';
Summary
Functions
Returns the current migration version supported by this library.
Rolls back migrations to the target version.
Returns the currently migrated version from the database.
Applies migrations up to the target version.
Functions
@spec current_version() :: pos_integer()
Returns the current migration version supported by this library.
@spec down(keyword()) :: :ok
Rolls back migrations to the target version.
Options
:prefix- Schema prefix. Defaults to"pgflow_dashboard".:version- Target version to roll back to. Defaults to0.
@spec migrated_version(keyword()) :: non_neg_integer()
Returns the currently migrated version from the database.
Returns 0 if no migrations have been applied.
@spec up(keyword()) :: :ok
Applies migrations up to the target version.
Options
:prefix- Schema prefix. Defaults to"pgflow_dashboard".:version- Target version. Defaults to1.