package ocsipersist-lib

  1. Overview
  2. Docs

Module Ocsipersist_lib.PolymorphicSource

deriving polymorphic interface from the functorial one

Parameters

Signature

Sourcetype 'value table

Type of persistent table

Sourceval table_name : 'value table -> string Lwt.t

returns the name of the table

Sourceval open_table : string -> 'value table Lwt.t

Open a table (and create it if it does not exist)

Sourceval find : 'value table -> string -> 'value Lwt.t

find table key gives the value associated to key. Fails with Not_found if not found.

Sourceval add : 'value table -> string -> 'value -> unit Lwt.t

add table key value associates value to key. If the database already contains data associated with key, that data is discarded and silently replaced by the new data.

Sourceval replace_if_exists : 'value table -> string -> 'value -> unit Lwt.t

replace_if_exists table key value associates value to key only if key is already bound. If the database does not contain any data associated with key, fails with Not_found.

Sourceval remove : 'value table -> string -> unit Lwt.t

remove table key removes the entry in the table if it exists

Sourceval length : 'value table -> int Lwt.t

Size of a table.

Sourceval iter_step : (string -> 'a -> unit Lwt.t) -> 'a table -> unit Lwt.t

Important warning: this iterator may not iter on all data of the table if another thread is modifying it in the same time. Nonetheless, it should not miss more than a very few data from time to time, except if the table is very old (at least 9 223 372 036 854 775 807 insertions).

Sourceval fold_step : (string -> 'a -> 'b -> 'b Lwt.t) -> 'a table -> 'b -> 'b Lwt.t

Important warning: this iterator may not iter on all data of the table if another thread is modifying it in the same time. Nonetheless, it should not miss more than a very few data from time to time, except if the table is very old (at least 9 223 372 036 854 775 807 insertions).

Sourceval iter_block : (string -> 'a -> unit) -> 'a table -> unit Lwt.t

MAJOR WARNING: Unlike iter_step, this iterator won't miss any entry and will run in one shot. It is therefore more efficient, BUT: it will lock the WHOLE database during its execution, thus preventing ANYBODY from accessing it (including the function f which is iterated). As a consequence: you MUST NOT use any function from ocsipersist in f, otherwise you would lock yourself and everybody else! Be VERY cautious.