erlang_migrate_source (erlang_migrate v0.2.1)

View Source

Migration file source — scans directory for *.up.sql / *.down.sql pairs. File naming convention: {version}_{title}.up.sql version must be a positive integer (e.g. 1, 2, 100, 20240101120000)

Summary

Types

migration/0

Functions

read_sql(File, Direction)
scan(Dir)

Types

migration/0

-type migration() ::
          #{version := integer(),
            title := binary(),
            up_file := file:filename(),
            down_file := file:filename() | undefined}.

Functions

read_sql(File, Direction)

-spec read_sql(File :: file:filename(), Direction :: up | down) -> {ok, binary()} | {error, term()}.

scan(Dir)

-spec scan(Dir :: file:filename()) -> {ok, [migration()]} | {error, term()}.