#include <sys/types.h>

Include dependency graph for lmdb.h:

This graph shows which files directly or indirectly include this file:

Classes
struct	MDB_val
	Generic structure used for passing keys and data in and out of the database. More...

struct	MDB_stat
	Statistics for a database in the environment. More...

struct	MDB_envinfo
	Information about the environment. More...

Macros
#define	MDB_VERSION_MAJOR 0
	Library major version. More...

#define	MDB_VERSION_MINOR 9
	Library minor version. More...

#define	MDB_VERSION_PATCH 24
	Library patch version. More...

#define	MDB_VERINT(a, b, c) (((a) << 24) \| ((b) << 16) \| (c))
	Combine args a,b,c into a single integer for easy version comparisons. More...

#define	MDB_VERSION_FULL MDB_VERINT(MDB_VERSION_MAJOR,MDB_VERSION_MINOR,MDB_VERSION_PATCH)
	The full library version as a single integer. More...

#define	MDB_VERSION_DATE "July 24, 2019"
	The release date of this library version. More...

#define	MDB_VERSTR(a, b, c, d) "LMDB " #a "." #b "." #c ": (" d ")"
	A stringifier for the version info. More...

#define	MDB_VERFOO(a, b, c, d) MDB_VERSTR(a,b,c,d)
	A helper for the stringifier macro. More...

#define	MDB_VERSION_STRING MDB_VERFOO(MDB_VERSION_MAJOR,MDB_VERSION_MINOR,MDB_VERSION_PATCH,MDB_VERSION_DATE)
	The full library version as a C string. More...

#define	MDB_FIXEDMAP 0x01
	mmap at a fixed address (experimental) More...

#define	MDB_NOSUBDIR 0x4000
	no environment directory More...

#define	MDB_NOSYNC 0x10000
	don't fsync after commit More...

#define	MDB_RDONLY 0x20000
	read only More...

#define	MDB_NOMETASYNC 0x40000
	don't fsync metapage after commit More...

#define	MDB_WRITEMAP 0x80000
	use writable mmap More...

#define	MDB_MAPASYNC 0x100000
	use asynchronous msync when MDB_WRITEMAP is used More...

#define	MDB_NOTLS 0x200000
	tie reader locktable slots to MDB_txn objects instead of to threads More...

#define	MDB_NOLOCK 0x400000
	don't do any locking, caller must manage their own locks More...

#define	MDB_NORDAHEAD 0x800000
	don't do readahead (no effect on Windows) More...

#define	MDB_NOMEMINIT 0x1000000
	don't initialize malloc'd memory before writing to datafile More...

#define	MDB_REVERSEKEY 0x02
	use reverse string keys More...

#define	MDB_DUPSORT 0x04
	use sorted duplicates More...

#define	MDB_INTEGERKEY 0x08
	numeric keys in native byte order: either unsigned int or size_t. More...

#define	MDB_DUPFIXED 0x10
	with MDB_DUPSORT, sorted dup items have fixed size More...

#define	MDB_INTEGERDUP 0x20
	with MDB_DUPSORT, dups are MDB_INTEGERKEY-style integers More...

#define	MDB_REVERSEDUP 0x40
	with MDB_DUPSORT, use reverse string dups More...

#define	MDB_CREATE 0x40000
	create DB if not already existing More...

#define	MDB_NOOVERWRITE 0x10
	For put: Don't write if the key already exists. More...

#define	MDB_NODUPDATA 0x20
	Only for MDB_DUPSORT For put: don't write if the key and data pair already exist. More...

#define	MDB_CURRENT 0x40
	For mdb_cursor_put: overwrite the current key/data pair. More...

#define	MDB_RESERVE 0x10000
	For put: Just reserve space for data, don't copy it. More...

#define	MDB_APPEND 0x20000
	Data is being appended, don't split full pages. More...

#define	MDB_APPENDDUP 0x40000
	Duplicate data is being appended, don't split full pages. More...

#define	MDB_MULTIPLE 0x80000
	Store multiple data items in one call. More...

#define	MDB_CP_COMPACT 0x01
	Compacting copy: Omit free space from copy, and renumber all pages sequentially. More...

