Skip to contents

Environments

Opening, closing and inspecting the file that holds the data.

mdbx_env_open()
Open an MDBX environment
mdbx_env_close()
Close an MDBX environment
mdbx_env_is_open()
Is an MDBX environment still open?
mdbx_env_stat()
Database statistics
mdbx_env_info()
Environment information
mdbx_limits()
Size limits imposed by 'libmdbx'
mdbx_env_reader_check()
Reclaim reader slots from processes that died

Transactions

Every read and write happens inside one. The with_* helpers cover most uses; the rest are for driving a transaction by hand.

mdbx_with_write() mdbx_with_read()
Run code inside a transaction
mdbx_txn_begin()
Begin a transaction
mdbx_txn_commit()
Commit a transaction
mdbx_txn_abort()
Abort a transaction
mdbx_txn_state()
State of a transaction

Reading and writing

mdbx_get()
Read a value
mdbx_put()
Write a value
mdbx_del()
Delete a key

Named databases

An environment can hold several independent key spaces; the unnamed main database is the default everywhere.

mdbx_dbi_open()
Open a named database
mdbx_dbi_drop()
Empty or delete a named database
mdbx_dbi_list()
List the named databases in an environment
mdbx_dbi_sequence()
A database's sequence counter
mdbx_keys()
List the keys in a database
mdbx_items()
List the keys and values in a database
mdbx_scan_max
Largest scan mdbx_keys() and mdbx_items() will do unasked

Durability and flags

Every commit is durable by default; these trade that for speed.

mdbx_flags()
Flags accepted by 'libmdbx'
mdbx_env_get_flags()
Flags an environment is using
mdbx_env_set_flags()
Change an environment's flags
mdbx_env_sync()
Flush an environment to disk

About the package

mdbx mdbx-package
mdbx: Bindings to the 'libmdbx' Embedded Key-Value Store
mdbx-concurrency
Concurrency in mdbx
mdbx-errors
Errors raised by mdbx
mdbx_version()
Version of the bundled libmdbx