Mdbx.FFI

Low level bindings to libmdbx functions.

Environment

data MdbxEnvFlags

Flags for opening an environment.

Constructors

MdbxEnvDefaults

MdbxSyncDurable

MdbxNosubdir

MdbxSafeNosync

MdbxMapasync

MdbxRdonly

MdbxNometasync

MdbxWritemap

MdbxUtterlyNosync

MdbxNotls

MdbxExclusive

MdbxNordahead

MdbxNomeminit

MdbxCoalesce

MdbxLiforeclaim

MdbxPageperturb

MdbxAccede

Instances

Enum MdbxEnvFlags

Defined in Mdbx.FFI

Methods

succ :: MdbxEnvFlags -> MdbxEnvFlags

pred :: MdbxEnvFlags -> MdbxEnvFlags

toEnum :: Int -> MdbxEnvFlags

fromEnum :: MdbxEnvFlags -> Int

enumFrom :: MdbxEnvFlags -> [MdbxEnvFlags]

enumFromThen :: MdbxEnvFlags -> MdbxEnvFlags -> [MdbxEnvFlags]

enumFromTo :: MdbxEnvFlags -> MdbxEnvFlags -> [MdbxEnvFlags]

enumFromThenTo :: MdbxEnvFlags -> MdbxEnvFlags -> MdbxEnvFlags -> [MdbxEnvFlags]

Eq MdbxEnvFlags

Defined in Mdbx.FFI

Methods

(==) :: MdbxEnvFlags -> MdbxEnvFlags -> Bool

(/=) :: MdbxEnvFlags -> MdbxEnvFlags -> Bool

Ord MdbxEnvFlags

Defined in Mdbx.FFI

Methods

compare :: MdbxEnvFlags -> MdbxEnvFlags -> Ordering

(<) :: MdbxEnvFlags -> MdbxEnvFlags -> Bool

(<=) :: MdbxEnvFlags -> MdbxEnvFlags -> Bool

(>) :: MdbxEnvFlags -> MdbxEnvFlags -> Bool

(>=) :: MdbxEnvFlags -> MdbxEnvFlags -> Bool

max :: MdbxEnvFlags -> MdbxEnvFlags -> MdbxEnvFlags

min :: MdbxEnvFlags -> MdbxEnvFlags -> MdbxEnvFlags

Show MdbxEnvFlags

Defined in Mdbx.FFI

Methods

showsPrec :: Int -> MdbxEnvFlags -> ShowS

show :: MdbxEnvFlags -> String

showList :: [MdbxEnvFlags] -> ShowS

newtype MdbxEnv

Environment object, needed for all the operations.

Constructors

MdbxEnv (Ptr MdbxEnv)

Instances

Storable MdbxEnv

Defined in Mdbx.FFI

Methods

sizeOf :: MdbxEnv -> Int

alignment :: MdbxEnv -> Int

peekElemOff :: Ptr MdbxEnv -> Int -> IO MdbxEnv

pokeElemOff :: Ptr MdbxEnv -> Int -> MdbxEnv -> IO ()

peekByteOff :: Ptr b -> Int -> IO MdbxEnv

pokeByteOff :: Ptr b -> Int -> MdbxEnv -> IO ()

peek :: Ptr MdbxEnv -> IO MdbxEnv

poke :: Ptr MdbxEnv -> MdbxEnv -> IO ()

type MdbxEnvMode = CUInt

UNIX permissions to set on created files. Zero value means to open existing, but do not create.

mdbx_env_create :: IO (Int, MdbxEnv)

Creates an environment. Represents a database in the file system.

mdbx_env_set_geometry :: MdbxEnv -> Int -> Int -> Int -> Int -> Int -> Int -> IO Int

Sets geometry of an environment. All the parameters can receive -1 to keep the current value. Receives (expressed in bytes): size_lower, size_now, size_upper, growth_step, shrink_threshold, pagesize.

mdbx_env_open :: MdbxEnv -> String -> [MdbxEnvFlags] -> MdbxEnvMode -> IO Int

Opens an environment. Receives name, flags and mode.

mdbx_env_close :: MdbxEnv -> IO Int

Closes an environment.

Transaction

data MdbxTxnFlags

Flags for a transaction.

Constructors

MdbxTxnReadwrite

MdbxTxnNosync

MdbxTxnRdonly

MdbxTxnNometasync

MdbxTxnRdonlyPrepare

MdbxTxnTry

Instances

Enum MdbxTxnFlags

Defined in Mdbx.FFI

Methods