#define	MDB_SUCCESS 0
	Successful result. More...

#define	MDB_KEYEXIST (-30799)
	key/data pair already exists More...

#define	MDB_NOTFOUND (-30798)
	key/data pair not found (EOF) More...

#define	MDB_PAGE_NOTFOUND (-30797)
	Requested page not found - this usually indicates corruption. More...

#define	MDB_CORRUPTED (-30796)
	Located page was wrong type. More...

#define	MDB_PANIC (-30795)
	Update of meta page failed or environment had fatal error. More...

#define	MDB_VERSION_MISMATCH (-30794)
	Environment version mismatch. More...

#define	MDB_INVALID (-30793)
	File is not a valid LMDB file. More...

#define	MDB_MAP_FULL (-30792)
	Environment mapsize reached. More...

#define	MDB_DBS_FULL (-30791)
	Environment maxdbs reached. More...

#define	MDB_READERS_FULL (-30790)
	Environment maxreaders reached. More...

#define	MDB_TLS_FULL (-30789)
	Too many TLS keys in use - Windows only. More...

#define	MDB_TXN_FULL (-30788)
	Txn has too many dirty pages. More...

#define	MDB_CURSOR_FULL (-30787)
	Cursor stack too deep - internal error. More...

#define	MDB_PAGE_FULL (-30786)
	Page has not enough space - internal error. More...

#define	MDB_MAP_RESIZED (-30785)
	Database contents grew beyond environment mapsize. More...

#define	MDB_INCOMPATIBLE (-30784)
	Operation and DB incompatible, or DB type changed. More...

#define	MDB_BAD_RSLOT (-30783)
	Invalid reuse of reader locktable slot. More...

#define	MDB_BAD_TXN (-30782)
	Transaction must abort, has a child, or is invalid. More...

#define	MDB_BAD_VALSIZE (-30781)
	Unsupported size of key/DB name/data, or wrong DUPFIXED size. More...

#define	MDB_BAD_DBI (-30780)
	The specified DBI was changed unexpectedly. More...

#define	MDB_LAST_ERRCODE MDB_BAD_DBI
	The last defined error code. More...

#define	mdb_open(txn, name, flags, dbi) mdb_dbi_open(txn,name,flags,dbi)
	Compat with version <= 0.9.4, avoid clash with libmdb from MDB Tools project. More...

#define	mdb_close(env, dbi) mdb_dbi_close(env,dbi)
	Compat with version <= 0.9.4, avoid clash with libmdb from MDB Tools project. More...

#define	MDB_VERSION_MAJOR 0
	Library major version. More...

#define	MDB_VERSION_MINOR 9
	Library minor version. More...

#define	MDB_VERSION_PATCH 24
	Library patch version. More...

#define	MDB_VERINT(a, b, c) (((a) << 24) \| ((b) << 16) \| (c))
	Combine args a,b,c into a single integer for easy version comparisons. More...

#define	MDB_VERSION_FULL MDB_VERINT(MDB_VERSION_MAJOR,MDB_VERSION_MINOR,MDB_VERSION_PATCH)
	The full library version as a single integer. More...

#define	MDB_VERSION_DATE "July 24, 2019"
	The release date of this library version. More...

#define	MDB_VERSTR(a, b, c, d) "LMDB " #a "." #b "." #c ": (" d ")"
	A stringifier for the version info. More...

#define	MDB_VERFOO(a, b, c, d) MDB_VERSTR(a,b,c,d)
	A helper for the stringifier macro. More...

#define	MDB_VERSION_STRING MDB_VERFOO(MDB_VERSION_MAJOR,MDB_VERSION_MINOR,MDB_VERSION_PATCH,MDB_VERSION_DATE)
	The full library version as a C string. More...

#define	MDB_FIXEDMAP 0x01
	mmap at a fixed address (experimental) More...

#define	MDB_NOSUBDIR 0x4000
	no environment directory More...

#define	MDB_NOSYNC 0x10000
	don't fsync after commit More...

#define	MDB_RDONLY 0x20000
	read only More...

#define	MDB_NOMETASYNC 0x40000
	don't fsync metapage after commit More...

