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.10.2.tbz

sha256=088741b619471c8198e74aaf9f4aeb4a9997abec8b9abcbfb3443fd27bfb433f

sha512=bbc03417d6eb87d99bee391c489d23a586b0a260e4c797f5e2465c3ab67cb627a9efa526097c1b89dd3339eafb8bad738c1cf0502e5c70355871ff7dbba324b9

doc/irmin.mem/Irmin_mem/Append_only/index.html

Module `Irmin_mem.Append_only`Source

An in-memory store for append-only values.

Parameters

module K : Irmin.Type.S

module V : Irmin.Type.S

Signature

include Irmin.APPEND_ONLY_STORE with type key = K.t and type value = V.t

Append-only stores

Append-onlye stores are store where it is possible to read and add new values.

Sourcetype -'a t

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

Sourcetype key = K.t

The type for keys.

Sourcetype value = V.t

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 -> key -> value -> unit Lwt.t

Write the contents of a value to the store.

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

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

Source

val batch : 
  Irmin.Perms.read t ->
  ([ Irmin.Perms.read | Irmin.Perms.write ] t -> 'a Lwt.t) ->
  'a Lwt.t

batch t f applies the writes in f in a separate batch. The exact guarantees depend on the implementation.

Sourceval v : Irmin__.Conf.t -> Irmin.Perms.read t Lwt.t

v config is a function returning fresh store handles, with the configuration config, which is provided by the backend.

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

close t frees up all the resources associated with t. Any operations run on a closed handle will raise Closed.

On This Page

Parameters
Signature