succ :: MdbxTxnFlags -> MdbxTxnFlags

pred :: MdbxTxnFlags -> MdbxTxnFlags

toEnum :: Int -> MdbxTxnFlags

fromEnum :: MdbxTxnFlags -> Int

enumFrom :: MdbxTxnFlags -> [MdbxTxnFlags]

enumFromThen :: MdbxTxnFlags -> MdbxTxnFlags -> [MdbxTxnFlags]

enumFromTo :: MdbxTxnFlags -> MdbxTxnFlags -> [MdbxTxnFlags]

enumFromThenTo :: MdbxTxnFlags -> MdbxTxnFlags -> MdbxTxnFlags -> [MdbxTxnFlags]

Eq MdbxTxnFlags

Defined in Mdbx.FFI

Methods

(==) :: MdbxTxnFlags -> MdbxTxnFlags -> Bool

(/=) :: MdbxTxnFlags -> MdbxTxnFlags -> Bool

Ord MdbxTxnFlags

Defined in Mdbx.FFI

Methods

compare :: MdbxTxnFlags -> MdbxTxnFlags -> Ordering

(<) :: MdbxTxnFlags -> MdbxTxnFlags -> Bool

(<=) :: MdbxTxnFlags -> MdbxTxnFlags -> Bool

(>) :: MdbxTxnFlags -> MdbxTxnFlags -> Bool

(>=) :: MdbxTxnFlags -> MdbxTxnFlags -> Bool

max :: MdbxTxnFlags -> MdbxTxnFlags -> MdbxTxnFlags

min :: MdbxTxnFlags -> MdbxTxnFlags -> MdbxTxnFlags

Show MdbxTxnFlags

Defined in Mdbx.FFI

Methods

showsPrec :: Int -> MdbxTxnFlags -> ShowS

show :: MdbxTxnFlags -> String

showList :: [MdbxTxnFlags] -> ShowS

newtype MdbxTxn

Transaction instance. Needed for all operations with data, even reading.

Constructors

MdbxTxn (Ptr MdbxTxn)

Instances

Storable MdbxTxn

Defined in Mdbx.FFI

Methods

sizeOf :: MdbxTxn -> Int

alignment :: MdbxTxn -> Int

peekElemOff :: Ptr MdbxTxn -> Int -> IO MdbxTxn

pokeElemOff :: Ptr MdbxTxn -> Int -> MdbxTxn -> IO ()

peekByteOff :: Ptr b -> Int -> IO MdbxTxn

pokeByteOff :: Ptr b -> Int -> MdbxTxn -> IO ()

peek :: Ptr MdbxTxn -> IO MdbxTxn

poke :: Ptr MdbxTxn -> MdbxTxn -> IO ()

mdbx_txn_begin :: MdbxEnv -> Maybe MdbxTxn -> [MdbxTxnFlags] -> IO (Int, MdbxTxn)

Begins a new transaction.

Arguments:

• Environment.
• Parent transaction, or Nothing.
• Flags.

mdbx_txn_commit :: MdbxTxn -> IO Int

Commits a transaction.

mdbx_txn_abort :: MdbxTxn -> IO Int

Aborts a transaction.

mdbx_txn_env :: MdbxTxn -> IO MdbxEnv

Gets the environment from a transaction.

Database

data MdbxDbFlags

Flags for a database.

Constructors

MdbxDbDefaults

MdbxReversekey

MdbxDupsort

MdbxIntegerkey

MdbxDupfixed

MdbxIntegerdup

MdbxReversedup

MdbxCreate

MdbxDbAccede

Instances

Enum MdbxDbFlags

Defined in Mdbx.FFI

Methods

succ :: MdbxDbFlags -> MdbxDbFlags

pred :: MdbxDbFlags -> MdbxDbFlags

toEnum :: Int -> MdbxDbFlags

fromEnum :: MdbxDbFlags -> Int

enumFrom :: MdbxDbFlags -> [MdbxDbFlags]

enumFromThen :: MdbxDbFlags -> MdbxDbFlags -> [MdbxDbFlags]

enumFromTo :: MdbxDbFlags -> MdbxDbFlags -> [MdbxDbFlags]

enumFromThenTo :: MdbxDbFlags -> MdbxDbFlags -> MdbxDbFlags -> [MdbxDbFlags]

Eq MdbxDbFlags

Defined in Mdbx.FFI

Methods

(==) :: MdbxDbFlags -> MdbxDbFlags -> Bool

(/=) :: MdbxDbFlags -> MdbxDbFlags -> Bool