#define	MDB_WRITEMAP 0x80000
	use writable mmap More...

#define	MDB_MAPASYNC 0x100000
	use asynchronous msync when MDB_WRITEMAP is used More...

#define	MDB_NOTLS 0x200000
	tie reader locktable slots to MDB_txn objects instead of to threads More...

#define	MDB_NOLOCK 0x400000
	don't do any locking, caller must manage their own locks More...

#define	MDB_NORDAHEAD 0x800000
	don't do readahead (no effect on Windows) More...

#define	MDB_NOMEMINIT 0x1000000
	don't initialize malloc'd memory before writing to datafile More...

#define	MDB_REVERSEKEY 0x02
	use reverse string keys More...

#define	MDB_DUPSORT 0x04
	use sorted duplicates More...

#define	MDB_INTEGERKEY 0x08
	numeric keys in native byte order: either unsigned int or size_t. More...

#define	MDB_DUPFIXED 0x10
	with MDB_DUPSORT, sorted dup items have fixed size More...

#define	MDB_INTEGERDUP 0x20
	with MDB_DUPSORT, dups are MDB_INTEGERKEY-style integers More...

#define	MDB_REVERSEDUP 0x40
	with MDB_DUPSORT, use reverse string dups More...

#define	MDB_CREATE 0x40000
	create DB if not already existing More...

#define	MDB_NOOVERWRITE 0x10
	For put: Don't write if the key already exists. More...

#define	MDB_NODUPDATA 0x20
	Only for MDB_DUPSORT For put: don't write if the key and data pair already exist. More...

#define	MDB_CURRENT 0x40
	For mdb_cursor_put: overwrite the current key/data pair. More...

#define	MDB_RESERVE 0x10000
	For put: Just reserve space for data, don't copy it. More...

#define	MDB_APPEND 0x20000
	Data is being appended, don't split full pages. More...

#define	MDB_APPENDDUP 0x40000
	Duplicate data is being appended, don't split full pages. More...

#define	MDB_MULTIPLE 0x80000
	Store multiple data items in one call. More...

#define	MDB_CP_COMPACT 0x01
	Compacting copy: Omit free space from copy, and renumber all pages sequentially. More...

#define	MDB_SUCCESS 0
	Successful result. More...

#define	MDB_KEYEXIST (-30799)
	key/data pair already exists More...

#define	MDB_NOTFOUND (-30798)
	key/data pair not found (EOF) More...

#define	MDB_PAGE_NOTFOUND (-30797)
	Requested page not found - this usually indicates corruption. More...

#define	MDB_CORRUPTED (-30796)
	Located page was wrong type. More...

#define	MDB_PANIC (-30795)
	Update of meta page failed or environment had fatal error. More...

#define	MDB_VERSION_MISMATCH (-30794)
	Environment version mismatch. More...

#define	MDB_INVALID (-30793)
	File is not a valid LMDB file. More...

#define	MDB_MAP_FULL (-30792)
	Environment mapsize reached. More...

#define	MDB_DBS_FULL (-30791)
	Environment maxdbs reached. More...

#define	MDB_READERS_FULL (-30790)
	Environment maxreaders reached. More...

#define	MDB_TLS_FULL (-30789)
	Too many TLS keys in use - Windows only. More...

#define	MDB_TXN_FULL (-30788)
	Txn has too many dirty pages. More...

#define	MDB_CURSOR_FULL (-30787)
	Cursor stack too deep - internal error. More...

#define	MDB_PAGE_FULL (-30786)
	Page has not enough space - internal error. More...

#define	MDB_MAP_RESIZED (-30785)
	Database contents grew beyond environment mapsize. More...

#define	MDB_INCOMPATIBLE (-30784)
	Operation and DB incompatible, or DB type changed. More...

#define	MDB_BAD_RSLOT (-30783)
	Invalid reuse of reader locktable slot. More...

#define	MDB_BAD_TXN (-30782)
	Transaction must abort, has a child, or is invalid. More...

#define	MDB_BAD_VALSIZE (-30781)
	Unsupported size of key/DB name/data, or wrong DUPFIXED size. More...

