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 (10)

Authors

Maintainers

T

thomas@gazagnaire.org

Sources

irmin-2.7.2.tbz

sha256=29c68c5001a727aaa7a6842d6204ffa3e24b3544fa4f6af2234cdbfa032f7fdf

sha512=87254dfe640619b678a95c211435c0deaaaac8bec50bba711757dd610c9fe6d9a80938399b7e2bb7bc813116eebc82bf3474b281d1afcd1031586f3d51579925

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

Module `Irmin_mem.Atomic_write`

An in-memory store with atomic-write guarantees.

Parameters

module K : Irmin.Type.S

module V : Irmin.Type.S

Signature

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

Atomic write stores

Atomic-write stores are stores where it is possible to read, update and remove elements, with atomically guarantees.

type t

The type for atomic-write backend stores.

type key = K.t

The type for keys.

type value = V.t

The type for raw values.

val mem : t -> key -> bool Lwt.t

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

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

val set : t -> key -> value -> unit Lwt.t

set t k v replaces the contents of k by v in t. If k is not already defined in t, create a fresh binding. Raise Invalid_argument if k is the empty path.

val test_and_set : 
  t ->
  key ->
  test:value option ->
  set:value option ->
  bool Lwt.t

test_and_set t key ~test ~set sets key to set only if the current value of key is test and in that case returns true. If the current value of key is different, it returns false. None means that the value does not have to exist or is removed.

Note: The operation is guaranteed to be atomic.

val remove : t -> key -> unit Lwt.t

remove t k remove the key k in t.

val list : t -> key list Lwt.t

list t it the list of keys in t.

type watch

The type of watch handlers.

val watch : 
  t ->
  ?init:(key * value) list ->
  (key -> value Irmin.Diff.t -> unit Lwt.t) ->
  watch Lwt.t

watch t ?init f adds f to the list of t's watch handlers and returns the watch handler to be used with unwatch. init is the optional initial values. It is more efficient to use watch_key to watch only a single given key.

val watch_key : 
  t ->
  key ->
  ?init:value ->
  (value Irmin.Diff.t -> unit Lwt.t) ->
  watch Lwt.t

watch_key t k ?init f adds f to the list of t's watch handlers for the key k and returns the watch handler to be used with unwatch. init is the optional initial value of the key.

val unwatch : t -> watch -> unit Lwt.t

unwatch t w removes w from t's watch handlers.

val close : t -> unit Lwt.t

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

val clear : t -> unit Lwt.t

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

val v : Irmin__.Conf.t -> t Lwt.t

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

On This Page

Parameters
Signature