Ord MdbxDbFlags

Defined in Mdbx.FFI

Methods

compare :: MdbxDbFlags -> MdbxDbFlags -> Ordering

(<) :: MdbxDbFlags -> MdbxDbFlags -> Bool

(<=) :: MdbxDbFlags -> MdbxDbFlags -> Bool

(>) :: MdbxDbFlags -> MdbxDbFlags -> Bool

(>=) :: MdbxDbFlags -> MdbxDbFlags -> Bool

max :: MdbxDbFlags -> MdbxDbFlags -> MdbxDbFlags

min :: MdbxDbFlags -> MdbxDbFlags -> MdbxDbFlags

Show MdbxDbFlags

Defined in Mdbx.FFI

Methods

showsPrec :: Int -> MdbxDbFlags -> ShowS

show :: MdbxDbFlags -> String

showList :: [MdbxDbFlags] -> ShowS

type MdbxDbi = CUInt

Database instance. Represents a logical table in the database.

mdbx_dbi_open :: MdbxTxn -> Maybe String -> [MdbxDbFlags] -> IO (Int, MdbxDbi)

Opens a database.

Arguments:

• Transaction.
• Name.
• Flags.

mdbx_dbi_close :: MdbxEnv -> MdbxDbi -> IO Int

Closes a database.

Data

data MdbxVal

Binary blob representing a key or value in the database.

Constructors

MdbxVal

Fields

• mvlSize :: !CULong
• mvlData :: !(Ptr ())

Instances

Eq MdbxVal

Defined in Mdbx.FFI

Methods

(==) :: MdbxVal -> MdbxVal -> Bool

(/=) :: MdbxVal -> MdbxVal -> Bool

Show MdbxVal

Defined in Mdbx.FFI

Methods

showsPrec :: Int -> MdbxVal -> ShowS

show :: MdbxVal -> String

showList :: [MdbxVal] -> ShowS

Storable MdbxVal

Defined in Mdbx.FFI

Methods

sizeOf :: MdbxVal -> Int

alignment :: MdbxVal -> Int

peekElemOff :: Ptr MdbxVal -> Int -> IO MdbxVal

pokeElemOff :: Ptr MdbxVal -> Int -> MdbxVal -> IO ()

peekByteOff :: Ptr b -> Int -> IO MdbxVal

pokeByteOff :: Ptr b -> Int -> MdbxVal -> IO ()

peek :: Ptr MdbxVal -> IO MdbxVal

poke :: Ptr MdbxVal -> MdbxVal -> IO ()

emptyMdbxVal :: MdbxVal

Sample empty value

CRUD

data MdbxPutFlags

Flags for all data related operations.

Constructors

MdbxUpsert

MdbxNooverwrite

MdbxNodupdata

MdbxCurrent

MdbxAlldups

MdbxReserve

MdbxAppend

MdbxAppenddup

MdbxMultiple

Instances

Enum MdbxPutFlags

Defined in Mdbx.FFI

Methods

succ :: MdbxPutFlags -> MdbxPutFlags

pred :: MdbxPutFlags -> MdbxPutFlags

toEnum :: Int -> MdbxPutFlags

fromEnum :: MdbxPutFlags -> Int

enumFrom :: MdbxPutFlags -> [MdbxPutFlags]

enumFromThen :: MdbxPutFlags -> MdbxPutFlags -> [MdbxPutFlags]

enumFromTo :: MdbxPutFlags -> MdbxPutFlags -> [MdbxPutFlags]

enumFromThenTo :: MdbxPutFlags -> MdbxPutFlags -> MdbxPutFlags -> [MdbxPutFlags]

Eq MdbxPutFlags

Defined in Mdbx.FFI

Methods

(==) :: MdbxPutFlags -> MdbxPutFlags -> Bool

(/=) :: MdbxPutFlags -> MdbxPutFlags -> Bool

Ord MdbxPutFlags

Defined in Mdbx.FFI

Methods

compare :: MdbxPutFlags -> MdbxPutFlags -> Ordering

(<) :: MdbxPutFlags -> MdbxPutFlags -> Bool

(<=) :: MdbxPutFlags -> MdbxPutFlags -> Bool

(>) :: MdbxPutFlags -> MdbxPutFlags -> Bool

(>=) :: MdbxPutFlags -> MdbxPutFlags -> Bool

max :: MdbxPutFlags -> MdbxPutFlags -> MdbxPutFlags

min :: MdbxPutFlags -> MdbxPutFlags -> MdbxPutFlags