#define	MDB_BAD_DBI (-30780)
	The specified DBI was changed unexpectedly. More...

#define	MDB_LAST_ERRCODE MDB_BAD_DBI
	The last defined error code. More...

#define	mdb_open(txn, name, flags, dbi) mdb_dbi_open(txn,name,flags,dbi)
	Compat with version <= 0.9.4, avoid clash with libmdb from MDB Tools project. More...

#define	mdb_close(env, dbi) mdb_dbi_close(env,dbi)
	Compat with version <= 0.9.4, avoid clash with libmdb from MDB Tools project. More...

Typedefs
typedef mode_t	mdb_mode_t
	Unix permissions for creating files, or dummy definition for Windows. More...

typedef int	mdb_filehandle_t
	An abstraction for a file handle. More...

typedef struct MDB_env	MDB_env
	Opaque structure for a database environment. More...

typedef struct MDB_txn	MDB_txn
	Opaque structure for a transaction handle. More...

typedef unsigned int	MDB_dbi
	A handle for an individual database in the DB environment. More...

typedef struct MDB_cursor	MDB_cursor
	Opaque structure for navigating through a database. More...

typedef struct MDB_val	MDB_val
	Generic structure used for passing keys and data in and out of the database. More...

typedef int()	MDB_cmp_func(const MDB_val a, const MDB_val b)
	A callback function used to compare two keys in a database. More...

typedef void()	MDB_rel_func(MDB_val item, void oldptr, void newptr, void relctx)
	A callback function used to relocate a position-dependent data item in a fixed-address database. More...

typedef enum MDB_cursor_op	MDB_cursor_op
	Cursor Get operations. More...

typedef struct MDB_stat	MDB_stat
	Statistics for a database in the environment. More...

typedef struct MDB_envinfo	MDB_envinfo
	Information about the environment. More...

typedef void	MDB_assert_func(MDB_env env, const char msg)
	A callback function for most LMDB assert() failures, called before printing the message and aborting. More...

typedef int()	MDB_msg_func(const char msg, void ctx)
	A callback function used to print a message from the library. More...

Enumerations
enum	MDB_cursor_op { MDB_FIRST , MDB_FIRST_DUP , MDB_GET_BOTH , MDB_GET_BOTH_RANGE , MDB_GET_CURRENT , MDB_GET_MULTIPLE , MDB_LAST , MDB_LAST_DUP , MDB_NEXT , MDB_NEXT_DUP , MDB_NEXT_MULTIPLE , MDB_NEXT_NODUP , MDB_PREV , MDB_PREV_DUP , MDB_PREV_NODUP , MDB_SET , MDB_SET_KEY , MDB_SET_RANGE , MDB_PREV_MULTIPLE , MDB_FIRST , MDB_FIRST_DUP , MDB_GET_BOTH , MDB_GET_BOTH_RANGE , MDB_GET_CURRENT , MDB_GET_MULTIPLE , MDB_LAST , MDB_LAST_DUP , MDB_NEXT , MDB_NEXT_DUP , MDB_NEXT_MULTIPLE , MDB_NEXT_NODUP , MDB_PREV , MDB_PREV_DUP , MDB_PREV_NODUP , MDB_SET , MDB_SET_KEY , MDB_SET_RANGE , MDB_PREV_MULTIPLE }
	Cursor Get operations. More...

enum	MDB_cursor_op { MDB_FIRST , MDB_FIRST_DUP , MDB_GET_BOTH , MDB_GET_BOTH_RANGE , MDB_GET_CURRENT , MDB_GET_MULTIPLE , MDB_LAST , MDB_LAST_DUP , MDB_NEXT , MDB_NEXT_DUP , MDB_NEXT_MULTIPLE , MDB_NEXT_NODUP , MDB_PREV , MDB_PREV_DUP , MDB_PREV_NODUP , MDB_SET , MDB_SET_KEY , MDB_SET_RANGE , MDB_PREV_MULTIPLE , MDB_FIRST , MDB_FIRST_DUP , MDB_GET_BOTH , MDB_GET_BOTH_RANGE , MDB_GET_CURRENT , MDB_GET_MULTIPLE , MDB_LAST , MDB_LAST_DUP , MDB_NEXT , MDB_NEXT_DUP , MDB_NEXT_MULTIPLE , MDB_NEXT_NODUP , MDB_PREV , MDB_PREV_DUP , MDB_PREV_NODUP , MDB_SET , MDB_SET_KEY , MDB_SET_RANGE , MDB_PREV_MULTIPLE }
	Cursor Get operations. More...

