Column.FloatMarshal.1-CColumn.MarshalColumn.String1-Functorial.ColumnTable.VariableTable.1-TTable.2-KeyTable.3-Value1-Functorial.Tablemodule T : sig ... endtype key = Key.ttype value = Value.tval remove : key -> unit Lwt.tmodule Variable : sig ... endPolymorphic.1-Functorial1-Functorial.COLUMNOcsipersist_lib.Polymorphicderiving polymorphic interface from the functorial one
module Functorial : Sigs.FUNCTORIALval table_name : 'value table -> string Lwt.treturns the name of the table
val open_table : string -> 'value table Lwt.tOpen a table (and create it if it does not exist)
val find : 'value table -> string -> 'value Lwt.tfind table key gives the value associated to key. Fails with Not_found if not found.
val add : 'value table -> string -> 'value -> unit Lwt.tadd 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.
val replace_if_exists : 'value table -> string -> 'value -> unit Lwt.treplace_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.
val remove : 'value table -> string -> unit Lwt.tremove table key removes the entry in the table if it exists
val length : 'value table -> int Lwt.tSize of a table.
val iter_step : (string -> 'a -> unit Lwt.t) -> 'a table -> unit Lwt.tImportant 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).
val fold_step : (string -> 'a -> 'b -> 'b Lwt.t) -> 'a table -> 'b -> 'b Lwt.tImportant 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).
val iter_block : (string -> 'a -> unit) -> 'a table -> unit Lwt.tMAJOR 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.
Ocsipersist_lib.Sigsmodule type TABLE = sig ... endmodule type FUNCTORIAL = sig ... endmodule type POLYMORPHIC = sig ... endmodule type STORE = sig ... endColumn.FloatMarshal.1-CColumn.MarshalColumn.StringFUNCTORIAL.ColumnTable.VariableTable.1-TTable.2-KeyTable.3-ValueFUNCTORIAL.Tablemodule T : sig ... endtype key = Key.ttype value = Value.tval remove : key -> unit Lwt.tmodule Variable : sig ... endSigs.FUNCTORIALFUNCTORIAL.COLUMNSigs.POLYMORPHICval table_name : 'value table -> string Lwt.treturns the name of the table
val open_table : string -> 'value table Lwt.tOpen a table (and create it if it does not exist)
val find : 'value table -> string -> 'value Lwt.tfind table key gives the value associated to key. Fails with Not_found if not found.
val add : 'value table -> string -> 'value -> unit Lwt.tadd 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.
val replace_if_exists : 'value table -> string -> 'value -> unit Lwt.treplace_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.
val remove : 'value table -> string -> unit Lwt.tremove table key removes the entry in the table if it exists
val length : 'value table -> int Lwt.tSize of a table.
val iter_step : (string -> 'a -> unit Lwt.t) -> 'a table -> unit Lwt.tImportant 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).
val fold_step : (string -> 'a -> 'b -> 'b Lwt.t) -> 'a table -> 'b -> 'b Lwt.tImportant 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).
val iter_block : (string -> 'a -> unit) -> 'a table -> unit Lwt.tMAJOR 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.
Sigs.STOREData are divided into stores. Create one store for your project, where you will save all your data.
val open_store : string -> store Lwt.tOpen a store (and create it if it does not exist)
make_persistent store name default find a persistent value named name in store store from database, or create it with the default value default if it does not exist.
Same as make_persistent but the default value is evaluated only if needed
val make_persistent_lazy_lwt : store:store -> name:string -> default:(unit -> 'a Lwt.t) ->
+'a t Lwt.tLwt version of make_persistent_lazy.
val get : 'a t -> 'a Lwt.tget pv gives the value of pv
val set : 'a t -> 'a -> unit Lwt.tset pv value sets a persistent value pv to value
TABLE.VariableSigs.TABLEVariable.1-TOcsipersist_lib.VariableColumn.FloatMarshal.1-CColumn.MarshalColumn.StringFunctorial.ColumnTable.VariableTable.1-TTable.2-KeyTable.3-ValueFunctorial.Tablemodule T : sig ... endtype key = Key.ttype value = Value.tval remove : key -> unit Lwt.tmodule Variable : sig ... endOcsipersist.FunctorialFunctorial frontent. Allows for custom (de)serialisation functions, which keeps data human-readable in the backend.
Functorial.COLUMNOcsipersist.PolymorphicPolymorphic frontent. Relies on Marshal for (de)serialisation, which means that data will be stored in the backend in a fashion that is not necessarily easily readable by non-OCaml-based life forms. If this is an issue for you, you can rely on the functorial frontend instead.
val table_name : 'value table -> string Lwt.treturns the name of the table
val open_table : string -> 'value table Lwt.tOpen a table (and create it if it does not exist)
val find : 'value table -> string -> 'value Lwt.tfind table key gives the value associated to key. Fails with Not_found if not found.
val add : 'value table -> string -> 'value -> unit Lwt.tadd 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.
val replace_if_exists : 'value table -> string -> 'value -> unit Lwt.treplace_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.
val remove : 'value table -> string -> unit Lwt.tremove table key removes the entry in the table if it exists
val length : 'value table -> int Lwt.tSize of a table.
val iter_step : (string -> 'a -> unit Lwt.t) -> 'a table -> unit Lwt.tImportant 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).
val fold_step : (string -> 'a -> 'b -> 'b Lwt.t) -> 'a table -> 'b -> 'b Lwt.tImportant 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).
val iter_block : (string -> 'a -> unit) -> 'a table -> unit Lwt.tMAJOR 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.
Ocsipersist.StoreThe variable store allows for the persistent storage of individual variables. Relies on Stdlib.Marshal for (de)serialisation, which entails the same limitations as for the Polymorphic frontend. If this is an issue you can rely on Functorial frontend instead (see TABLE.Variable).
Data are divided into stores. Create one store for your project, where you will save all your data.
val open_store : string -> store Lwt.tOpen a store (and create it if it does not exist)
make_persistent store name default find a persistent value named name in store store from database, or create it with the default value default if it does not exist.
Same as make_persistent but the default value is evaluated only if needed
val make_persistent_lazy_lwt : store:store -> name:string -> default:(unit -> 'a Lwt.t) ->
+'a t Lwt.tLwt version of make_persistent_lazy.
val get : 'a t -> 'a Lwt.tget pv gives the value of pv
val set : 'a t -> 'a -> unit Lwt.tset pv value sets a persistent value pv to value