package irmin

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

Install 

dune-project
 Dependency

github.com Edit opam file Versions (10)

Authors

  1. T
    Thomas Gazagnaire
  2. T
    Thomas Leonard

Maintainers

  1. T
    thomas@gazagnaire.org

Sources

irmin-2.9.0.tbz
sha256=7af11e14d312b9ae340997f8c27907b9fc9a0d19539fb643e1820d5183a76750
sha512=d7b61c6fddab0a8b61efe867b9a0fdc14c01eb1adeda2f5018b8dfee306c8324c77dd648c7cb9860e62a26e224955f9331b49d19cb693ad5d773efc53263d9fd

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

Module Private.CommitSource

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.

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