tezos-lmdb 7.4 (latest) · OCaml Package

type error =

| NoSuchFileOrDir
| IOError
| EnvironmentLocked
| OutOfMemory
| PermissionDenied
| InvalidArgument
| NoSpaceLeftOnDevice
| KeyExist
| KeyNotFound
| PageNotFound
| Corrupted
| Panic
| VersionMismatch
| InvalidFile
| MapFull
| DbsFull
| ReadersFull
| TLSFull
| TxnFull
| CursorFull
| PageFull
| MapResized
| Incompatible
| BadRslot
| BadTxn
| BadValSize
| BadDbi
| TxnProblem

val string_of_error : error -> string

val pp_error : Stdlib.Format.formatter -> error -> unit

val to_msg : 
  ('a, error) Rresult.result ->
  ('a, [> Rresult.R.msg ]) Rresult.result

type version = {

major : int;
minor : int;
patch : int;

}

val version : unit -> version

type ro

type rw

type t

type flag_env =

| FixedMap
| NoSubdir
| NoSync
| RdOnly
| NoMetaSync
| WriteMap
| MapAsync
| NoTLS
| NoLock
| NoRdAhead
| NoMemInit
| PrevMeta

val opendir : 
  ?maxreaders:int ->
  ?maxdbs:int ->
  ?mapsize:int64 ->
  ?flags:flag_env list ->
  string ->
  Unix.file_perm ->
  (t, error) Rresult.result

val closedir : t -> unit

val copy : ?compact:bool -> t -> string -> (unit, error) Rresult.result

val copyfd : 
  ?compact:bool ->
  t ->
  Unix.file_descr ->
  (unit, error) Rresult.result

type stat = {

psize : int;
depth : int;
branch_pages : int;
leaf_pages : int;
overflow_pages : int;
entries : int;

}

val stat : t -> stat

type envinfo = {

mapsize : int;
last_pgno : int;
last_txnid : int;
maxreaders : int;
numreaders : int;

}

val envinfo : t -> envinfo

val sync : ?force:bool -> t -> (unit, error) Rresult.result

val get_flags : t -> flag_env list

val set_flags : t -> flag_env list -> (unit, error) Rresult.result

val clear_flags : t -> flag_env list -> (unit, error) Rresult.result

val get_path : t -> string

val get_fd : t -> Unix.file_descr

val get_maxreaders : t -> int

val get_maxkeysize : t -> int

val set_mapsize : t -> int64 -> (unit, error) Rresult.result

type _ txn

val create_rw_txn : 
  ?nosync:bool ->
  ?nometasync:bool ->
  ?parent:rw txn ->
  t ->
  (rw txn, error) Rresult.result

val create_ro_txn : 
  ?nosync:bool ->
  ?nometasync:bool ->
  ?parent:_ txn ->
  t ->
  (ro txn, error) Rresult.result

val get_txn_id : _ txn -> int

val get_txn_env : _ txn -> t

val commit_txn : _ txn -> (unit, error) Rresult.result

val abort_txn : _ txn -> unit

val reset_ro_txn : ro txn -> unit

val renew_ro_txn : ro txn -> (unit, error) Rresult.result

type flag_open =

| ReverseKey
| DupSort
| IntegerKey
| DupFixed
| IntegerDup
| ReverseDup
| Create

type db

val opendb : 
  ?flags:flag_open list ->
  ?name:string ->
  _ txn ->
  (db, error) Rresult.result

val db_stat : _ txn -> db -> (stat, error) Rresult.result

val db_flags : _ txn -> db -> (flag_open list, error) Rresult.result

val db_drop : _ txn -> db -> (unit, error) Rresult.result

val with_ro_db : 
  ?nosync:bool ->
  ?nometasync:bool ->
  ?parent:_ txn ->
  ?flags:flag_open list ->
  ?name:string ->
  t ->
  f:(ro txn -> db -> ('a, error) Rresult.result) ->
  ('a, error) Rresult.result

val with_rw_db : 
  ?nosync:bool ->
  ?nometasync:bool ->
  ?parent:rw txn ->
  ?flags:flag_open list ->
  ?name:string ->
  t ->
  f:(rw txn -> db -> ('a, error) Rresult.result) ->
  ('a, error) Rresult.result

type buffer =
  (char, Stdlib.Bigarray.int8_unsigned_elt, Stdlib.Bigarray.c_layout)
    Stdlib.Bigarray.Array1.t

val get : _ txn -> db -> string -> (buffer, error) Rresult.result

val mem : _ txn -> db -> string -> (bool, error) Rresult.result

type flag_put =

| NoOverwrite
| NoDupData
| Current
| Reserve
| Append
| AppendDup
| Multiple

val put : 
  ?flags:flag_put list ->
  rw txn ->
  db ->
  string ->
  buffer ->
  (unit, error) Rresult.result

val put_string : 
  ?flags:flag_put list ->
  rw txn ->
  db ->
  string ->
  string ->
  (unit, error) Rresult.result

val del : 
  ?data:buffer ->
  rw txn ->
  db ->
  string ->
  (unit, error) Rresult.result

val del_string : 
  ?data:string ->
  rw txn ->
  db ->
  string ->
  (unit, error) Rresult.result

type _ cursor

val opencursor : 'a txn -> db -> ('a cursor, error) Rresult.result

val cursor_close : _ cursor -> unit

val cursor_renew : ro txn -> ro cursor -> (unit, error) Rresult.result

val cursor_txn : 'a cursor -> 'a txn

val cursor_db : _ cursor -> db

val cursor_first : _ cursor -> (unit, error) Rresult.result

val cursor_last : _ cursor -> (unit, error) Rresult.result

val cursor_prev : _ cursor -> (unit, error) Rresult.result

val cursor_next : _ cursor -> (unit, error) Rresult.result

val cursor_at : _ cursor -> string -> (unit, error) Rresult.result

val cursor_get : _ cursor -> (buffer * buffer, error) Rresult.result

val cursor_fold_left : 
  f:('a -> (buffer * buffer) -> ('a, error) Rresult.result) ->
  init:'a ->
  _ cursor ->
  ('a, error) Rresult.result

val cursor_iter : 
  f:((buffer * buffer) -> (unit, error) Rresult.result) ->
  _ cursor ->
  (unit, error) Rresult.result

val with_cursor : 
  'a txn ->
  db ->
  f:('a cursor -> ('b, error) Rresult.result) ->
  ('b, error) Rresult.result

type cursor_op =

| First
| First_dup
| Get_both
| Get_both_range
| Get_current
| Get_multiple
| Last
| Last_dup
| Next
| Next_dup
| Next_multiple
| Next_nodup
| Prev
| Prev_dup
| Prev_nodup
| Set
| Set_key
| Set_range
| Prev_multiple

val cursor_put : 
  ?flags:flag_put list ->
  rw cursor ->
  string ->
  buffer ->
  (unit, error) Rresult.result

val cursor_put_string : 
  ?flags:flag_put list ->
  rw cursor ->
  string ->
  string ->
  (unit, error) Rresult.result

val cursor_del : 
  ?flags:flag_put list ->
  rw cursor ->
  (unit, error) Rresult.result

val cursor_count : _ cursor -> (int, error) Rresult.result

package tezos-lmdb