package sihl

  1. Overview
  2. Docs

Parameters

module Repo : sig ... end

Signature

val register_migration : (string * Sihl__.Contract_migration.step list) -> unit

register_migration migration registers a migration migration with the migration service so it can be executed with `run_all`.

val register_migrations : (string * Sihl__.Contract_migration.step list) list -> unit

register_migrations migrations registers migrations migrations with the migration service so it can be executed with `run_all`.

val execute : (string * Sihl__.Contract_migration.step list) list -> unit Lwt.t

execute migrations runs all migrations migrations.

val run_all : unit -> unit Lwt.t

run_all () runs all migrations that have been registered.

val pending_migrations : unit -> (string * int) list Lwt.t

pending_migrations () returns a list of migrations that need to be executed in order to have all migrations applied. The returned migration is a tuple (namespace, number) where namespace is the namespace of the migration and number is the number of pending migrations that need to be applied in order to achieve the desired schema version.

An empty list means that there are no pending migrations and that the database schema is up-to-date.

val register : ?migrations:(string * Sihl__.Contract_migration.step list) list -> unit -> Sihl__.Core_container.Service.t
val lifecycle : Sihl__.Core_container.lifecycle