package irmin

Overview
No Docs

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Remote synchronization

Irmin, a distributed database that follows the same design principles as Git

Install

dune-project

Dependency

github.com Edit opam file Versions (10)

Authors

Maintainers

T

thomas@gazagnaire.org

Sources

irmin-3.6.1.tbz

sha256=11fc2570bdbfd48478c89113fc801084a84a9a2c12d9bf8c64e05ce64ae19bd7

sha512=2171699ca24dec5c9c908a2676b272e034c14eb17f7052a794535e52af0be40be68a689e59c0a640ee244b11703320483f4d0c261542e6242ba23a8f1272b9b0

doc/irmin.mem/Irmin_mem/KV/Make/Backend/Remote/index.html

Module `Backend.Remote`Source

URI-based low-level remote synchronisation.

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 = endpoint

The type for sync endpoints.

Source

val 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.

Source

val 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