Show MdbxPutFlags

Defined in Mdbx.FFI

Methods

showsPrec :: Int -> MdbxPutFlags -> ShowS

show :: MdbxPutFlags -> String

showList :: [MdbxPutFlags] -> ShowS

mdbx_put :: MdbxTxn -> MdbxDbi -> MdbxVal -> MdbxVal -> [MdbxPutFlags] -> IO Int

Stores a key/value pair.

Arguments:

• Transaction.
• Database.
• Key.
• Value.

mdbx_get :: MdbxTxn -> MdbxDbi -> MdbxVal -> IO (Int, MdbxVal)

Gets a value with the given key.

Arguments:

• Transaction.
• Database.
• Key.

mdbx_del :: MdbxTxn -> MdbxDbi -> MdbxVal -> Maybe MdbxVal -> IO Int

Gets a value with the given key.

Arguments:

• Transaction.
• Database.
• Key.

Cursor

data MdbxCursorOp

Flags for cursor operations.

Constructors

MdbxFirst

MdbxFirstDup

MdbxGetBoth

MdbxGetBothRange

MdbxGetCurrent

MdbxGetMultiple

MdbxLast

MdbxLastDup

MdbxNext

MdbxNextDup

MdbxNextMultiple

MdbxNextNodup

MdbxPrev

MdbxPrevDup

MdbxPrevNodup

MdbxSet

MdbxSetKey

MdbxSetRange

MdbxPrevMultiple

MdbxSetLowerbound

Instances

Enum MdbxCursorOp

Defined in Mdbx.FFI

Methods

succ :: MdbxCursorOp -> MdbxCursorOp

pred :: MdbxCursorOp -> MdbxCursorOp

toEnum :: Int -> MdbxCursorOp

fromEnum :: MdbxCursorOp -> Int

enumFrom :: MdbxCursorOp -> [MdbxCursorOp]

enumFromThen :: MdbxCursorOp -> MdbxCursorOp -> [MdbxCursorOp]

enumFromTo :: MdbxCursorOp -> MdbxCursorOp -> [MdbxCursorOp]

enumFromThenTo :: MdbxCursorOp -> MdbxCursorOp -> MdbxCursorOp -> [MdbxCursorOp]

Eq MdbxCursorOp

Defined in Mdbx.FFI

Methods

(==) :: MdbxCursorOp -> MdbxCursorOp -> Bool

(/=) :: MdbxCursorOp -> MdbxCursorOp -> Bool

Ord MdbxCursorOp

Defined in Mdbx.FFI

Methods

compare :: MdbxCursorOp -> MdbxCursorOp -> Ordering

(<) :: MdbxCursorOp -> MdbxCursorOp -> Bool

(<=) :: MdbxCursorOp -> MdbxCursorOp -> Bool

(>) :: MdbxCursorOp -> MdbxCursorOp -> Bool

(>=) :: MdbxCursorOp -> MdbxCursorOp -> Bool

max :: MdbxCursorOp -> MdbxCursorOp -> MdbxCursorOp

min :: MdbxCursorOp -> MdbxCursorOp -> MdbxCursorOp

Show MdbxCursorOp

Defined in Mdbx.FFI

Methods

showsPrec :: Int -> MdbxCursorOp -> ShowS

show :: MdbxCursorOp -> String

showList :: [MdbxCursorOp] -> ShowS

newtype MdbxCursor

Cursor instance. Used for efficient navigation in a database.

Constructors

MdbxCursor (Ptr MdbxCursor)

Instances

Storable MdbxCursor

Defined in Mdbx.FFI

Methods

sizeOf :: MdbxCursor -> Int

alignment :: MdbxCursor -> Int

peekElemOff :: Ptr MdbxCursor -> Int -> IO MdbxCursor

pokeElemOff :: Ptr MdbxCursor -> Int -> MdbxCursor -> IO ()

peekByteOff :: Ptr b -> Int -> IO MdbxCursor

pokeByteOff :: Ptr b -> Int -> MdbxCursor -> IO ()

peek :: Ptr MdbxCursor -> IO MdbxCursor

poke :: Ptr MdbxCursor -> MdbxCursor -> IO ()

mdbx_cursor_open :: MdbxTxn -> MdbxDbi -> IO (Int, MdbxCursor)

Opens a new cursor.

Arguments:

• Transaction.
• Database.

mdbx_cursor_close :: MdbxCursor -> IO ()

Closes a cursor.

mdbx_cursor_del :: MdbxCursor -> [MdbxPutFlags] -> IO Int

