package irmin

You can search for identifiers within the package.

in-package search v0.2.0

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

Install

Dune Dependency

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

Authors

Maintainers

T

thomas@gazagnaire.org

Sources

irmin-2.6.0.tbz

sha256=1db134221e82c424260a0e206b640fcb82902be35eea4137af2bcd9c98d3ac0f

sha512=b334e5b909563787e58790e4665f78a9f21e0f9f976eb7344cb76cbe7db870506bab193cec206e338ba74457896b2176000c936397cf3d44326507300a8193d6

doc/irmin.mem/Irmin_mem/KV/Private/Commit/index.html

Module `Private.Commit`Source

Private commit store.

Commit Store

Content-addressable stores

Content-addressable stores are store where it is possible to read and add new values. Keys are derived from the values raw contents and hence are deterministic.

Sourcetype -'a t

The type for content-addressable backend stores. The 'a phantom type carries information about the store mutability.

Sourcetype key = Hash.t

The type for keys.

Sourcetype value

The type for raw values.

Sourceval mem : [> Irmin.Perms.read ] t -> key -> bool Lwt.t

mem t k is true iff k is present in t.

Sourceval find : [> Irmin.Perms.read ] t -> key -> value option Lwt.t

find t k is Some v if k is associated to v in t and None is k is not present in t.

Sourceval add : [> Irmin.Perms.write ] t -> value -> key Lwt.t

Write the contents of a value to the store. It's the responsibility of the content-addressable store to generate a consistent key.

Sourceval unsafe_add : [> Irmin.Perms.write ] t -> key -> value -> unit Lwt.t

Same as add but allows to specify the key directly. The backend might choose to discared that key and/or can be corrupt if the key scheme is not consistent.

Sourceval clear : 'a t -> unit Lwt.t

Clear the store. This operation is expected to be slow.

Source

val merge : 
  [> Irmin.Perms.read_write ] t ->
  info:Irmin.Info.f ->
  key option Irmin.Merge.t

merge is the 3-way merge function for commit keys.

Sourcemodule Key : Irmin.Hash.TYPED with type t = key and type value = value

Key provides base functions for commit keys.

Sourcemodule Val : sig ... end

Val provides functions for commit values.

Sourcemodule Node : sig ... end

Node is the underlying node store.

On This Page

Commit Store
1. Content-addressable stores