erlang_migrate (erlang_migrate v0.3.4)

View Source

数据库迁移库统一入口 / Database migration library facade — up/down/goto/version/force/drop/create，编排排他锁、驱动与迁移文件 source，对标 golang-migrate/v4。

Summary

Functions

create(Dir, Title)
down(Config)
down(Config, Steps)
drop(Config)
force(Config, Version)
goto(Config, Version)
up(Config)
up(Config, Steps)
version(Config)

Functions

create(Dir, Title)

-spec create(Dir :: file:filename(), Title :: unicode:chardata()) ->
                {ok, file:filename(), file:filename()} | {error, term()}.

down(Config)

-spec down(Config :: map()) -> ok | {error, term()}.

down(Config, Steps)

-spec down(Config :: map(), Steps :: pos_integer() | all) -> ok | {error, term()}.

drop(Config)

-spec drop(Config :: map()) -> ok | {error, term()}.

force(Config, Version)

-spec force(Config :: map(), Version :: integer() | undefined) -> ok | {error, term()}.

goto(Config, Version)

-spec goto(Config :: map(), Version :: integer()) -> ok | {error, term()}.

up(Config)

-spec up(Config :: map()) -> ok | {error, term()}.

up(Config, Steps)

-spec up(Config :: map(), Steps :: pos_integer() | all) -> ok | {error, term()}.

version(Config)

-spec version(Config :: map()) -> {ok, integer() | undefined, boolean()} | {error, term()}.