2 * @brief Lightning memory-mapped database library
4 * @mainpage Lightning Memory-Mapped Database Manager (MDB)
6 * @section intro_sec Introduction
7 * MDB is a Btree-based database management library modeled loosely on the
8 * BerkeleyDB API, but much simplified. The entire database is exposed
9 * in a memory map, and all data fetches return data directly
10 * from the mapped memory, so no malloc's or memcpy's occur during
11 * data fetches. As such, the library is extremely simple because it
12 * requires no page caching layer of its own, and it is extremely high
13 * performance and memory-efficient. It is also fully transactional with
14 * full ACID semantics, and when the memory map is read-only, the
15 * database integrity cannot be corrupted by stray pointer writes from
18 * The library is fully thread-aware and supports concurrent read/write
19 * access from multiple processes and threads. Data pages use a copy-on-
20 * write strategy so no active data pages are ever overwritten, which
21 * also provides resistance to corruption and eliminates the need of any
22 * special recovery procedures after a system crash. Writes are fully
23 * serialized; only one write transaction may be active at a time, which
24 * guarantees that writers can never deadlock. The database structure is
25 * multi-versioned so readers run with no locks; writers cannot block
26 * readers, and readers don't block writers.
28 * Unlike other well-known database mechanisms which use either write-ahead
29 * transaction logs or append-only data writes, MDB requires no maintenance
30 * during operation. Both write-ahead loggers and append-only databases
31 * require periodic checkpointing and/or compaction of their log or database
32 * files otherwise they grow without bound. MDB tracks free pages within
33 * the database and re-uses them for new write operations, so the database
34 * size does not grow without bound in normal use.
36 * The memory map can be used as a read-only or read-write map. It is
37 * read-only by default as this provides total immunity to corruption.
38 * Using read-write mode offers much higher write performance, but adds
39 * the possibility for stray application writes thru pointers to silently
40 * corrupt the database. Of course if your application code is known to
41 * be bug-free (...) then this is not an issue.
43 * @section caveats_sec Caveats
44 * Troubleshooting the lock file, plus semaphores on BSD systems:
46 * - A broken lockfile can cause sync issues.
47 * Stale reader transactions left behind by an aborted program
48 * cause further writes to grow the database quickly, and
49 * stale locks can block further operation.
51 * Fix: Check for stale readers periodically, using the
52 * #mdb_reader_check function or the mdb_stat tool. Or just
53 * make all programs using the database close it; the lockfile
54 * is always reset on first open of the environment.
56 * - On BSD systems or others configured with MDB_USE_POSIX_SEM,
57 * startup can fail due to semaphores owned by another userid.
59 * Fix: Open and close the database as the user which owns the
60 * semaphores (likely last user) or as root, while no other
61 * process is using the database.
63 * Restrictions/caveats (in addition to those listed for some functions):
65 * - Only the database owner should normally use the database on
66 * BSD systems or when otherwise configured with MDB_USE_POSIX_SEM.
67 * Multiple users can cause startup to fail later, as noted above.
69 * - A thread can only use one transaction at a time, plus any child
70 * transactions. Each transaction belongs to one thread. See below.
71 * The #MDB_NOTLS flag changes this for read-only transactions.
73 * - Use an MDB_env* in the process which opened it, without fork()ing.
75 * - Do not have open an MDB database twice in the same process at
76 * the same time. Not even from a plain open() call - close()ing it
77 * breaks flock() advisory locking.
79 * - Avoid long-lived transactions. Read transactions prevent
80 * reuse of pages freed by newer write transactions, thus the
81 * database can grow quickly. Write transactions prevent
82 * other write transactions, since writes are serialized.
84 * - Avoid suspending a process with active transactions. These
85 * would then be "long-lived" as above. Also read transactions
86 * suspended when writers commit could sometimes see wrong data.
88 * ...when several processes can use a database concurrently:
90 * - Avoid aborting a process with an active transaction.
91 * The transaction becomes "long-lived" as above until a check
92 * for stale readers is performed or the lockfile is reset,
93 * since the process may not remove it from the lockfile.
95 * - If you do that anyway, do a periodic check for stale readers. Or
96 * close the environment once in a while, so the lockfile can get reset.
98 * - Do not use MDB databases on remote filesystems, even between
99 * processes on the same host. This breaks flock() on some OSes,
100 * possibly memory map sync, and certainly sync between programs
101 * on different hosts.
103 * - Opening a database can fail if another process is opening or
104 * closing it at exactly the same time.
106 * @author Howard Chu, Symas Corporation.
108 * @copyright Copyright 2011-2013 Howard Chu, Symas Corp. All rights reserved.
110 * Redistribution and use in source and binary forms, with or without
111 * modification, are permitted only as authorized by the OpenLDAP
114 * A copy of this license is available in the file LICENSE in the
115 * top-level directory of the distribution or, alternatively, at
116 * <http://www.OpenLDAP.org/license.html>.
119 * This code is derived from btree.c written by Martin Hedenfalk.
121 * Copyright (c) 2009, 2010 Martin Hedenfalk <martin@bzero.se>
123 * Permission to use, copy, modify, and distribute this software for any
124 * purpose with or without fee is hereby granted, provided that the above
125 * copyright notice and this permission notice appear in all copies.
127 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
128 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
129 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
130 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
131 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
132 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
133 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
138 #include <sys/types.h>
144 /** Unix permissions for creating files, or dummy definition for Windows */
146 typedef int mdb_mode_t;
148 typedef mode_t mdb_mode_t;
151 /** An abstraction for a file handle.
152 * On POSIX systems file handles are small integers. On Windows
153 * they're opaque pointers.
156 typedef void *mdb_filehandle_t;
158 typedef int mdb_filehandle_t;
161 /** @defgroup mdb MDB API
163 * @brief OpenLDAP Lightning Memory-Mapped Database Manager
165 /** @defgroup Version Version Macros
168 /** Library major version */
169 #define MDB_VERSION_MAJOR 0
170 /** Library minor version */
171 #define MDB_VERSION_MINOR 9
172 /** Library patch version */
173 #define MDB_VERSION_PATCH 8
175 /** Combine args a,b,c into a single integer for easy version comparisons */
176 #define MDB_VERINT(a,b,c) (((a) << 24) | ((b) << 16) | (c))
178 /** The full library version as a single integer */
179 #define MDB_VERSION_FULL \
180 MDB_VERINT(MDB_VERSION_MAJOR,MDB_VERSION_MINOR,MDB_VERSION_PATCH)
182 /** The release date of this library version */
183 #define MDB_VERSION_DATE "September 9, 2013"
185 /** A stringifier for the version info */
186 #define MDB_VERSTR(a,b,c,d) "MDB " #a "." #b "." #c ": (" d ")"
188 /** A helper for the stringifier macro */
189 #define MDB_VERFOO(a,b,c,d) MDB_VERSTR(a,b,c,d)
191 /** The full library version as a C string */
192 #define MDB_VERSION_STRING \
193 MDB_VERFOO(MDB_VERSION_MAJOR,MDB_VERSION_MINOR,MDB_VERSION_PATCH,MDB_VERSION_DATE)
196 /** @brief Opaque structure for a database environment.
198 * A DB environment supports multiple databases, all residing in the same
201 typedef struct MDB_env MDB_env;
203 /** @brief Opaque structure for a transaction handle.
205 * All database operations require a transaction handle. Transactions may be
206 * read-only or read-write.
208 typedef struct MDB_txn MDB_txn;
210 /** @brief A handle for an individual database in the DB environment. */
211 typedef unsigned int MDB_dbi;
213 /** @brief Opaque structure for navigating through a database */
214 typedef struct MDB_cursor MDB_cursor;
216 /** @brief Generic structure used for passing keys and data in and out
219 * Values returned from the database are valid only until a subsequent
220 * update operation, or the end of the transaction. Do not modify or
221 * free them, they commonly point into the database itself.
223 * Key sizes must be between 1 and #mdb_env_get_maxkeysize() inclusive.
224 * The same applies to data sizes in databases with the #MDB_DUPSORT flag.
225 * Other data items can in theory be from 0 to 0xffffffff bytes long.
227 typedef struct MDB_val {
228 size_t mv_size; /**< size of the data item */
229 void *mv_data; /**< address of the data item */
232 /** @brief A callback function used to compare two keys in a database */
233 typedef int (MDB_cmp_func)(const MDB_val *a, const MDB_val *b);
235 /** @brief A callback function used to relocate a position-dependent data item
236 * in a fixed-address database.
238 * The \b newptr gives the item's desired address in
239 * the memory map, and \b oldptr gives its previous address. The item's actual
240 * data resides at the address in \b item. This callback is expected to walk
241 * through the fields of the record in \b item and modify any
242 * values based at the \b oldptr address to be relative to the \b newptr address.
243 * @param[in,out] item The item that is to be relocated.
244 * @param[in] oldptr The previous address.
245 * @param[in] newptr The new address to relocate to.
246 * @param[in] relctx An application-provided context, set by #mdb_set_relctx().
247 * @todo This feature is currently unimplemented.
249 typedef void (MDB_rel_func)(MDB_val *item, void *oldptr, void *newptr, void *relctx);
251 /** @defgroup mdb_env Environment Flags
253 * Values do not overlap Database Flags.
256 /** mmap at a fixed address (experimental) */
257 #define MDB_FIXEDMAP 0x01
258 /** no environment directory */
259 #define MDB_NOSUBDIR 0x4000
260 /** don't fsync after commit */
261 #define MDB_NOSYNC 0x10000
263 #define MDB_RDONLY 0x20000
264 /** don't fsync metapage after commit */
265 #define MDB_NOMETASYNC 0x40000
266 /** use writable mmap */
267 #define MDB_WRITEMAP 0x80000
268 /** use asynchronous msync when MDB_WRITEMAP is used */
269 #define MDB_MAPASYNC 0x100000
270 /** tie reader locktable slots to #MDB_txn objects instead of to threads */
271 #define MDB_NOTLS 0x200000
274 /** @defgroup mdb_dbi_open Database Flags
276 * Values do not overlap Environment Flags.
279 /** use reverse string keys */
280 #define MDB_REVERSEKEY 0x02
281 /** use sorted duplicates */
282 #define MDB_DUPSORT 0x04
283 /** numeric keys in native byte order.
284 * The keys must all be of the same size. */
285 #define MDB_INTEGERKEY 0x08
286 /** with #MDB_DUPSORT, sorted dup items have fixed size */
287 #define MDB_DUPFIXED 0x10
288 /** with #MDB_DUPSORT, dups are numeric in native byte order */
289 #define MDB_INTEGERDUP 0x20
290 /** with #MDB_DUPSORT, use reverse string dups */
291 #define MDB_REVERSEDUP 0x40
292 /** create DB if not already existing */
293 #define MDB_CREATE 0x40000
296 /** @defgroup mdb_put Write Flags
299 /** For put: Don't write if the key already exists. */
300 #define MDB_NOOVERWRITE 0x10
301 /** Only for #MDB_DUPSORT<br>
302 * For put: don't write if the key and data pair already exist.<br>
303 * For mdb_cursor_del: remove all duplicate data items.
305 #define MDB_NODUPDATA 0x20
306 /** For mdb_cursor_put: overwrite the current key/data pair */
307 #define MDB_CURRENT 0x40
308 /** For put: Just reserve space for data, don't copy it. Return a
309 * pointer to the reserved space.
311 #define MDB_RESERVE 0x10000
312 /** Data is being appended, don't split full pages. */
313 #define MDB_APPEND 0x20000
314 /** Duplicate data is being appended, don't split full pages. */
315 #define MDB_APPENDDUP 0x40000
316 /** Store multiple data items in one call. Only for #MDB_DUPFIXED. */
317 #define MDB_MULTIPLE 0x80000
320 /** @brief Cursor Get operations.
322 * This is the set of all operations for retrieving data
325 typedef enum MDB_cursor_op {
326 MDB_FIRST, /**< Position at first key/data item */
327 MDB_FIRST_DUP, /**< Position at first data item of current key.
328 Only for #MDB_DUPSORT */
329 MDB_GET_BOTH, /**< Position at key/data pair. Only for #MDB_DUPSORT */
330 MDB_GET_BOTH_RANGE, /**< position at key, nearest data. Only for #MDB_DUPSORT */
331 MDB_GET_CURRENT, /**< Return key/data at current cursor position */
332 MDB_GET_MULTIPLE, /**< Return all the duplicate data items at the current
333 cursor position. Only for #MDB_DUPFIXED */
334 MDB_LAST, /**< Position at last key/data item */
335 MDB_LAST_DUP, /**< Position at last data item of current key.
336 Only for #MDB_DUPSORT */
337 MDB_NEXT, /**< Position at next data item */
338 MDB_NEXT_DUP, /**< Position at next data item of current key.
339 Only for #MDB_DUPSORT */
340 MDB_NEXT_MULTIPLE, /**< Return all duplicate data items at the next
341 cursor position. Only for #MDB_DUPFIXED */
342 MDB_NEXT_NODUP, /**< Position at first data item of next key */
343 MDB_PREV, /**< Position at previous data item */
344 MDB_PREV_DUP, /**< Position at previous data item of current key.
345 Only for #MDB_DUPSORT */
346 MDB_PREV_NODUP, /**< Position at last data item of previous key */
347 MDB_SET, /**< Position at specified key */
348 MDB_SET_KEY, /**< Position at specified key, return key + data */
349 MDB_SET_RANGE /**< Position at first key greater than or equal to specified key. */
352 /** @defgroup errors Return Codes
354 * BerkeleyDB uses -30800 to -30999, we'll go under them
357 /** Successful result */
358 #define MDB_SUCCESS 0
359 /** key/data pair already exists */
360 #define MDB_KEYEXIST (-30799)
361 /** key/data pair not found (EOF) */
362 #define MDB_NOTFOUND (-30798)
363 /** Requested page not found - this usually indicates corruption */
364 #define MDB_PAGE_NOTFOUND (-30797)
365 /** Located page was wrong type */
366 #define MDB_CORRUPTED (-30796)
367 /** Update of meta page failed, probably I/O error */
368 #define MDB_PANIC (-30795)
369 /** Environment version mismatch */
370 #define MDB_VERSION_MISMATCH (-30794)
371 /** File is not a valid MDB file */
372 #define MDB_INVALID (-30793)
373 /** Environment mapsize reached */
374 #define MDB_MAP_FULL (-30792)
375 /** Environment maxdbs reached */
376 #define MDB_DBS_FULL (-30791)
377 /** Environment maxreaders reached */
378 #define MDB_READERS_FULL (-30790)
379 /** Too many TLS keys in use - Windows only */
380 #define MDB_TLS_FULL (-30789)
381 /** Txn has too many dirty pages */
382 #define MDB_TXN_FULL (-30788)
383 /** Cursor stack too deep - internal error */
384 #define MDB_CURSOR_FULL (-30787)
385 /** Page has not enough space - internal error */
386 #define MDB_PAGE_FULL (-30786)
387 /** Database contents grew beyond environment mapsize */
388 #define MDB_MAP_RESIZED (-30785)
389 /** MDB_INCOMPATIBLE: Operation and DB incompatible, or DB flags changed */
390 #define MDB_INCOMPATIBLE (-30784)
391 /** Invalid reuse of reader locktable slot */
392 #define MDB_BAD_RSLOT (-30783)
393 /** Transaction cannot recover - it must be aborted */
394 #define MDB_BAD_TXN (-30782)
395 /** Too big key/data, key is empty, or wrong DUPFIXED size */
396 #define MDB_BAD_VALSIZE (-30781)
397 #define MDB_LAST_ERRCODE MDB_BAD_VALSIZE
400 /** @brief Statistics for a database in the environment */
401 typedef struct MDB_stat {
402 unsigned int ms_psize; /**< Size of a database page.
403 This is currently the same for all databases. */
404 unsigned int ms_depth; /**< Depth (height) of the B-tree */
405 size_t ms_branch_pages; /**< Number of internal (non-leaf) pages */
406 size_t ms_leaf_pages; /**< Number of leaf pages */
407 size_t ms_overflow_pages; /**< Number of overflow pages */
408 size_t ms_entries; /**< Number of data items */
411 /** @brief Information about the environment */
412 typedef struct MDB_envinfo {
413 void *me_mapaddr; /**< Address of map, if fixed */
414 size_t me_mapsize; /**< Size of the data memory map */
415 size_t me_last_pgno; /**< ID of the last used page */
416 size_t me_last_txnid; /**< ID of the last committed transaction */
417 unsigned int me_maxreaders; /**< max reader slots in the environment */
418 unsigned int me_numreaders; /**< max reader slots used in the environment */
421 /** @brief Return the mdb library version information.
423 * @param[out] major if non-NULL, the library major version number is copied here
424 * @param[out] minor if non-NULL, the library minor version number is copied here
425 * @param[out] patch if non-NULL, the library patch version number is copied here
426 * @retval "version string" The library version as a string
428 char *mdb_version(int *major, int *minor, int *patch);
430 /** @brief Return a string describing a given error code.
432 * This function is a superset of the ANSI C X3.159-1989 (ANSI C) strerror(3)
433 * function. If the error code is greater than or equal to 0, then the string
434 * returned by the system function strerror(3) is returned. If the error code
435 * is less than 0, an error string corresponding to the MDB library error is
436 * returned. See @ref errors for a list of MDB-specific error codes.
437 * @param[in] err The error code
438 * @retval "error message" The description of the error
440 char *mdb_strerror(int err);
442 /** @brief Create an MDB environment handle.
444 * This function allocates memory for a #MDB_env structure. To release
445 * the allocated memory and discard the handle, call #mdb_env_close().
446 * Before the handle may be used, it must be opened using #mdb_env_open().
447 * Various other options may also need to be set before opening the handle,
448 * e.g. #mdb_env_set_mapsize(), #mdb_env_set_maxreaders(), #mdb_env_set_maxdbs(),
449 * depending on usage requirements.
450 * @param[out] env The address where the new handle will be stored
451 * @return A non-zero error value on failure and 0 on success.
453 int mdb_env_create(MDB_env **env);
455 /** @brief Open an environment handle.
457 * If this function fails, #mdb_env_close() must be called to discard the #MDB_env handle.
458 * @param[in] env An environment handle returned by #mdb_env_create()
459 * @param[in] path The directory in which the database files reside. This
460 * directory must already exist and be writable.
461 * @param[in] flags Special options for this environment. This parameter
462 * must be set to 0 or by bitwise OR'ing together one or more of the
463 * values described here.
464 * Flags set by mdb_env_set_flags() are also used.
467 * use a fixed address for the mmap region. This flag must be specified
468 * when creating the environment, and is stored persistently in the environment.
469 * If successful, the memory map will always reside at the same virtual address
470 * and pointers used to reference data items in the database will be constant
471 * across multiple invocations. This option may not always work, depending on
472 * how the operating system has allocated memory to shared libraries and other uses.
473 * The feature is highly experimental.
475 * By default, MDB creates its environment in a directory whose
476 * pathname is given in \b path, and creates its data and lock files
477 * under that directory. With this option, \b path is used as-is for
478 * the database main data file. The database lock file is the \b path
479 * with "-lock" appended.
481 * Open the environment in read-only mode. No write operations will be
482 * allowed. MDB will still modify the lock file - except on read-only
483 * filesystems, where MDB does not use locks.
485 * Use a writeable memory map unless MDB_RDONLY is set. This is faster
486 * and uses fewer mallocs, but loses protection from application bugs
487 * like wild pointer writes and other bad updates into the database.
488 * Incompatible with nested transactions.
489 * Processes with and without MDB_WRITEMAP on the same environment do
490 * not cooperate well.
491 * <li>#MDB_NOMETASYNC
492 * Flush system buffers to disk only once per transaction, omit the
493 * metadata flush. Defer that until the system flushes files to disk,
494 * or next non-MDB_RDONLY commit or #mdb_env_sync(). This optimization
495 * maintains database integrity, but a system crash may undo the last
496 * committed transaction. I.e. it preserves the ACI (atomicity,
497 * consistency, isolation) but not D (durability) database property.
498 * This flag may be changed at any time using #mdb_env_set_flags().
500 * Don't flush system buffers to disk when committing a transaction.
501 * This optimization means a system crash can corrupt the database or
502 * lose the last transactions if buffers are not yet flushed to disk.
503 * The risk is governed by how often the system flushes dirty buffers
504 * to disk and how often #mdb_env_sync() is called. However, if the
505 * filesystem preserves write order and the #MDB_WRITEMAP flag is not
506 * used, transactions exhibit ACI (atomicity, consistency, isolation)
507 * properties and only lose D (durability). I.e. database integrity
508 * is maintained, but a system crash may undo the final transactions.
509 * Note that (#MDB_NOSYNC | #MDB_WRITEMAP) leaves the system with no
510 * hint for when to write transactions to disk, unless #mdb_env_sync()
511 * is called. (#MDB_MAPASYNC | #MDB_WRITEMAP) may be preferable.
512 * This flag may be changed at any time using #mdb_env_set_flags().
514 * When using #MDB_WRITEMAP, use asynchronous flushes to disk.
515 * As with #MDB_NOSYNC, a system crash can then corrupt the
516 * database or lose the last transactions. Calling #mdb_env_sync()
517 * ensures on-disk database integrity until next commit.
518 * This flag may be changed at any time using #mdb_env_set_flags().
520 * Don't use Thread-Local Storage. Tie reader locktable slots to
521 * #MDB_txn objects instead of to threads. I.e. #mdb_txn_reset() keeps
522 * the slot reseved for the #MDB_txn object. A thread may use parallel
523 * read-only transactions. A read-only transaction may span threads if
524 * the user synchronizes its use. Applications that multiplex many
525 * user threads over individual OS threads need this option. Such an
526 * application must also serialize the write transactions in an OS
527 * thread, since MDB's write locking is unaware of the user threads.
529 * @param[in] mode The UNIX permissions to set on created files. This parameter
530 * is ignored on Windows.
531 * @return A non-zero error value on failure and 0 on success. Some possible
534 * <li>#MDB_VERSION_MISMATCH - the version of the MDB library doesn't match the
535 * version that created the database environment.
536 * <li>#MDB_INVALID - the environment file headers are corrupted.
537 * <li>ENOENT - the directory specified by the path parameter doesn't exist.
538 * <li>EACCES - the user didn't have permission to access the environment files.
539 * <li>EAGAIN - the environment was locked by another process.
542 int mdb_env_open(MDB_env *env, const char *path, unsigned int flags, mdb_mode_t mode);
544 /** @brief Copy an MDB environment to the specified path.
546 * This function may be used to make a backup of an existing environment.
547 * No lockfile is created, since it gets recreated at need.
548 * @note This call can trigger significant file size growth if run in
549 * parallel with write transactions, because it employs a read-only
550 * transaction. See long-lived transactions under @ref caveats_sec.
551 * @param[in] env An environment handle returned by #mdb_env_create(). It
552 * must have already been opened successfully.
553 * @param[in] path The directory in which the copy will reside. This
554 * directory must already exist and be writable but must otherwise be
556 * @return A non-zero error value on failure and 0 on success.
558 int mdb_env_copy(MDB_env *env, const char *path);
560 /** @brief Copy an MDB environment to the specified file descriptor.
562 * This function may be used to make a backup of an existing environment.
563 * No lockfile is created, since it gets recreated at need.
564 * @note This call can trigger significant file size growth if run in
565 * parallel with write transactions, because it employs a read-only
566 * transaction. See long-lived transactions under @ref caveats_sec.
567 * @param[in] env An environment handle returned by #mdb_env_create(). It
568 * must have already been opened successfully.
569 * @param[in] fd The filedescriptor to write the copy to. It must
570 * have already been opened for Write access.
571 * @return A non-zero error value on failure and 0 on success.
573 int mdb_env_copyfd(MDB_env *env, mdb_filehandle_t fd);
575 /** @brief Return statistics about the MDB environment.
577 * @param[in] env An environment handle returned by #mdb_env_create()
578 * @param[out] stat The address of an #MDB_stat structure
579 * where the statistics will be copied
581 int mdb_env_stat(MDB_env *env, MDB_stat *stat);
583 /** @brief Return information about the MDB environment.
585 * @param[in] env An environment handle returned by #mdb_env_create()
586 * @param[out] stat The address of an #MDB_envinfo structure
587 * where the information will be copied
589 int mdb_env_info(MDB_env *env, MDB_envinfo *stat);
591 /** @brief Flush the data buffers to disk.
593 * Data is always written to disk when #mdb_txn_commit() is called,
594 * but the operating system may keep it buffered. MDB always flushes
595 * the OS buffers upon commit as well, unless the environment was
596 * opened with #MDB_NOSYNC or in part #MDB_NOMETASYNC.
597 * @param[in] env An environment handle returned by #mdb_env_create()
598 * @param[in] force If non-zero, force a synchronous flush. Otherwise
599 * if the environment has the #MDB_NOSYNC flag set the flushes
600 * will be omitted, and with #MDB_MAPASYNC they will be asynchronous.
601 * @return A non-zero error value on failure and 0 on success. Some possible
604 * <li>EINVAL - an invalid parameter was specified.
605 * <li>EIO - an error occurred during synchronization.
608 int mdb_env_sync(MDB_env *env, int force);
610 /** @brief Close the environment and release the memory map.
612 * Only a single thread may call this function. All transactions, databases,
613 * and cursors must already be closed before calling this function. Attempts to
614 * use any such handles after calling this function will cause a SIGSEGV.
615 * The environment handle will be freed and must not be used again after this call.
616 * @param[in] env An environment handle returned by #mdb_env_create()
618 void mdb_env_close(MDB_env *env);
620 /** @brief Set environment flags.
622 * This may be used to set some flags in addition to those from
623 * #mdb_env_open(), or to unset these flags.
624 * @param[in] env An environment handle returned by #mdb_env_create()
625 * @param[in] flags The flags to change, bitwise OR'ed together
626 * @param[in] onoff A non-zero value sets the flags, zero clears them.
627 * @return A non-zero error value on failure and 0 on success. Some possible
630 * <li>EINVAL - an invalid parameter was specified.
633 int mdb_env_set_flags(MDB_env *env, unsigned int flags, int onoff);
635 /** @brief Get environment flags.
637 * @param[in] env An environment handle returned by #mdb_env_create()
638 * @param[out] flags The address of an integer to store the flags
639 * @return A non-zero error value on failure and 0 on success. Some possible
642 * <li>EINVAL - an invalid parameter was specified.
645 int mdb_env_get_flags(MDB_env *env, unsigned int *flags);
647 /** @brief Return the path that was used in #mdb_env_open().
649 * @param[in] env An environment handle returned by #mdb_env_create()
650 * @param[out] path Address of a string pointer to contain the path. This
651 * is the actual string in the environment, not a copy. It should not be
652 * altered in any way.
653 * @return A non-zero error value on failure and 0 on success. Some possible
656 * <li>EINVAL - an invalid parameter was specified.
659 int mdb_env_get_path(MDB_env *env, const char **path);
661 /** @brief Set the size of the memory map to use for this environment.
663 * The size should be a multiple of the OS page size. The default is
664 * 10485760 bytes. The size of the memory map is also the maximum size
665 * of the database. The value should be chosen as large as possible,
666 * to accommodate future growth of the database.
667 * This function should be called after #mdb_env_create() and before #mdb_env_open().
668 * It may be called at later times if no transactions are active in
669 * this process. Note that the library does not check for this condition,
670 * the caller must ensure it explicitly.
672 * If the mapsize is changed by another process, #mdb_txn_begin() will
673 * return #MDB_MAP_RESIZED. This function may be called with a size
674 * of zero to adopt the new size.
676 * Any attempt to set a size smaller than the space already consumed
677 * by the environment will be silently changed to the current size of the used space.
678 * @param[in] env An environment handle returned by #mdb_env_create()
679 * @param[in] size The size in bytes
680 * @return A non-zero error value on failure and 0 on success. Some possible
683 * <li>EINVAL - an invalid parameter was specified, or the environment has
684 * an active write transaction.
687 int mdb_env_set_mapsize(MDB_env *env, size_t size);
689 /** @brief Set the maximum number of threads/reader slots for the environment.
691 * This defines the number of slots in the lock table that is used to track readers in the
692 * the environment. The default is 126.
693 * Starting a read-only transaction normally ties a lock table slot to the
694 * current thread until the environment closes or the thread exits. If
695 * MDB_NOTLS is in use, #mdb_txn_begin() instead ties the slot to the
696 * MDB_txn object until it or the #MDB_env object is destroyed.
697 * This function may only be called after #mdb_env_create() and before #mdb_env_open().
698 * @param[in] env An environment handle returned by #mdb_env_create()
699 * @param[in] readers The maximum number of reader lock table slots
700 * @return A non-zero error value on failure and 0 on success. Some possible
703 * <li>EINVAL - an invalid parameter was specified, or the environment is already open.
706 int mdb_env_set_maxreaders(MDB_env *env, unsigned int readers);
708 /** @brief Get the maximum number of threads/reader slots for the environment.
710 * @param[in] env An environment handle returned by #mdb_env_create()
711 * @param[out] readers Address of an integer to store the number of readers
712 * @return A non-zero error value on failure and 0 on success. Some possible
715 * <li>EINVAL - an invalid parameter was specified.
718 int mdb_env_get_maxreaders(MDB_env *env, unsigned int *readers);
720 /** @brief Set the maximum number of named databases for the environment.
722 * This function is only needed if multiple databases will be used in the
723 * environment. Simpler applications that use the environment as a single
724 * unnamed database can ignore this option.
725 * This function may only be called after #mdb_env_create() and before #mdb_env_open().
726 * @param[in] env An environment handle returned by #mdb_env_create()
727 * @param[in] dbs The maximum number of databases
728 * @return A non-zero error value on failure and 0 on success. Some possible
731 * <li>EINVAL - an invalid parameter was specified, or the environment is already open.
734 int mdb_env_set_maxdbs(MDB_env *env, MDB_dbi dbs);
736 /** @brief Get the maximum size of a key for the environment.
738 * This is the compile-time constant #MDB_MAXKEYSIZE, default 511.
740 * @param[in] env An environment handle returned by #mdb_env_create()
741 * @return The maximum size of a key
743 int mdb_env_get_maxkeysize(MDB_env *env);
745 /** @brief Create a transaction for use with the environment.
747 * The transaction handle may be discarded using #mdb_txn_abort() or #mdb_txn_commit().
748 * @note A transaction and its cursors must only be used by a single
749 * thread, and a thread may only have a single transaction at a time.
750 * If #MDB_NOTLS is in use, this does not apply to read-only transactions.
751 * @note Cursors may not span transactions.
752 * @param[in] env An environment handle returned by #mdb_env_create()
753 * @param[in] parent If this parameter is non-NULL, the new transaction
754 * will be a nested transaction, with the transaction indicated by \b parent
755 * as its parent. Transactions may be nested to any level. A parent
756 * transaction and its cursors may not issue any other operations than
757 * mdb_txn_commit and mdb_txn_abort while it has active child transactions.
758 * @param[in] flags Special options for this transaction. This parameter
759 * must be set to 0 or by bitwise OR'ing together one or more of the
760 * values described here.
763 * This transaction will not perform any write operations.
765 * @param[out] txn Address where the new #MDB_txn handle will be stored
766 * @return A non-zero error value on failure and 0 on success. Some possible
769 * <li>#MDB_PANIC - a fatal error occurred earlier and the environment
771 * <li>#MDB_MAP_RESIZED - another process wrote data beyond this MDB_env's
772 * mapsize and this environment's map must be resized as well.
773 * See #mdb_env_set_mapsize().
774 * <li>#MDB_READERS_FULL - a read-only transaction was requested and
775 * the reader lock table is full. See #mdb_env_set_maxreaders().
776 * <li>ENOMEM - out of memory.
779 int mdb_txn_begin(MDB_env *env, MDB_txn *parent, unsigned int flags, MDB_txn **txn);
781 /** @brief Returns the transaction's #MDB_env
783 * @param[in] txn A transaction handle returned by #mdb_txn_begin()
785 MDB_env *mdb_txn_env(MDB_txn *txn);
787 /** @brief Commit all the operations of a transaction into the database.
789 * The transaction handle is freed. It and its cursors must not be used
790 * again after this call, except with #mdb_cursor_renew().
791 * @note Earlier documentation incorrectly said all cursors would be freed.
792 * Only write-transactions free cursors.
793 * @param[in] txn A transaction handle returned by #mdb_txn_begin()
794 * @return A non-zero error value on failure and 0 on success. Some possible
797 * <li>EINVAL - an invalid parameter was specified.
798 * <li>ENOSPC - no more disk space.
799 * <li>EIO - a low-level I/O error occurred while writing.
800 * <li>ENOMEM - out of memory.
803 int mdb_txn_commit(MDB_txn *txn);
805 /** @brief Abandon all the operations of the transaction instead of saving them.
807 * The transaction handle is freed. It and its cursors must not be used
808 * again after this call, except with #mdb_cursor_renew().
809 * @note Earlier documentation incorrectly said all cursors would be freed.
810 * Only write-transactions free cursors.
811 * @param[in] txn A transaction handle returned by #mdb_txn_begin()
813 void mdb_txn_abort(MDB_txn *txn);
815 /** @brief Reset a read-only transaction.
817 * Abort the transaction like #mdb_txn_abort(), but keep the transaction
818 * handle. #mdb_txn_renew() may reuse the handle. This saves allocation
819 * overhead if the process will start a new read-only transaction soon,
820 * and also locking overhead if #MDB_NOTLS is in use. The reader table
821 * lock is released, but the table slot stays tied to its thread or
822 * #MDB_txn. Use mdb_txn_abort() to discard a reset handle, and to free
823 * its lock table slot if MDB_NOTLS is in use.
824 * Cursors opened within the transaction must not be used
825 * again after this call, except with #mdb_cursor_renew().
826 * Reader locks generally don't interfere with writers, but they keep old
827 * versions of database pages allocated. Thus they prevent the old pages
828 * from being reused when writers commit new data, and so under heavy load
829 * the database size may grow much more rapidly than otherwise.
830 * @param[in] txn A transaction handle returned by #mdb_txn_begin()
832 void mdb_txn_reset(MDB_txn *txn);
834 /** @brief Renew a read-only transaction.
836 * This acquires a new reader lock for a transaction handle that had been
837 * released by #mdb_txn_reset(). It must be called before a reset transaction
839 * @param[in] txn A transaction handle returned by #mdb_txn_begin()
840 * @return A non-zero error value on failure and 0 on success. Some possible
843 * <li>#MDB_PANIC - a fatal error occurred earlier and the environment
845 * <li>EINVAL - an invalid parameter was specified.
848 int mdb_txn_renew(MDB_txn *txn);
850 /** Compat with version <= 0.9.4, avoid clash with libmdb from MDB Tools project */
851 #define mdb_open(txn,name,flags,dbi) mdb_dbi_open(txn,name,flags,dbi)
852 /** Compat with version <= 0.9.4, avoid clash with libmdb from MDB Tools project */
853 #define mdb_close(env,dbi) mdb_dbi_close(env,dbi)
855 /** @brief Open a database in the environment.
857 * A database handle denotes the name and parameters of a database,
858 * independently of whether such a database exists.
859 * The database handle may be discarded by calling #mdb_dbi_close().
860 * The old database handle is returned if the database was already open.
861 * The handle must only be closed once.
862 * The database handle will be private to the current transaction until
863 * the transaction is successfully committed. If the transaction is
864 * aborted the handle will be closed automatically.
865 * After a successful commit the
866 * handle will reside in the shared environment, and may be used
867 * by other transactions. This function must not be called from
868 * multiple concurrent transactions. A transaction that uses this function
869 * must finish (either commit or abort) before any other transaction may
872 * To use named databases (with name != NULL), #mdb_env_set_maxdbs()
873 * must be called before opening the environment.
874 * @param[in] txn A transaction handle returned by #mdb_txn_begin()
875 * @param[in] name The name of the database to open. If only a single
876 * database is needed in the environment, this value may be NULL.
877 * @param[in] flags Special options for this database. This parameter
878 * must be set to 0 or by bitwise OR'ing together one or more of the
879 * values described here.
881 * <li>#MDB_REVERSEKEY
882 * Keys are strings to be compared in reverse order, from the end
883 * of the strings to the beginning. By default, Keys are treated as strings and
884 * compared from beginning to end.
886 * Duplicate keys may be used in the database. (Or, from another perspective,
887 * keys may have multiple data items, stored in sorted order.) By default
888 * keys must be unique and may have only a single data item.
889 * <li>#MDB_INTEGERKEY
890 * Keys are binary integers in native byte order. Setting this option
891 * requires all keys to be the same size, typically sizeof(int)
894 * This flag may only be used in combination with #MDB_DUPSORT. This option
895 * tells the library that the data items for this database are all the same
896 * size, which allows further optimizations in storage and retrieval. When
897 * all data items are the same size, the #MDB_GET_MULTIPLE and #MDB_NEXT_MULTIPLE
898 * cursor operations may be used to retrieve multiple items at once.
899 * <li>#MDB_INTEGERDUP
900 * This option specifies that duplicate data items are also integers, and
901 * should be sorted as such.
902 * <li>#MDB_REVERSEDUP
903 * This option specifies that duplicate data items should be compared as
904 * strings in reverse order.
906 * Create the named database if it doesn't exist. This option is not
907 * allowed in a read-only transaction or a read-only environment.
909 * @param[out] dbi Address where the new #MDB_dbi handle will be stored
910 * @return A non-zero error value on failure and 0 on success. Some possible
913 * <li>#MDB_NOTFOUND - the specified database doesn't exist in the environment
914 * and #MDB_CREATE was not specified.
915 * <li>#MDB_DBS_FULL - too many databases have been opened. See #mdb_env_set_maxdbs().
918 int mdb_dbi_open(MDB_txn *txn, const char *name, unsigned int flags, MDB_dbi *dbi);
920 /** @brief Retrieve statistics for a database.
922 * @param[in] txn A transaction handle returned by #mdb_txn_begin()
923 * @param[in] dbi A database handle returned by #mdb_dbi_open()
924 * @param[out] stat The address of an #MDB_stat structure
925 * where the statistics will be copied
926 * @return A non-zero error value on failure and 0 on success. Some possible
929 * <li>EINVAL - an invalid parameter was specified.
932 int mdb_stat(MDB_txn *txn, MDB_dbi dbi, MDB_stat *stat);
934 /** @brief Retrieve the DB flags for a database handle.
936 * @param[in] txn A transaction handle returned by #mdb_txn_begin()
937 * @param[in] dbi A database handle returned by #mdb_dbi_open()
938 * @param[out] flags Address where the flags will be returned.
939 * @return A non-zero error value on failure and 0 on success.
941 int mdb_dbi_flags(MDB_txn *txn, MDB_dbi dbi, unsigned int *flags);
943 /** @brief Close a database handle.
945 * This call is not mutex protected. Handles should only be closed by
946 * a single thread, and only if no other threads are going to reference
947 * the database handle or one of its cursors any further. Do not close
948 * a handle if an existing transaction has modified its database.
949 * @param[in] env An environment handle returned by #mdb_env_create()
950 * @param[in] dbi A database handle returned by #mdb_dbi_open()
952 void mdb_dbi_close(MDB_env *env, MDB_dbi dbi);
954 /** @brief Empty or delete+close a database.
956 * @param[in] txn A transaction handle returned by #mdb_txn_begin()
957 * @param[in] dbi A database handle returned by #mdb_dbi_open()
958 * @param[in] del 0 to empty the DB, 1 to delete it from the
959 * environment and close the DB handle.
960 * @return A non-zero error value on failure and 0 on success.
962 int mdb_drop(MDB_txn *txn, MDB_dbi dbi, int del);
964 /** @brief Set a custom key comparison function for a database.
966 * The comparison function is called whenever it is necessary to compare a
967 * key specified by the application with a key currently stored in the database.
968 * If no comparison function is specified, and no special key flags were specified
969 * with #mdb_dbi_open(), the keys are compared lexically, with shorter keys collating
970 * before longer keys.
971 * @warning This function must be called before any data access functions are used,
972 * otherwise data corruption may occur. The same comparison function must be used by every
973 * program accessing the database, every time the database is used.
974 * @param[in] txn A transaction handle returned by #mdb_txn_begin()
975 * @param[in] dbi A database handle returned by #mdb_dbi_open()
976 * @param[in] cmp A #MDB_cmp_func function
977 * @return A non-zero error value on failure and 0 on success. Some possible
980 * <li>EINVAL - an invalid parameter was specified.
983 int mdb_set_compare(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp);
985 /** @brief Set a custom data comparison function for a #MDB_DUPSORT database.
987 * This comparison function is called whenever it is necessary to compare a data
988 * item specified by the application with a data item currently stored in the database.
989 * This function only takes effect if the database was opened with the #MDB_DUPSORT
991 * If no comparison function is specified, and no special key flags were specified
992 * with #mdb_dbi_open(), the data items are compared lexically, with shorter items collating
993 * before longer items.
994 * @warning This function must be called before any data access functions are used,
995 * otherwise data corruption may occur. The same comparison function must be used by every
996 * program accessing the database, every time the database is used.
997 * @param[in] txn A transaction handle returned by #mdb_txn_begin()
998 * @param[in] dbi A database handle returned by #mdb_dbi_open()
999 * @param[in] cmp A #MDB_cmp_func function
1000 * @return A non-zero error value on failure and 0 on success. Some possible
1003 * <li>EINVAL - an invalid parameter was specified.
1006 int mdb_set_dupsort(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp);
1008 /** @brief Set a relocation function for a #MDB_FIXEDMAP database.
1010 * @todo The relocation function is called whenever it is necessary to move the data
1011 * of an item to a different position in the database (e.g. through tree
1012 * balancing operations, shifts as a result of adds or deletes, etc.). It is
1013 * intended to allow address/position-dependent data items to be stored in
1014 * a database in an environment opened with the #MDB_FIXEDMAP option.
1015 * Currently the relocation feature is unimplemented and setting
1016 * this function has no effect.
1017 * @param[in] txn A transaction handle returned by #mdb_txn_begin()
1018 * @param[in] dbi A database handle returned by #mdb_dbi_open()
1019 * @param[in] rel A #MDB_rel_func function
1020 * @return A non-zero error value on failure and 0 on success. Some possible
1023 * <li>EINVAL - an invalid parameter was specified.
1026 int mdb_set_relfunc(MDB_txn *txn, MDB_dbi dbi, MDB_rel_func *rel);
1028 /** @brief Set a context pointer for a #MDB_FIXEDMAP database's relocation function.
1030 * See #mdb_set_relfunc and #MDB_rel_func for more details.
1031 * @param[in] txn A transaction handle returned by #mdb_txn_begin()
1032 * @param[in] dbi A database handle returned by #mdb_dbi_open()
1033 * @param[in] ctx An arbitrary pointer for whatever the application needs.
1034 * It will be passed to the callback function set by #mdb_set_relfunc
1035 * as its \b relctx parameter whenever the callback is invoked.
1036 * @return A non-zero error value on failure and 0 on success. Some possible
1039 * <li>EINVAL - an invalid parameter was specified.
1042 int mdb_set_relctx(MDB_txn *txn, MDB_dbi dbi, void *ctx);
1044 /** @brief Get items from a database.
1046 * This function retrieves key/data pairs from the database. The address
1047 * and length of the data associated with the specified \b key are returned
1048 * in the structure to which \b data refers.
1049 * If the database supports duplicate keys (#MDB_DUPSORT) then the
1050 * first data item for the key will be returned. Retrieval of other
1051 * items requires the use of #mdb_cursor_get().
1053 * @note The memory pointed to by the returned values is owned by the
1054 * database. The caller need not dispose of the memory, and may not
1055 * modify it in any way. For values returned in a read-only transaction
1056 * any modification attempts will cause a SIGSEGV.
1057 * @note Values returned from the database are valid only until a
1058 * subsequent update operation, or the end of the transaction.
1059 * @param[in] txn A transaction handle returned by #mdb_txn_begin()
1060 * @param[in] dbi A database handle returned by #mdb_dbi_open()
1061 * @param[in] key The key to search for in the database
1062 * @param[out] data The data corresponding to the key
1063 * @return A non-zero error value on failure and 0 on success. Some possible
1066 * <li>#MDB_NOTFOUND - the key was not in the database.
1067 * <li>EINVAL - an invalid parameter was specified.
1070 int mdb_get(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data);
1072 /** @brief Store items into a database.
1074 * This function stores key/data pairs in the database. The default behavior
1075 * is to enter the new key/data pair, replacing any previously existing key
1076 * if duplicates are disallowed, or adding a duplicate data item if
1077 * duplicates are allowed (#MDB_DUPSORT).
1078 * @param[in] txn A transaction handle returned by #mdb_txn_begin()
1079 * @param[in] dbi A database handle returned by #mdb_dbi_open()
1080 * @param[in] key The key to store in the database
1081 * @param[in,out] data The data to store
1082 * @param[in] flags Special options for this operation. This parameter
1083 * must be set to 0 or by bitwise OR'ing together one or more of the
1084 * values described here.
1086 * <li>#MDB_NODUPDATA - enter the new key/data pair only if it does not
1087 * already appear in the database. This flag may only be specified
1088 * if the database was opened with #MDB_DUPSORT. The function will
1089 * return #MDB_KEYEXIST if the key/data pair already appears in the
1091 * <li>#MDB_NOOVERWRITE - enter the new key/data pair only if the key
1092 * does not already appear in the database. The function will return
1093 * #MDB_KEYEXIST if the key already appears in the database, even if
1094 * the database supports duplicates (#MDB_DUPSORT). The \b data
1095 * parameter will be set to point to the existing item.
1096 * <li>#MDB_RESERVE - reserve space for data of the given size, but
1097 * don't copy the given data. Instead, return a pointer to the
1098 * reserved space, which the caller can fill in later - before
1099 * the next update operation or the transaction ends. This saves
1100 * an extra memcpy if the data is being generated later.
1101 * <li>#MDB_APPEND - append the given key/data pair to the end of the
1102 * database. No key comparisons are performed. This option allows
1103 * fast bulk loading when keys are already known to be in the
1104 * correct order. Loading unsorted keys with this flag will cause
1106 * <li>#MDB_APPENDDUP - as above, but for sorted dup data.
1108 * @return A non-zero error value on failure and 0 on success. Some possible
1111 * <li>#MDB_MAP_FULL - the database is full, see #mdb_env_set_mapsize().
1112 * <li>#MDB_TXN_FULL - the transaction has too many dirty pages.
1113 * <li>EACCES - an attempt was made to write in a read-only transaction.
1114 * <li>EINVAL - an invalid parameter was specified.
1117 int mdb_put(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data,
1118 unsigned int flags);
1120 /** @brief Delete items from a database.
1122 * This function removes key/data pairs from the database.
1123 * If the database does not support sorted duplicate data items
1124 * (#MDB_DUPSORT) the data parameter is ignored.
1125 * If the database supports sorted duplicates and the data parameter
1126 * is NULL, all of the duplicate data items for the key will be
1127 * deleted. Otherwise, if the data parameter is non-NULL
1128 * only the matching data item will be deleted.
1129 * This function will return #MDB_NOTFOUND if the specified key/data
1130 * pair is not in the database.
1131 * @param[in] txn A transaction handle returned by #mdb_txn_begin()
1132 * @param[in] dbi A database handle returned by #mdb_dbi_open()
1133 * @param[in] key The key to delete from the database
1134 * @param[in] data The data to delete
1135 * @return A non-zero error value on failure and 0 on success. Some possible
1138 * <li>EACCES - an attempt was made to write in a read-only transaction.
1139 * <li>EINVAL - an invalid parameter was specified.
1142 int mdb_del(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data);
1144 /** @brief Create a cursor handle.
1146 * A cursor is associated with a specific transaction and database.
1147 * A cursor cannot be used when its database handle is closed. Nor
1148 * when its transaction has ended, except with #mdb_cursor_renew().
1149 * It can be discarded with #mdb_cursor_close().
1150 * A cursor in a write-transaction can be closed before its transaction
1151 * ends, and will otherwise be closed when its transaction ends.
1152 * A cursor in a read-only transaction must be closed explicitly, before
1153 * or after its transaction ends. It can be reused with
1154 * #mdb_cursor_renew() before finally closing it.
1155 * @note Earlier documentation said that cursors in every transaction
1156 * were closed when the transaction committed or aborted.
1157 * @param[in] txn A transaction handle returned by #mdb_txn_begin()
1158 * @param[in] dbi A database handle returned by #mdb_dbi_open()
1159 * @param[out] cursor Address where the new #MDB_cursor handle will be stored
1160 * @return A non-zero error value on failure and 0 on success. Some possible
1163 * <li>EINVAL - an invalid parameter was specified.
1166 int mdb_cursor_open(MDB_txn *txn, MDB_dbi dbi, MDB_cursor **cursor);
1168 /** @brief Close a cursor handle.
1170 * The cursor handle will be freed and must not be used again after this call.
1171 * Its transaction must still be live if it is a write-transaction.
1172 * @param[in] cursor A cursor handle returned by #mdb_cursor_open()
1174 void mdb_cursor_close(MDB_cursor *cursor);
1176 /** @brief Renew a cursor handle.
1178 * A cursor is associated with a specific transaction and database.
1179 * Cursors that are only used in read-only
1180 * transactions may be re-used, to avoid unnecessary malloc/free overhead.
1181 * The cursor may be associated with a new read-only transaction, and
1182 * referencing the same database handle as it was created with.
1183 * This may be done whether the previous transaction is live or dead.
1184 * @param[in] txn A transaction handle returned by #mdb_txn_begin()
1185 * @param[in] cursor A cursor handle returned by #mdb_cursor_open()
1186 * @return A non-zero error value on failure and 0 on success. Some possible
1189 * <li>EINVAL - an invalid parameter was specified.
1192 int mdb_cursor_renew(MDB_txn *txn, MDB_cursor *cursor);
1194 /** @brief Return the cursor's transaction handle.
1196 * @param[in] cursor A cursor handle returned by #mdb_cursor_open()
1198 MDB_txn *mdb_cursor_txn(MDB_cursor *cursor);
1200 /** @brief Return the cursor's database handle.
1202 * @param[in] cursor A cursor handle returned by #mdb_cursor_open()
1204 MDB_dbi mdb_cursor_dbi(MDB_cursor *cursor);
1206 /** @brief Retrieve by cursor.
1208 * This function retrieves key/data pairs from the database. The address and length
1209 * of the key are returned in the object to which \b key refers (except for the
1210 * case of the #MDB_SET option, in which the \b key object is unchanged), and
1211 * the address and length of the data are returned in the object to which \b data
1213 * See #mdb_get() for restrictions on using the output values.
1214 * @param[in] cursor A cursor handle returned by #mdb_cursor_open()
1215 * @param[in,out] key The key for a retrieved item
1216 * @param[in,out] data The data of a retrieved item
1217 * @param[in] op A cursor operation #MDB_cursor_op
1218 * @return A non-zero error value on failure and 0 on success. Some possible
1221 * <li>#MDB_NOTFOUND - no matching key found.
1222 * <li>EINVAL - an invalid parameter was specified.
1225 int mdb_cursor_get(MDB_cursor *cursor, MDB_val *key, MDB_val *data,
1228 /** @brief Store by cursor.
1230 * This function stores key/data pairs into the database.
1231 * If the function fails for any reason, the state of the cursor will be
1232 * unchanged. If the function succeeds and an item is inserted into the
1233 * database, the cursor is always positioned to refer to the newly inserted item.
1234 * @param[in] cursor A cursor handle returned by #mdb_cursor_open()
1235 * @param[in] key The key operated on.
1236 * @param[in] data The data operated on.
1237 * @param[in] flags Options for this operation. This parameter
1238 * must be set to 0 or one of the values described here.
1240 * <li>#MDB_CURRENT - overwrite the data of the key/data pair to which
1241 * the cursor refers with the specified data item. The \b key
1242 * parameter is ignored.
1243 * <li>#MDB_NODUPDATA - enter the new key/data pair only if it does not
1244 * already appear in the database. This flag may only be specified
1245 * if the database was opened with #MDB_DUPSORT. The function will
1246 * return #MDB_KEYEXIST if the key/data pair already appears in the
1248 * <li>#MDB_NOOVERWRITE - enter the new key/data pair only if the key
1249 * does not already appear in the database. The function will return
1250 * #MDB_KEYEXIST if the key already appears in the database, even if
1251 * the database supports duplicates (#MDB_DUPSORT).
1252 * <li>#MDB_RESERVE - reserve space for data of the given size, but
1253 * don't copy the given data. Instead, return a pointer to the
1254 * reserved space, which the caller can fill in later. This saves
1255 * an extra memcpy if the data is being generated later.
1256 * <li>#MDB_APPEND - append the given key/data pair to the end of the
1257 * database. No key comparisons are performed. This option allows
1258 * fast bulk loading when keys are already known to be in the
1259 * correct order. Loading unsorted keys with this flag will cause
1261 * <li>#MDB_APPENDDUP - as above, but for sorted dup data.
1262 * <li>#MDB_MULTIPLE - store multiple contiguous data elements in a
1263 * single request. This flag may only be specified if the database
1264 * was opened with #MDB_DUPFIXED. The \b data argument must be an
1265 * array of two MDB_vals. The mv_size of the first MDB_val must be
1266 * the size of a single data element. The mv_data of the first MDB_val
1267 * must point to the beginning of the array of contiguous data elements.
1268 * The mv_size of the second MDB_val must be the count of the number
1269 * of data elements to store. On return this field will be set to
1270 * the count of the number of elements actually written. The mv_data
1271 * of the second MDB_val is unused.
1273 * @return A non-zero error value on failure and 0 on success. Some possible
1276 * <li>#MDB_MAP_FULL - the database is full, see #mdb_env_set_mapsize().
1277 * <li>#MDB_TXN_FULL - the transaction has too many dirty pages.
1278 * <li>EACCES - an attempt was made to modify a read-only database.
1279 * <li>EINVAL - an invalid parameter was specified.
1282 int mdb_cursor_put(MDB_cursor *cursor, MDB_val *key, MDB_val *data,
1283 unsigned int flags);
1285 /** @brief Delete current key/data pair
1287 * This function deletes the key/data pair to which the cursor refers.
1288 * @param[in] cursor A cursor handle returned by #mdb_cursor_open()
1289 * @param[in] flags Options for this operation. This parameter
1290 * must be set to 0 or one of the values described here.
1292 * <li>#MDB_NODUPDATA - delete all of the data items for the current key.
1293 * This flag may only be specified if the database was opened with #MDB_DUPSORT.
1295 * @return A non-zero error value on failure and 0 on success. Some possible
1298 * <li>EACCES - an attempt was made to modify a read-only database.
1299 * <li>EINVAL - an invalid parameter was specified.
1302 int mdb_cursor_del(MDB_cursor *cursor, unsigned int flags);
1304 /** @brief Return count of duplicates for current key.
1306 * This call is only valid on databases that support sorted duplicate
1307 * data items #MDB_DUPSORT.
1308 * @param[in] cursor A cursor handle returned by #mdb_cursor_open()
1309 * @param[out] countp Address where the count will be stored
1310 * @return A non-zero error value on failure and 0 on success. Some possible
1313 * <li>EINVAL - cursor is not initialized, or an invalid parameter was specified.
1316 int mdb_cursor_count(MDB_cursor *cursor, size_t *countp);
1318 /** @brief Compare two data items according to a particular database.
1320 * This returns a comparison as if the two data items were keys in the
1321 * specified database.
1322 * @param[in] txn A transaction handle returned by #mdb_txn_begin()
1323 * @param[in] dbi A database handle returned by #mdb_dbi_open()
1324 * @param[in] a The first item to compare
1325 * @param[in] b The second item to compare
1326 * @return < 0 if a < b, 0 if a == b, > 0 if a > b
1328 int mdb_cmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b);
1330 /** @brief Compare two data items according to a particular database.
1332 * This returns a comparison as if the two items were data items of
1333 * the specified database. The database must have the #MDB_DUPSORT flag.
1334 * @param[in] txn A transaction handle returned by #mdb_txn_begin()
1335 * @param[in] dbi A database handle returned by #mdb_dbi_open()
1336 * @param[in] a The first item to compare
1337 * @param[in] b The second item to compare
1338 * @return < 0 if a < b, 0 if a == b, > 0 if a > b
1340 int mdb_dcmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b);
1342 /** @brief A callback function used to print a message from the library.
1344 * @param[in] msg The string to be printed.
1345 * @param[in] ctx An arbitrary context pointer for the callback.
1346 * @return < 0 on failure, 0 on success.
1348 typedef int (MDB_msg_func)(const char *msg, void *ctx);
1350 /** @brief Dump the entries in the reader lock table.
1352 * @param[in] env An environment handle returned by #mdb_env_create()
1353 * @param[in] func A #MDB_msg_func function
1354 * @param[in] ctx Anything the message function needs
1355 * @return < 0 on failure, 0 on success.
1357 int mdb_reader_list(MDB_env *env, MDB_msg_func *func, void *ctx);
1359 /** @brief Check for stale entries in the reader lock table.
1361 * @param[in] env An environment handle returned by #mdb_env_create()
1362 * @param[out] dead Number of stale slots that were cleared
1363 * @return 0 on success, non-zero on failure.
1365 int mdb_reader_check(MDB_env *env, int *dead);
1371 #endif /* _LMDB_H_ */