Removes the current key/value pair.

mdbx_cursor_get :: MdbxCursor -> MdbxVal -> MdbxCursorOp -> IO (Int, MdbxVal, MdbxVal)

Returns the current key/value pair.

mdbx_cursor_put :: MdbxCursor -> MdbxVal -> MdbxVal -> [MdbxPutFlags] -> IO Int

Sets the value for the current key.

Arguments:

• Cursor.
• Key.
• Value.
• FLags.

mdbx_cursor_count :: MdbxCursor -> IO (Int, CSize)

Returns the count of duplicates in the current key.

mdbx_strerror :: Int -> IO String

Returns the description of a given error number.

mdbx_cmp :: MdbxTxn -> MdbxDbi -> MdbxVal -> MdbxVal -> IO Int

Compares two values as a binary blob.

Error

data MdbxError

Error codes for the different operations.

Constructors

MdbxKeyexist

MdbxFirstLmdbErrcode

MdbxNotfound

MdbxPageNotfound

MdbxCorrupted

MdbxPanic

MdbxVersionMismatch

MdbxInvalid

MdbxMapFull

MdbxDbsFull

MdbxReadersFull

MdbxTxnFull

MdbxCursorFull

MdbxPageFull

MdbxUnableExtendMapsize

MdbxIncompatible

MdbxBadRslot

MdbxBadTxn

MdbxBadValsize

MdbxBadDbi

MdbxProblem

MdbxLastLmdbErrcode

MdbxBusy

MdbxFirstAddedErrcode

MdbxEmultival

MdbxEbadsign

MdbxWannaRecovery

MdbxEkeymismatch

MdbxTooLarge

MdbxThreadMismatch

MdbxTxnOverlapping

MdbxLastAddedErrcode

MdbxResultTrue

MdbxSuccess

MdbxResultFalse

MdbxEperm

MdbxEnofile

MdbxEintr

MdbxEio

MdbxEnomem

MdbxEaccess

MdbxEremote

MdbxEinval

MdbxErofs

MdbxEnosys

MdbxEnodata

Instances

Enum MdbxError

Defined in Mdbx.FFI

Methods

succ :: MdbxError -> MdbxError

pred :: MdbxError -> MdbxError

toEnum :: Int -> MdbxError

fromEnum :: MdbxError -> Int

enumFrom :: MdbxError -> [MdbxError]

enumFromThen :: MdbxError -> MdbxError -> [MdbxError]

enumFromTo :: MdbxError -> MdbxError -> [MdbxError]

enumFromThenTo :: MdbxError -> MdbxError -> MdbxError -> [MdbxError]

Eq MdbxError

Defined in Mdbx.FFI

Methods

(==) :: MdbxError -> MdbxError -> Bool

(/=) :: MdbxError -> MdbxError -> Bool

Ord MdbxError

Defined in Mdbx.FFI

Methods

compare :: MdbxError -> MdbxError -> Ordering

(<) :: MdbxError -> MdbxError -> Bool

(<=) :: MdbxError -> MdbxError -> Bool

(>) :: MdbxError -> MdbxError -> Bool

(>=) :: MdbxError -> MdbxError -> Bool

max :: MdbxError -> MdbxError -> MdbxError

min :: MdbxError -> MdbxError -> MdbxError

Show MdbxError

Defined in Mdbx.FFI

Methods

showsPrec :: Int -> MdbxError -> ShowS

show :: MdbxError -> String

showList :: [MdbxError] -> ShowS

Conversion for types used in keys

mdbx_key_from_float :: Float -> Word32

Converts a Double value to an unsigned Word that can be used by libmdbx's compare function.

Converts a Float value to an unsigned Word that can be used by libmdbx's compare function.

mdbx_key_from_double :: Double -> Word64

Converts a 32bits signed Int value to an unsigned Word that can be used by libmdbx's compare function.

mdbx_key_from_int32 :: Int32 -> Word32

Converts a 64bits signed Int value to an unsigned Word that can be used by libmdbx's compare function.

mdbx_key_from_int64 :: Int64 -> Word64

mdbx_float_from_key :: Word32 -> Float

Converts an unsigned Word to a Float value.

mdbx_double_from_key :: Word64 -> Double

Converts an unsigned Word to a Double value.

mdbx_int32_from_key :: Word32 -> Int32

Converts an unsigned Word value to a 32bits signed Int.

mdbx_int64_from_key :: Word64 -> Int64

Converts an unsigned Word value to a 64bits signed Int.