Functions
char *	mdb_version (int major, int minor, int *patch)
	Return the LMDB library version information. More...

char *	mdb_strerror (int err)
	Return a string describing a given error code. More...

int	mdb_env_create (MDB_env **env)
	Create an LMDB environment handle. More...

int	mdb_env_open (MDB_env env, const char path, unsigned int flags, mdb_mode_t mode)
	Open an environment handle. More...

int	mdb_env_copy (MDB_env env, const char path)
	Copy an LMDB environment to the specified path. More...

int	mdb_env_copyfd (MDB_env *env, mdb_filehandle_t fd)
	Copy an LMDB environment to the specified file descriptor. More...

int	mdb_env_copy2 (MDB_env env, const char path, unsigned int flags)
	Copy an LMDB environment to the specified path, with options. More...

int	mdb_env_copyfd2 (MDB_env *env, mdb_filehandle_t fd, unsigned int flags)
	Copy an LMDB environment to the specified file descriptor, with options. More...

int	mdb_env_stat (MDB_env env, MDB_stat stat)
	Return statistics about the LMDB environment. More...

int	mdb_env_info (MDB_env env, MDB_envinfo stat)
	Return information about the LMDB environment. More...

int	mdb_env_sync (MDB_env *env, int force)
	Flush the data buffers to disk. More...

void	mdb_env_close (MDB_env *env)
	Close the environment and release the memory map. More...

int	mdb_env_set_flags (MDB_env *env, unsigned int flags, int onoff)
	Set environment flags. More...

int	mdb_env_get_flags (MDB_env env, unsigned int flags)
	Get environment flags. More...

int	mdb_env_get_path (MDB_env env, const char *path)
	Return the path that was used in mdb_env_open(). More...

int	mdb_env_get_fd (MDB_env env, mdb_filehandle_t fd)
	Return the filedescriptor for the given environment. More...

int	mdb_env_set_mapsize (MDB_env *env, size_t size)
	Set the size of the memory map to use for this environment. More...

int	mdb_env_set_maxreaders (MDB_env *env, unsigned int readers)
	Set the maximum number of threads/reader slots for the environment. More...

int	mdb_env_get_maxreaders (MDB_env env, unsigned int readers)
	Get the maximum number of threads/reader slots for the environment. More...

int	mdb_env_set_maxdbs (MDB_env *env, MDB_dbi dbs)
	Set the maximum number of named databases for the environment. More...

int	mdb_env_get_maxkeysize (MDB_env *env)
	Get the maximum size of keys and MDB_DUPSORT data we can write. More...

int	mdb_env_set_userctx (MDB_env env, void ctx)
	Set application information associated with the MDB_env. More...

void *	mdb_env_get_userctx (MDB_env *env)
	Get the application information associated with the MDB_env. More...

int	mdb_env_set_assert (MDB_env env, MDB_assert_func func)
	Set or reset the assert() callback of the environment. More...

int	mdb_txn_begin (MDB_env env, MDB_txn parent, unsigned int flags, MDB_txn **txn)
	Create a transaction for use with the environment. More...

MDB_env *	mdb_txn_env (MDB_txn *txn)
	Returns the transaction's MDB_env. More...

size_t	mdb_txn_id (MDB_txn *txn)
	Return the transaction's ID. More...

int	mdb_txn_commit (MDB_txn *txn)
	Commit all the operations of a transaction into the database. More...

void	mdb_txn_abort (MDB_txn *txn)
	Abandon all the operations of the transaction instead of saving them. More...

void	mdb_txn_reset (MDB_txn *txn)
	Reset a read-only transaction. More...

int	mdb_txn_renew (MDB_txn *txn)
	Renew a read-only transaction. More...

