libmdbx: Bindings for libmdbx, an embedded key/value store

[ bsd3, database, library, program ] [ Propose Tags ]

Haskell bindings for libmdbx.

See documentation in the main module or check the README on GitHub.


[Skip to Readme]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 0.1.0.0, 0.1.0.1, 0.1.0.2, 0.1.0.3, 0.1.0.4, 0.2.0.0, 0.2.1.0, 0.2.1.1
Change log ChangeLog.md
Dependencies base (>=4.12 && <5), binary (>=0.8 && <0.11), bytestring (>=0.10 && <0.12), data-default (>=0.5 && <0.8), libmdbx, mtl (>=2.1 && <2.3), store (>=0.5 && <0.8), store-core (>=0.4 && <0.5), text (>=1.2 && <1.3), transformers (>=0.5 && <0.7) [details]
License BSD-3-Clause
Copyright 2021 Francisco Vallarino
Author Francisco Vallarino
Maintainer fjvallarino@gmail.com
Category Database
Home page https://github.com/fjvallarino/libmdbx-hs#readme
Bug tracker https://github.com/fjvallarino/libmdbx-hs/issues
Source repo head: git clone https://github.com/fjvallarino/libmdbx-hs
Uploaded by fjvallarino at 2022-01-20T02:55:46Z
Distributions NixOS:0.2.1.1
Executables libmdbx-exe
Downloads 638 total (23 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2022-01-20 [all 1 reports]

Readme for libmdbx-0.2.1.1

[back to package description]

libmdbx-hs

A libmdbx wrapper, providing low level access to its API plus a set of high level functions for common operations.

Excerpt from libmdbx's documentation:

libmdbx is an extremely fast, compact, powerful, embedded, transactional key-value database, with permissive license.

Historically, libmdbx is a deeply revised and extended descendant of the amazing Lightning Memory-Mapped Database. libmdbx inherits all benefits from LMDB, but resolves some issues and adds a set of improvements.

Usage

Low level interface

Using libmdbx's low level interface involves the following steps:

  • Opening an environment. This is the equivalent of a database.
  • Opening a database. This is the equivalent of a table.
  • Creating a transaction.
  • Performing CRUD operations, or using a cursor.
  • Committing or aborting the transaction.

See Hackage for the low level interface or libmdbx's documentation for more details on internals.

High level interface

Alternatively you can use the high level interface which, although providing a limited set of operations, takes care of transaction handling and makes the common use cases really simple.

data User = User {
  _username :: !Text,
  _password :: !Text
} deriving (Eq, Show, Generic, Store)

deriving via (MdbxItemStore User) instance MdbxItem User

openEnvDbi :: IO MdbxEnv
openEnvDbi = envOpen "./test.db" def [MdbxNosubdir, MdbxCoalesce, MdbxLiforeclaim, MdbxNotls]

userKey :: User -> Text
userKey user = "user-" <> _username user

main :: IO ()
main = bracket openEnvDbi envClose $ \env -> do
  db <- dbiOpen env Nothing []

  putItem env db (userKey user1) user1
  putItem env db (userKey user2) user2

  getItem env db (userKey user2) >>= print @(Maybe User)
  getRange env db (userKey user1) (userKey user2) >>= print @[User]
  where
    user1 = User "john" "secret"
    user2 = User "mark" "password"

For the high level interface see Hackage or the sample application here.

Common

In both scenarios, you will want to check Hackage for information on how to make your data types compatible with libmdbx-hs.

It is recommended that your serializable data types have strict fields, to avoid issues related to lazy IO. The library loads data from pointers that are valid only during a transaction; delaying the operation may cause an invalid read and consequently a crash.

Write operations should always be performed from the same OS thread.

When using the multi-threaded runtime, the MdbxNotls flag is required at environment creation. Failing to include it in the list of flags will result in a random crash.

Dependencies

Source code for libmdbx is included in the repository and built with the rest of the project, to avoid requiring a separate library install.

License

libmdbx is licensed under the The OpenLDAP Public License.

libmdbx-hs is licensed under the BSD-3 License.