package lmdb

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Legend:
Library
Module
Module type
Parameter
Class
Class type

Main signature for a database module.

type t

A handle for an individual database.

type key

The key of the database.

type elt

The values of the database.

val create : ?create:bool -> Env.t -> string -> t

create env "foo" open the database "foo" in the environment env.

If create is set to true, the database will be created if it doesn't exists. Invalid if env is read only.

val get : t -> key -> elt

get db k returns the value associated to k.

val put : ?flags:PutFlags.t -> t -> key -> elt -> unit

put db k v associates the key k to the value v in the database db.

val append : t -> key -> elt -> unit

append db k v append k, v at the end of the database db without performing comparisons.

Should only be used to quickly add already-sorted data to the database.

val remove : ?elt:elt -> t -> key -> unit

remove db k removes k from db.

If the database accepts duplicates:

module Txn : sig ... end

A series of operation performed atomically.

module Cursor : sig ... end

Manual iterators.

val stats : t -> Env.stats

val drop : ?delete:bool -> t -> unit

val compare : t -> key -> key -> int

The comparison function used by the database.