int	mdb_dbi_open (MDB_txn txn, const char name, unsigned int flags, MDB_dbi *dbi)
	Open a database in the environment. More...

int	mdb_stat (MDB_txn txn, MDB_dbi dbi, MDB_stat stat)
	Retrieve statistics for a database. More...

int	mdb_dbi_flags (MDB_txn txn, MDB_dbi dbi, unsigned int flags)
	Retrieve the DB flags for a database handle. More...

void	mdb_dbi_close (MDB_env *env, MDB_dbi dbi)
	Close a database handle. More...

int	mdb_drop (MDB_txn *txn, MDB_dbi dbi, int del)
	Empty or delete+close a database. More...

int	mdb_set_compare (MDB_txn txn, MDB_dbi dbi, MDB_cmp_func cmp)
	Set a custom key comparison function for a database. More...

int	mdb_set_dupsort (MDB_txn txn, MDB_dbi dbi, MDB_cmp_func cmp)
	Set a custom data comparison function for a MDB_DUPSORT database. More...

int	mdb_set_relfunc (MDB_txn txn, MDB_dbi dbi, MDB_rel_func rel)
	Set a relocation function for a MDB_FIXEDMAP database. More...

int	mdb_set_relctx (MDB_txn txn, MDB_dbi dbi, void ctx)
	Set a context pointer for a MDB_FIXEDMAP database's relocation function. More...

int	mdb_get (MDB_txn txn, MDB_dbi dbi, MDB_val key, MDB_val *data)
	Get items from a database. More...

int	mdb_put (MDB_txn txn, MDB_dbi dbi, MDB_val key, MDB_val *data, unsigned int flags)
	Store items into a database. More...

int	mdb_del (MDB_txn txn, MDB_dbi dbi, MDB_val key, MDB_val *data)
	Delete items from a database. More...

int	mdb_cursor_open (MDB_txn txn, MDB_dbi dbi, MDB_cursor *cursor)
	Create a cursor handle. More...

void	mdb_cursor_close (MDB_cursor *cursor)
	Close a cursor handle. More...

int	mdb_cursor_renew (MDB_txn txn, MDB_cursor cursor)
	Renew a cursor handle. More...

MDB_txn *	mdb_cursor_txn (MDB_cursor *cursor)
	Return the cursor's transaction handle. More...

MDB_dbi	mdb_cursor_dbi (MDB_cursor *cursor)
	Return the cursor's database handle. More...

int	mdb_cursor_get (MDB_cursor cursor, MDB_val key, MDB_val *data, MDB_cursor_op op)
	Retrieve by cursor. More...

int	mdb_cursor_put (MDB_cursor cursor, MDB_val key, MDB_val *data, unsigned int flags)
	Store by cursor. More...

int	mdb_cursor_del (MDB_cursor *cursor, unsigned int flags)
	Delete current key/data pair. More...

int	mdb_cursor_count (MDB_cursor cursor, size_t countp)
	Return count of duplicates for current key. More...

int	mdb_cmp (MDB_txn txn, MDB_dbi dbi, const MDB_val a, const MDB_val *b)
	Compare two data items according to a particular database. More...

int	mdb_dcmp (MDB_txn txn, MDB_dbi dbi, const MDB_val a, const MDB_val *b)
	Compare two data items according to a particular database. More...

int	mdb_reader_list (MDB_env env, MDB_msg_func func, void *ctx)
	Dump the entries in the reader lock table. More...

int	mdb_reader_check (MDB_env env, int dead)
	Check for stale entries in the reader lock table. More...

Typedef Documentation

◆ mdb_filehandle_t

typedef int mdb_filehandle_t

An abstraction for a file handle.

On POSIX systems file handles are small integers. On Windows they're opaque pointers.

Definition at line 188 of file lmdb.h.

◆ mdb_mode_t

typedef mode_t mdb_mode_t

Unix permissions for creating files, or dummy definition for Windows.

Definition at line 178 of file lmdb.h.

Classes

Macros

Typedefs

Enumerations

Functions

Typedef Documentation

◆ mdb_filehandle_t

◆ mdb_mode_t