package irmin

  1. Overview
  2. Docs
Irmin, a distributed database that follows the same design principles as Git

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (10)

Authors

  1. T
    Thomas Gazagnaire
  2. T
    Thomas Leonard

Maintainers

  1. T
    thomas@gazagnaire.org

Sources

irmin-2.7.2.tbz
sha256=29c68c5001a727aaa7a6842d6204ffa3e24b3544fa4f6af2234cdbfa032f7fdf
sha512=87254dfe640619b678a95c211435c0deaaaac8bec50bba711757dd610c9fe6d9a80938399b7e2bb7bc813116eebc82bf3474b281d1afcd1031586f3d51579925

doc/irmin.mem/Irmin_mem/Make/Private/Sync/index.html

Module Private.SyncSource

URI-based low-level sync.

include Irmin.Sync.S with type commit = Commit.key and type branch = Branch.key with type endpoint = unit

Remote synchronization

Sourcetype t

The type for store handles.

Sourcetype commit = Commit.key

The type for store heads.

Sourcetype branch = Branch.key

The type for branch IDs.

Sourcetype endpoint = unit

The type for sync endpoints.

Sourceval fetch : t -> ?depth:int -> endpoint -> branch -> (commit option, [ `Msg of string ]) result Lwt.t

fetch t uri fetches the contents of the remote store located at uri into the local store t. Return the head of the remote branch with the same name, which is now in the local store. No_head means no such branch exists.

Sourceval push : t -> ?depth:int -> endpoint -> branch -> (unit, [ `Msg of string | `Detached_head ]) result Lwt.t

push t uri pushes the contents of the local store t into the remote store located at uri.

Sourceval v : Repo.t -> t Lwt.t