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.10.2.tbz
sha256=088741b619471c8198e74aaf9f4aeb4a9997abec8b9abcbfb3443fd27bfb433f
sha512=bbc03417d6eb87d99bee391c489d23a586b0a260e4c797f5e2465c3ab67cb627a9efa526097c1b89dd3339eafb8bad738c1cf0502e5c70355871ff7dbba324b9

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

Module Private.NodeSource

Private node 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.

module Path = Key

Path provides base functions on node paths.

Sourceval merge : [> Irmin.Perms.read_write ] t -> key option Irmin.Merge.t

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

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

Key provides base functions for node keys.

module Metadata : sig ... end

Metadata provides base functions for node metadata.

Sourcemodule Val : sig ... end

Val provides base functions for node values.

Contents is the underlying contents store.