package migra

  1. Overview
  2. Docs
A database migration tool for OCaml supporting PostgreSQL, MariaDB, and SQLite

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (6)

Authors

  1. D
    David Sinclair

Maintainers

  1. D
    David Sinclair <dsincl12@gmail.com>

Sources

migra-1.0.0.tbz
sha256=08ceb8f21f00227f21209484ef1eb8cc326ed26a280747798ec5b0b7c5fdd678
sha512=70050833623ba7801a0a31b1700f5473903335c8db2cdf4de5bbd1876180ec0a93907444b42f7a39b6af454303e0ee5f4c3543ca51378d6324583a26b93f535c

doc/migra.engine/Migra_engine/Migration/index.html

Module Migra_engine.MigrationSource

Sourcetype t = {
  1. version : int64;
  2. description : string;
  3. file_path : string;
}
Sourceval generate_version : unit -> int64
Sourceval parse_version : string -> (int64, Types.error) result
Sourceval parse_description : string -> (string, Types.error) result
Sourceval from_file : string -> (t, Types.error) result

Create a migration record from a file path. Returns Error if the filename doesn't match the expected format.

Sourceval parse_section : string -> string -> string option

Parse a section from migration file content. Extracts content between a section marker (e.g., "-- +migrate up") and the next section. Section matching is case-insensitive.

Sourceval read_up_sql : t -> (string, Types.error) result

Read the up migration SQL from a migration file. Parses the content between -- +migrate up and the next section marker.

Sourceval read_down_sql : t -> (string, Types.error) result

Read the down migration SQL from a migration file. Parses the content between -- +migrate down and the next section marker.

Sourceval checksum : t -> (string, Types.error) result

MD5 checksum (hex) of the migration file's full contents, for detecting whether a migration was modified after being applied.

Sourceval make_filename : int64 -> string -> string

Generate migration filename from version and description. Format: YYYYMMDDHHMMSS_description.sql

Sourceval compare : t -> t -> int
Sourceval to_string : t -> string