]> git.sur5r.net Git - openldap/blob - libraries/libmdb/mdb.h
739fee7265eb43303c72d5d072e8486f6195b2ef
[openldap] / libraries / libmdb / mdb.h
1 /** @file mdb.h
2  *      @brief memory-mapped database library
3  *
4  *      @mainpage       MDB Memory-Mapped Database Manager
5  *      MDB is a Btree-based database management library modeled loosely on the
6  *      BerkeleyDB API, but much simplified. The entire database is exposed
7  *      in a memory map, and all data fetches return data directly
8  *      from the mapped memory, so no malloc's or memcpy's occur during
9  *      data fetches. As such, the library is extremely simple because it
10  *      requires no page caching layer of its own, and it is extremely high
11  *      performance and memory-efficient. It is also fully transactional with
12  *      full ACID semantics, and when the memory map is read-only, the
13  *      database integrity cannot be corrupted by stray pointer writes from
14  *      application code.
15  *
16  *      The library is fully thread-aware and supports concurrent read/write
17  *      access from multiple processes and threads. Data pages use a copy-on-
18  *      write strategy so no active data pages are ever overwritten, which
19  *      also provides resistance to corruption and eliminates the need of any
20  *      special recovery procedures after a system crash. Writes are fully
21  *      serialized; only one write transaction may be active at a time, which
22  *      guarantees that writers can never deadlock. The database structure is
23  *      multi-versioned so readers run with no locks; writers cannot block
24  *      readers, and readers don't block writers.
25  *
26  *      Unlike other well-known database mechanisms which use either write-ahead
27  *      transaction logs or append-only data writes, MDB requires no maintenance
28  *      during operation. Both write-ahead loggers and append-only databases
29  *      require periodic checkpointing and/or compaction of their log or database
30  *      files otherwise they grow without bound. MDB tracks free pages within
31  *      the database and re-uses them for new write operations, so the database
32  *      size does not grow without bound in normal use.
33  *
34  *      The memory map can be used as a read-only or read-write map. It is
35  *      read-only by default as this provides total immunity to corruption.
36  *      Using read-write mode offers much higher write performance, but adds
37  *      the possibility for stray application writes thru pointers to silently
38  *      corrupt the database. Of course if your application code is known to
39  *      be bug-free (...) then this is not an issue.
40  *
41  *      Troubleshooting the lock file, plus semaphores on BSD systems:
42  *
43  *      - A broken lockfile can cause sync issues.
44  *        Stale reader transactions left behind by an aborted program
45  *        cause further writes to grow the database quickly, and
46  *        stale locks can block further operation.
47  *
48  *        Fix: Terminate all programs using the database, or make
49  *        them close it.  Next database user will reset the lockfile.
50  *
51  *      - On BSD systems or others configured with MDB_USE_POSIX_SEM,
52  *        startup can fail due to semaphores owned by another userid.
53  *
54  *        Fix: Open and close the database as the user which owns the
55  *        semaphores (likely last user) or as root, while no other
56  *        process is using the database.
57  *
58  *      Restrictions/caveats (in addition to those listed for some functions):
59  *
60  *      - Only the database owner should normally use the database on
61  *        BSD systems or when otherwise configured with MDB_USE_POSIX_SEM.
62  *        Multiple users can cause startup to fail later, as noted above.
63  *
64  *      - A thread can only use one transaction at a time, plus any child
65  *        transactions.  Each transaction belongs to one thread.  See below.
66  *
67  *      - Use an MDB_env* in the process which opened it, without fork()ing.
68  *
69  *      - Do not have open an MDB database twice in the same process at
70  *        the same time.  Not even from a plain open() call - close()ing it
71  *        breaks flock() advisory locking.
72  *
73  *      - Avoid long-lived transactions.  Read transactions prevent
74  *        reuse of pages freed by newer write transactions, thus the
75  *        database can grow quickly.  Write transactions prevent
76  *        other write transactions, since writes are serialized.
77  *
78  *      ...when several processes can use a database concurrently:
79  *
80  *      - Avoid suspending a process with active transactions.  These
81  *        would then be "long-lived" as above.
82  *
83  *      - Avoid aborting a process with an active transaction.
84  *        The transaction becomes "long-lived" as above until the lockfile
85  *        is reset, since the process may not remove it from the lockfile.
86  *
87  *      - If you do that anyway, close the environment once in a while,
88  *        so the lockfile can get reset.
89  *
90  *      - Do not use MDB databases on remote filesystems, even between
91  *        processes on the same host.  This breaks flock() on some OSes,
92  *        possibly memory map sync, and certainly sync between programs
93  *        on different hosts.
94  *
95  *      - Opening a database can fail if another process is opening or
96  *        closing it at exactly the same time.
97  *
98  *      @author Howard Chu, Symas Corporation.
99  *
100  *      @copyright Copyright 2011-2012 Howard Chu, Symas Corp. All rights reserved.
101  *
102  * Redistribution and use in source and binary forms, with or without
103  * modification, are permitted only as authorized by the OpenLDAP
104  * Public License.
105  *
106  * A copy of this license is available in the file LICENSE in the
107  * top-level directory of the distribution or, alternatively, at
108  * <http://www.OpenLDAP.org/license.html>.
109  *
110  *      @par Derived From:
111  * This code is derived from btree.c written by Martin Hedenfalk.
112  *
113  * Copyright (c) 2009, 2010 Martin Hedenfalk <martin@bzero.se>
114  *
115  * Permission to use, copy, modify, and distribute this software for any
116  * purpose with or without fee is hereby granted, provided that the above
117  * copyright notice and this permission notice appear in all copies.
118  *
119  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
120  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
121  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
122  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
123  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
124  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
125  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
126  */
127 #ifndef _MDB_H_
128 #define _MDB_H_
129
130 #include <sys/types.h>
131
132 #ifdef __cplusplus
133 extern "C" {
134 #endif
135
136 /** @defgroup public Public API
137  *      @{
138  */
139 /** @defgroup Version Version Macros
140  *      @{
141  */
142 /** Library major version */
143 #define MDB_VERSION_MAJOR       0
144 /** Library minor version */
145 #define MDB_VERSION_MINOR       9
146 /** Library patch version */
147 #define MDB_VERSION_PATCH       4
148
149 /** Combine args a,b,c into a single integer for easy version comparisons */
150 #define MDB_VERINT(a,b,c)       (((a) << 24) | ((b) << 16) | (c))
151
152 /** The full library version as a single integer */
153 #define MDB_VERSION_FULL        \
154         MDB_VERINT(MDB_VERSION_MAJOR,MDB_VERSION_MINOR,MDB_VERSION_PATCH)
155
156 /** The release date of this library version */
157 #define MDB_VERSION_DATE        "September 14, 2012"
158
159 /** A stringifier for the version info */
160 #define MDB_VERSTR(a,b,c,d)     "MDB " #a "." #b "." #c ": (" d ")"
161
162 /** A helper for the stringifier macro */
163 #define MDB_VERFOO(a,b,c,d)     MDB_VERSTR(a,b,c,d)
164
165 /** The full library version as a C string */
166 #define MDB_VERSION_STRING      \
167         MDB_VERFOO(MDB_VERSION_MAJOR,MDB_VERSION_MINOR,MDB_VERSION_PATCH,MDB_VERSION_DATE)
168 /**     @} */
169
170 /** @brief Opaque structure for a database environment.
171  *
172  * A DB environment supports multiple databases, all residing in the same
173  * shared-memory map.
174  */
175 typedef struct MDB_env MDB_env;
176
177 /** @brief Opaque structure for a transaction handle.
178  *
179  * All database operations require a transaction handle. Transactions may be
180  * read-only or read-write.
181  */
182 typedef struct MDB_txn MDB_txn;
183
184 /** @brief A handle for an individual database in the DB environment. */
185 typedef unsigned int    MDB_dbi;
186
187 /** @brief Opaque structure for navigating through a database */
188 typedef struct MDB_cursor MDB_cursor;
189
190 /** @brief Generic structure used for passing keys and data in and out of the database. */
191 typedef struct MDB_val {
192         size_t           mv_size;       /**< size of the data item */
193         void            *mv_data;       /**< address of the data item */
194 } MDB_val;
195
196 /** @brief A callback function used to compare two keys in a database */
197 typedef int  (MDB_cmp_func)(const MDB_val *a, const MDB_val *b);
198
199 /** @brief A callback function used to relocate a position-dependent data item
200  * in a fixed-address database.
201  *
202  * The \b newptr gives the item's desired address in
203  * the memory map, and \b oldptr gives its previous address. The item's actual
204  * data resides at the address in \b item.  This callback is expected to walk
205  * through the fields of the record in \b item and modify any
206  * values based at the \b oldptr address to be relative to the \b newptr address.
207  * @param[in,out] item The item that is to be relocated.
208  * @param[in] oldptr The previous address.
209  * @param[in] newptr The new address to relocate to.
210  * @param[in] relctx An application-provided context, set by #mdb_set_relctx().
211  * @todo This feature is currently unimplemented.
212  */
213 typedef void (MDB_rel_func)(MDB_val *item, void *oldptr, void *newptr, void *relctx);
214
215 /** @defgroup   mdb_env Environment Flags
216  *      @{
217  */
218         /** mmap at a fixed address */
219 #define MDB_FIXEDMAP    0x01
220         /** no environment directory */
221 #define MDB_NOSUBDIR    0x02
222         /** don't fsync after commit */
223 #define MDB_NOSYNC              0x10000
224         /** read only */
225 #define MDB_RDONLY              0x20000
226         /** don't fsync metapage after commit */
227 #define MDB_NOMETASYNC          0x40000
228         /** use writable mmap */
229 #define MDB_WRITEMAP            0x80000
230         /** use asynchronous msync */
231 #define MDB_MAPASYNC            0x100000
232 /** @} */
233
234 /**     @defgroup       mdb_open        Database Flags
235  *      @{
236  */
237         /** use reverse string keys */
238 #define MDB_REVERSEKEY  0x02
239         /** use sorted duplicates */
240 #define MDB_DUPSORT             0x04
241         /** numeric keys in native byte order.
242          *  The keys must all be of the same size. */
243 #define MDB_INTEGERKEY  0x08
244         /** with #MDB_DUPSORT, sorted dup items have fixed size */
245 #define MDB_DUPFIXED    0x10
246         /** with #MDB_DUPSORT, dups are numeric in native byte order */
247 #define MDB_INTEGERDUP  0x20
248         /** with #MDB_DUPSORT, use reverse string dups */
249 #define MDB_REVERSEDUP  0x40
250         /** create DB if not already existing */
251 #define MDB_CREATE              0x40000
252 /** @} */
253
254 /**     @defgroup mdb_put       Write Flags
255  *      @{
256  */
257 /** For put: Don't write if the key already exists. */
258 #define MDB_NOOVERWRITE 0x10
259 /** Only for #MDB_DUPSORT<br>
260  * For put: don't write if the key and data pair already exist.<br>
261  * For mdb_cursor_del: remove all duplicate data items.
262  */
263 #define MDB_NODUPDATA   0x20
264 /** For mdb_cursor_put: overwrite the current key/data pair */
265 #define MDB_CURRENT     0x40
266 /** For put: Just reserve space for data, don't copy it. Return a
267  * pointer to the reserved space.
268  */
269 #define MDB_RESERVE     0x10000
270 /** Data is being appended, don't split full pages. */
271 #define MDB_APPEND      0x20000
272 /** Duplicate data is being appended, don't split full pages. */
273 #define MDB_APPENDDUP   0x40000
274 /** Store multiple data items in one call. */
275 #define MDB_MULTIPLE    0x80000
276 /*      @} */
277
278 /** @brief Cursor Get operations.
279  *
280  *      This is the set of all operations for retrieving data
281  *      using a cursor.
282  */
283 typedef enum MDB_cursor_op {
284         MDB_FIRST,                              /**< Position at first key/data item */
285         MDB_FIRST_DUP,                  /**< Position at first data item of current key.
286                                                                 Only for #MDB_DUPSORT */
287         MDB_GET_BOTH,                   /**< Position at key/data pair. Only for #MDB_DUPSORT */
288         MDB_GET_BOTH_RANGE,             /**< position at key, nearest data. Only for #MDB_DUPSORT */
289         MDB_GET_CURRENT,                /**< Return key/data at current cursor position */
290         MDB_GET_MULTIPLE,               /**< Return all the duplicate data items at the current
291                                                                  cursor position. Only for #MDB_DUPFIXED */
292         MDB_LAST,                               /**< Position at last key/data item */
293         MDB_LAST_DUP,                   /**< Position at last data item of current key.
294                                                                 Only for #MDB_DUPSORT */
295         MDB_NEXT,                               /**< Position at next data item */
296         MDB_NEXT_DUP,                   /**< Position at next data item of current key.
297                                                                 Only for #MDB_DUPSORT */
298         MDB_NEXT_MULTIPLE,              /**< Return all duplicate data items at the next
299                                                                 cursor position. Only for #MDB_DUPFIXED */
300         MDB_NEXT_NODUP,                 /**< Position at first data item of next key.
301                                                                 Only for #MDB_DUPSORT */
302         MDB_PREV,                               /**< Position at previous data item */
303         MDB_PREV_DUP,                   /**< Position at previous data item of current key.
304                                                                 Only for #MDB_DUPSORT */
305         MDB_PREV_NODUP,                 /**< Position at last data item of previous key.
306                                                                 Only for #MDB_DUPSORT */
307         MDB_SET,                                /**< Position at specified key */
308         MDB_SET_KEY,                    /**< Position at specified key, return key + data */
309         MDB_SET_RANGE                   /**< Position at first key greater than or equal to specified key. */
310 } MDB_cursor_op;
311
312 /** @defgroup  errors   Return Codes
313  *
314  *      BerkeleyDB uses -30800 to -30999, we'll go under them
315  *      @{
316  */
317         /**     Successful result */
318 #define MDB_SUCCESS      0
319         /** key/data pair already exists */
320 #define MDB_KEYEXIST    (-30799)
321         /** key/data pair not found (EOF) */
322 #define MDB_NOTFOUND    (-30798)
323         /** Requested page not found - this usually indicates corruption */
324 #define MDB_PAGE_NOTFOUND       (-30797)
325         /** Located page was wrong type */
326 #define MDB_CORRUPTED   (-30796)
327         /** Update of meta page failed, probably I/O error */
328 #define MDB_PANIC               (-30795)
329         /** Environment version mismatch */
330 #define MDB_VERSION_MISMATCH    (-30794)
331         /** File is not a valid MDB file */
332 #define MDB_INVALID     (-30793)
333         /** Environment mapsize reached */
334 #define MDB_MAP_FULL    (-30792)
335         /** Environment maxdbs reached */
336 #define MDB_DBS_FULL    (-30791)
337         /** Environment maxreaders reached */
338 #define MDB_READERS_FULL        (-30790)
339         /** Too many TLS keys in use - Windows only */
340 #define MDB_TLS_FULL    (-30789)
341         /** Nested txn has too many dirty pages */
342 #define MDB_TXN_FULL    (-30788)
343         /** Cursor stack too deep - internal error */
344 #define MDB_CURSOR_FULL (-30787)
345         /** Page has not enough space - internal error */
346 #define MDB_PAGE_FULL   (-30786)
347 #define MDB_LAST_ERRCODE        MDB_PAGE_FULL
348 /** @} */
349
350 /** @brief Statistics for a database in the environment */
351 typedef struct MDB_stat {
352         unsigned int    ms_psize;                       /**< Size of a database page.
353                                                                                         This is currently the same for all databases. */
354         unsigned int    ms_depth;                       /**< Depth (height) of the B-tree */
355         size_t          ms_branch_pages;        /**< Number of internal (non-leaf) pages */
356         size_t          ms_leaf_pages;          /**< Number of leaf pages */
357         size_t          ms_overflow_pages;      /**< Number of overflow pages */
358         size_t          ms_entries;                     /**< Number of data items */
359 } MDB_stat;
360
361 /** @brief Information about the environment */
362 typedef struct MDB_envinfo {
363         size_t  me_mapsize;                             /**< Size of the data memory map */
364         size_t  me_last_txnid;                  /**< ID of the last committed transaction */
365         size_t  me_last_pgno;                   /**< ID of the last used page */
366         unsigned int me_maxreaders;             /**< maximum number of threads for the environment */
367         unsigned int me_numreaders;             /**< maximum number of threads used in the environment */
368 } MDB_envinfo;
369
370         /** @brief Return the mdb library version information.
371          *
372          * @param[out] major if non-NULL, the library major version number is copied here
373          * @param[out] minor if non-NULL, the library minor version number is copied here
374          * @param[out] patch if non-NULL, the library patch version number is copied here
375          * @retval "version string" The library version as a string
376          */
377 char *mdb_version(int *major, int *minor, int *patch);
378
379         /** @brief Return a string describing a given error code.
380          *
381          * This function is a superset of the ANSI C X3.159-1989 (ANSI C) strerror(3)
382          * function. If the error code is greater than or equal to 0, then the string
383          * returned by the system function strerror(3) is returned. If the error code
384          * is less than 0, an error string corresponding to the MDB library error is
385          * returned. See @ref errors for a list of MDB-specific error codes.
386          * @param[in] err The error code
387          * @retval "error message" The description of the error
388          */
389 char *mdb_strerror(int err);
390
391         /** @brief Create an MDB environment handle.
392          *
393          * This function allocates memory for a #MDB_env structure. To release
394          * the allocated memory and discard the handle, call #mdb_env_close().
395          * Before the handle may be used, it must be opened using #mdb_env_open().
396          * Various other options may also need to be set before opening the handle,
397          * e.g. #mdb_env_set_mapsize(), #mdb_env_set_maxreaders(), #mdb_env_set_maxdbs(),
398          * depending on usage requirements.
399          * @param[out] env The address where the new handle will be stored
400          * @return A non-zero error value on failure and 0 on success.
401          */
402 int  mdb_env_create(MDB_env **env);
403
404         /** @brief Open an environment handle.
405          *
406          * If this function fails, #mdb_env_close() must be called to discard the #MDB_env handle.
407          * @param[in] env An environment handle returned by #mdb_env_create()
408          * @param[in] path The directory in which the database files reside. This
409          * directory must already exist and be writable.
410          * @param[in] flags Special options for this environment. This parameter
411          * must be set to 0 or by bitwise OR'ing together one or more of the
412          * values described here.
413          * Flags set by mdb_env_set_flags() are also used.
414          * <ul>
415          *      <li>#MDB_FIXEDMAP
416          *      use a fixed address for the mmap region. This flag must be specified
417          *      when creating the environment, and is stored persistently in the environment.
418          *              If successful, the memory map will always reside at the same virtual address
419          *              and pointers used to reference data items in the database will be constant
420          *              across multiple invocations. This option may not always work, depending on
421          *              how the operating system has allocated memory to shared libraries and other uses.
422          *              The feature is highly experimental.
423          *      <li>#MDB_NOSUBDIR
424          *              By default, MDB creates its environment in a directory whose
425          *              pathname is given in \b path, and creates its data and lock files
426          *              under that directory. With this option, \b path is used as-is for
427          *              the database main data file. The database lock file is the \b path
428          *              with "-lock" appended.
429          *      <li>#MDB_NOSYNC
430          *              Don't perform a synchronous flush after committing a transaction. This means
431          *              transactions will exhibit the ACI (atomicity, consistency, and isolation)
432          *              properties, but not D (durability); that is database integrity will be
433          *              maintained but it is possible some number of the most recently committed
434          *              transactions may be undone after a system crash. The number of transactions
435          *              at risk is governed by how often the system flushes dirty buffers to disk
436          *              and how often #mdb_env_sync() is called. This flag may be changed
437          *              at any time using #mdb_env_set_flags().
438          *      <li>#MDB_NOMETASYNC
439          *              Don't perform a synchronous flush of the meta page after committing
440          *              a transaction. This is similar to the #MDB_NOSYNC case, but safer
441          *              because the transaction data is still flushed. The meta page for any
442          *              transaction N will be flushed by the data flush of transaction N+1.
443          *              In case of a system crash, the last committed transaction may be
444          *              lost. This flag may be changed at any time using #mdb_env_set_flags().
445          *      <li>#MDB_RDONLY
446          *              Open the environment in read-only mode. No write operations will be allowed.
447          * </ul>
448          * @param[in] mode The UNIX permissions to set on created files. This parameter
449          * is ignored on Windows.
450          * @return A non-zero error value on failure and 0 on success. Some possible
451          * errors are:
452          * <ul>
453          *      <li>#MDB_VERSION_MISMATCH - the version of the MDB library doesn't match the
454          *      version that created the database environment.
455          *      <li>EINVAL - the environment file headers are corrupted.
456          *      <li>ENOENT - the directory specified by the path parameter doesn't exist.
457          *      <li>EACCES - the user didn't have permission to access the environment files.
458          *      <li>EAGAIN - the environment was locked by another process.
459          * </ul>
460          */
461 int  mdb_env_open(MDB_env *env, const char *path, unsigned int flags, mode_t mode);
462
463         /** @brief Copy an MDB environment to the specified path.
464          *
465          * This function may be used to make a backup of an existing environment.
466          * @param[in] env An environment handle returned by #mdb_env_create(). It
467          * must have already been opened successfully.
468          * @param[in] path The directory in which the copy will reside. This
469          * directory must already exist and be writable but must otherwise be
470          * empty.
471          * @return A non-zero error value on failure and 0 on success.
472          */
473 int  mdb_env_copy(MDB_env *env, const char *path);
474
475         /** @brief Return statistics about the MDB environment.
476          *
477          * @param[in] env An environment handle returned by #mdb_env_create()
478          * @param[out] stat The address of an #MDB_stat structure
479          *      where the statistics will be copied
480          */
481 int  mdb_env_stat(MDB_env *env, MDB_stat *stat);
482
483         /** @brief Return information about the MDB environment.
484          *
485          * @param[in] env An environment handle returned by #mdb_env_create()
486          * @param[out] stat The address of an #MDB_envinfo structure
487          *      where the information will be copied
488          */
489 int  mdb_env_info(MDB_env *env, MDB_envinfo *stat);
490
491         /** @brief Flush the data buffers to disk.
492          *
493          * Data is always written to disk when #mdb_txn_commit() is called,
494          * but the operating system may keep it buffered. MDB always flushes
495          * the OS buffers upon commit as well, unless the environment was
496          * opened with #MDB_NOSYNC.
497          * @param[in] env An environment handle returned by #mdb_env_create()
498          * @param[in] force If non-zero, force the flush to occur. Otherwise
499          *  if the environment has the #MDB_NOSYNC flag set the flushes
500          *      will be omitted.
501          * @return A non-zero error value on failure and 0 on success. Some possible
502          * errors are:
503          * <ul>
504          *      <li>EINVAL - an invalid parameter was specified.
505          *      <li>EIO - an error occurred during synchronization.
506          * </ul>
507          */
508 int  mdb_env_sync(MDB_env *env, int force);
509
510         /** @brief Close the environment and release the memory map.
511          *
512          * Only a single thread may call this function. All transactions, databases,
513          * and cursors must already be closed before calling this function. Attempts to
514          * use any such handles after calling this function will cause a SIGSEGV.
515          * The environment handle will be freed and must not be used again after this call.
516          * @param[in] env An environment handle returned by #mdb_env_create()
517          */
518 void mdb_env_close(MDB_env *env);
519
520         /** @brief Set environment flags.
521          *
522          * This may be used to set some flags in addition to those from
523          * #mdb_env_open(), or to unset these flags.
524          * @param[in] env An environment handle returned by #mdb_env_create()
525          * @param[in] flags The flags to change, bitwise OR'ed together
526          * @param[in] onoff A non-zero value sets the flags, zero clears them.
527          * @return A non-zero error value on failure and 0 on success. Some possible
528          * errors are:
529          * <ul>
530          *      <li>EINVAL - an invalid parameter was specified.
531          * </ul>
532          */
533 int  mdb_env_set_flags(MDB_env *env, unsigned int flags, int onoff);
534
535         /** @brief Get environment flags.
536          *
537          * @param[in] env An environment handle returned by #mdb_env_create()
538          * @param[out] flags The address of an integer to store the flags
539          * @return A non-zero error value on failure and 0 on success. Some possible
540          * errors are:
541          * <ul>
542          *      <li>EINVAL - an invalid parameter was specified.
543          * </ul>
544          */
545 int  mdb_env_get_flags(MDB_env *env, unsigned int *flags);
546
547         /** @brief Return the path that was used in #mdb_env_open().
548          *
549          * @param[in] env An environment handle returned by #mdb_env_create()
550          * @param[out] path Address of a string pointer to contain the path. This
551          * is the actual string in the environment, not a copy. It should not be
552          * altered in any way.
553          * @return A non-zero error value on failure and 0 on success. Some possible
554          * errors are:
555          * <ul>
556          *      <li>EINVAL - an invalid parameter was specified.
557          * </ul>
558          */
559 int  mdb_env_get_path(MDB_env *env, const char **path);
560
561         /** @brief Set the size of the memory map to use for this environment.
562          *
563          * The size should be a multiple of the OS page size. The default is
564          * 10485760 bytes. The size of the memory map is also the maximum size
565          * of the database. The value should be chosen as large as possible,
566          * to accommodate future growth of the database.
567          * This function may only be called after #mdb_env_create() and before #mdb_env_open().
568          * @param[in] env An environment handle returned by #mdb_env_create()
569          * @param[in] size The size in bytes
570          * @return A non-zero error value on failure and 0 on success. Some possible
571          * errors are:
572          * <ul>
573          *      <li>EINVAL - an invalid parameter was specified, or the environment is already open.
574          * </ul>
575          */
576 int  mdb_env_set_mapsize(MDB_env *env, size_t size);
577
578         /** @brief Set the maximum number of threads for the environment.
579          *
580          * This defines the number of slots in the lock table that is used to track readers in the
581          * the environment. The default is 126.
582          * This function may only be called after #mdb_env_create() and before #mdb_env_open().
583          * @param[in] env An environment handle returned by #mdb_env_create()
584          * @param[in] readers The maximum number of threads
585          * @return A non-zero error value on failure and 0 on success. Some possible
586          * errors are:
587          * <ul>
588          *      <li>EINVAL - an invalid parameter was specified, or the environment is already open.
589          * </ul>
590          */
591 int  mdb_env_set_maxreaders(MDB_env *env, unsigned int readers);
592
593         /** @brief Get the maximum number of threads for the environment.
594          *
595          * @param[in] env An environment handle returned by #mdb_env_create()
596          * @param[out] readers Address of an integer to store the number of readers
597          * @return A non-zero error value on failure and 0 on success. Some possible
598          * errors are:
599          * <ul>
600          *      <li>EINVAL - an invalid parameter was specified.
601          * </ul>
602          */
603 int  mdb_env_get_maxreaders(MDB_env *env, unsigned int *readers);
604
605         /** @brief Set the maximum number of databases for the environment.
606          *
607          * This function is only needed if multiple databases will be used in the
608          * environment. Simpler applications that only use a single database can ignore
609          * this option.
610          * This function may only be called after #mdb_env_create() and before #mdb_env_open().
611          * @param[in] env An environment handle returned by #mdb_env_create()
612          * @param[in] dbs The maximum number of databases
613          * @return A non-zero error value on failure and 0 on success. Some possible
614          * errors are:
615          * <ul>
616          *      <li>EINVAL - an invalid parameter was specified, or the environment is already open.
617          * </ul>
618          */
619 int  mdb_env_set_maxdbs(MDB_env *env, MDB_dbi dbs);
620
621         /** @brief Create a transaction for use with the environment.
622          *
623          * The transaction handle may be discarded using #mdb_txn_abort() or #mdb_txn_commit().
624          * @note Transactions may not span threads; a transaction must only be used by a
625          * single thread. Also, a thread may only have a single transaction.
626          * @note Cursors may not span transactions; each cursor must be opened and closed
627          * within a single transaction.
628          * @param[in] env An environment handle returned by #mdb_env_create()
629          * @param[in] parent If this parameter is non-NULL, the new transaction
630          * will be a nested transaction, with the transaction indicated by \b parent
631          * as its parent. Transactions may be nested to any level. A parent
632          * transaction may not issue any other operations besides mdb_txn_begin,
633          * mdb_txn_abort, or mdb_txn_commit while it has active child transactions.
634          * @param[in] flags Special options for this transaction. This parameter
635          * must be set to 0 or by bitwise OR'ing together one or more of the
636          * values described here.
637          * <ul>
638          *      <li>#MDB_RDONLY
639          *              This transaction will not perform any write operations.
640          * </ul>
641          * @param[out] txn Address where the new #MDB_txn handle will be stored
642          * @return A non-zero error value on failure and 0 on success. Some possible
643          * errors are:
644          * <ul>
645          *      <li>#MDB_PANIC - a fatal error occurred earlier and the environment
646          *              must be shut down.
647          *      <li>ENOMEM - out of memory, or a read-only transaction was requested and
648          *              the reader lock table is full. See #mdb_env_set_maxreaders().
649          * </ul>
650          */
651 int  mdb_txn_begin(MDB_env *env, MDB_txn *parent, unsigned int flags, MDB_txn **txn);
652
653         /** @brief Commit all the operations of a transaction into the database.
654          *
655          * All cursors opened within the transaction will be closed by this call. The cursors
656          * and transaction handle will be freed and must not be used again after this call.
657          * @param[in] txn A transaction handle returned by #mdb_txn_begin()
658          * @return A non-zero error value on failure and 0 on success. Some possible
659          * errors are:
660          * <ul>
661          *      <li>EINVAL - an invalid parameter was specified.
662          *      <li>ENOSPC - no more disk space.
663          *      <li>EIO - a low-level I/O error occurred while writing.
664          *      <li>ENOMEM - the transaction is nested and could not be merged into its parent.
665          * </ul>
666          */
667 int  mdb_txn_commit(MDB_txn *txn);
668
669         /** @brief Abandon all the operations of the transaction instead of saving them.
670          *
671          * All cursors opened within the transaction will be closed by this call. The cursors
672          * and transaction handle will be freed and must not be used again after this call.
673          * @param[in] txn A transaction handle returned by #mdb_txn_begin()
674          */
675 void mdb_txn_abort(MDB_txn *txn);
676
677         /** @brief Reset a read-only transaction.
678          *
679          * This releases the current reader lock but doesn't free the
680          * transaction handle, allowing it to be used again later by #mdb_txn_renew().
681          * It otherwise has the same effect as #mdb_txn_abort() but saves some memory
682          * allocation/deallocation overhead if a thread is going to start a new
683          * read-only transaction again soon.
684          * All cursors opened within the transaction must be closed before the transaction
685          * is reset.
686          * Reader locks generally don't interfere with writers, but they keep old
687          * versions of database pages allocated. Thus they prevent the old pages
688          * from being reused when writers commit new data, and so under heavy load
689          * the database size may grow much more rapidly than otherwise.
690          * @param[in] txn A transaction handle returned by #mdb_txn_begin()
691          */
692 void mdb_txn_reset(MDB_txn *txn);
693
694         /** @brief Renew a read-only transaction.
695          *
696          * This acquires a new reader lock for a transaction handle that had been
697          * released by #mdb_txn_reset(). It must be called before a reset transaction
698          * may be used again.
699          * @param[in] txn A transaction handle returned by #mdb_txn_begin()
700          * @return A non-zero error value on failure and 0 on success. Some possible
701          * errors are:
702          * <ul>
703          *      <li>#MDB_PANIC - a fatal error occurred earlier and the environment
704          *              must be shut down.
705          *      <li>EINVAL - an invalid parameter was specified.
706          * </ul>
707          */
708 int  mdb_txn_renew(MDB_txn *txn);
709
710         /** @brief Open a database in the environment.
711          *
712          * The database handle may be discarded by calling #mdb_close().  The
713          * database handle resides in the shared environment, it is not owned
714          * by the given transaction. Only one thread should call this function;
715          * it is not mutex-protected in a read-only transaction.
716          * @param[in] txn A transaction handle returned by #mdb_txn_begin()
717          * @param[in] name The name of the database to open. If only a single
718          *      database is needed in the environment, this value may be NULL.
719          * @param[in] flags Special options for this database. This parameter
720          * must be set to 0 or by bitwise OR'ing together one or more of the
721          * values described here.
722          * <ul>
723          *      <li>#MDB_REVERSEKEY
724          *              Keys are strings to be compared in reverse order, from the end
725          *              of the strings to the beginning. By default, Keys are treated as strings and
726          *              compared from beginning to end.
727          *      <li>#MDB_DUPSORT
728          *              Duplicate keys may be used in the database. (Or, from another perspective,
729          *              keys may have multiple data items, stored in sorted order.) By default
730          *              keys must be unique and may have only a single data item.
731          *      <li>#MDB_INTEGERKEY
732          *              Keys are binary integers in native byte order. Setting this option
733          *              requires all keys to be the same size, typically sizeof(int)
734          *              or sizeof(size_t).
735          *      <li>#MDB_DUPFIXED
736          *              This flag may only be used in combination with #MDB_DUPSORT. This option
737          *              tells the library that the data items for this database are all the same
738          *              size, which allows further optimizations in storage and retrieval. When
739          *              all data items are the same size, the #MDB_GET_MULTIPLE and #MDB_NEXT_MULTIPLE
740          *              cursor operations may be used to retrieve multiple items at once.
741          *      <li>#MDB_INTEGERDUP
742          *              This option specifies that duplicate data items are also integers, and
743          *              should be sorted as such.
744          *      <li>#MDB_REVERSEDUP
745          *              This option specifies that duplicate data items should be compared as
746          *              strings in reverse order.
747          *      <li>#MDB_CREATE
748          *              Create the named database if it doesn't exist. This option is not
749          *              allowed in a read-only transaction or a read-only environment.
750          * </ul>
751          * @param[out] dbi Address where the new #MDB_dbi handle will be stored
752          * @return A non-zero error value on failure and 0 on success. Some possible
753          * errors are:
754          * <ul>
755          *      <li>#MDB_NOTFOUND - the specified database doesn't exist in the environment
756          *              and #MDB_CREATE was not specified.
757          *      <li>ENFILE - too many databases have been opened. See #mdb_env_set_maxdbs().
758          * </ul>
759          */
760 int  mdb_open(MDB_txn *txn, const char *name, unsigned int flags, MDB_dbi *dbi);
761
762         /** @brief Retrieve statistics for a database.
763          *
764          * @param[in] txn A transaction handle returned by #mdb_txn_begin()
765          * @param[in] dbi A database handle returned by #mdb_open()
766          * @param[out] stat The address of an #MDB_stat structure
767          *      where the statistics will be copied
768          * @return A non-zero error value on failure and 0 on success. Some possible
769          * errors are:
770          * <ul>
771          *      <li>EINVAL - an invalid parameter was specified.
772          * </ul>
773          */
774 int  mdb_stat(MDB_txn *txn, MDB_dbi dbi, MDB_stat *stat);
775
776         /** @brief Close a database handle.
777          *
778          * This call is not mutex protected. Handles should only be closed by
779          * a single thread, and only if no other threads are going to reference
780          * the database handle any further.
781          * @param[in] env An environment handle returned by #mdb_env_create()
782          * @param[in] dbi A database handle returned by #mdb_open()
783          */
784 void mdb_close(MDB_env *env, MDB_dbi dbi);
785
786         /** @brief Delete a database and/or free all its pages.
787          *
788          * If the \b del parameter is non-zero the DB handle will be closed
789          * and the DB will be deleted.
790          * @param[in] txn A transaction handle returned by #mdb_txn_begin()
791          * @param[in] dbi A database handle returned by #mdb_open()
792          * @param[in] del non-zero to delete the DB from the environment,
793          * otherwise just free its pages.
794          * @return A non-zero error value on failure and 0 on success.
795          */
796 int  mdb_drop(MDB_txn *txn, MDB_dbi dbi, int del);
797
798         /** @brief Set a custom key comparison function for a database.
799          *
800          * The comparison function is called whenever it is necessary to compare a
801          * key specified by the application with a key currently stored in the database.
802          * If no comparison function is specified, and no special key flags were specified
803          * with #mdb_open(), the keys are compared lexically, with shorter keys collating
804          * before longer keys.
805          * @warning This function must be called before any data access functions are used,
806          * otherwise data corruption may occur. The same comparison function must be used by every
807          * program accessing the database, every time the database is used.
808          * @param[in] txn A transaction handle returned by #mdb_txn_begin()
809          * @param[in] dbi A database handle returned by #mdb_open()
810          * @param[in] cmp A #MDB_cmp_func function
811          * @return A non-zero error value on failure and 0 on success. Some possible
812          * errors are:
813          * <ul>
814          *      <li>EINVAL - an invalid parameter was specified.
815          * </ul>
816          */
817 int  mdb_set_compare(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp);
818
819         /** @brief Set a custom data comparison function for a #MDB_DUPSORT database.
820          *
821          * This comparison function is called whenever it is necessary to compare a data
822          * item specified by the application with a data item currently stored in the database.
823          * This function only takes effect if the database was opened with the #MDB_DUPSORT
824          * flag.
825          * If no comparison function is specified, and no special key flags were specified
826          * with #mdb_open(), the data items are compared lexically, with shorter items collating
827          * before longer items.
828          * @warning This function must be called before any data access functions are used,
829          * otherwise data corruption may occur. The same comparison function must be used by every
830          * program accessing the database, every time the database is used.
831          * @param[in] txn A transaction handle returned by #mdb_txn_begin()
832          * @param[in] dbi A database handle returned by #mdb_open()
833          * @param[in] cmp A #MDB_cmp_func function
834          * @return A non-zero error value on failure and 0 on success. Some possible
835          * errors are:
836          * <ul>
837          *      <li>EINVAL - an invalid parameter was specified.
838          * </ul>
839          */
840 int  mdb_set_dupsort(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp);
841
842         /** @brief Set a relocation function for a #MDB_FIXEDMAP database.
843          *
844          * @todo The relocation function is called whenever it is necessary to move the data
845          * of an item to a different position in the database (e.g. through tree
846          * balancing operations, shifts as a result of adds or deletes, etc.). It is
847          * intended to allow address/position-dependent data items to be stored in
848          * a database in an environment opened with the #MDB_FIXEDMAP option.
849          * Currently the relocation feature is unimplemented and setting
850          * this function has no effect.
851          * @param[in] txn A transaction handle returned by #mdb_txn_begin()
852          * @param[in] dbi A database handle returned by #mdb_open()
853          * @param[in] rel A #MDB_rel_func function
854          * @return A non-zero error value on failure and 0 on success. Some possible
855          * errors are:
856          * <ul>
857          *      <li>EINVAL - an invalid parameter was specified.
858          * </ul>
859          */
860 int  mdb_set_relfunc(MDB_txn *txn, MDB_dbi dbi, MDB_rel_func *rel);
861
862         /** @brief Set a context pointer for a #MDB_FIXEDMAP database's relocation function.
863          *
864          * See #mdb_set_relfunc and #MDB_rel_func for more details.
865          * @param[in] txn A transaction handle returned by #mdb_txn_begin()
866          * @param[in] dbi A database handle returned by #mdb_open()
867          * @param[in] ctx An arbitrary pointer for whatever the application needs.
868          * It will be passed to the callback function set by #mdb_set_relfunc
869          * as its \b relctx parameter whenever the callback is invoked.
870          * @return A non-zero error value on failure and 0 on success. Some possible
871          * errors are:
872          * <ul>
873          *      <li>EINVAL - an invalid parameter was specified.
874          * </ul>
875          */
876 int  mdb_set_relctx(MDB_txn *txn, MDB_dbi dbi, void *ctx);
877
878         /** @brief Get items from a database.
879          *
880          * This function retrieves key/data pairs from the database. The address
881          * and length of the data associated with the specified \b key are returned
882          * in the structure to which \b data refers.
883          * If the database supports duplicate keys (#MDB_DUPSORT) then the
884          * first data item for the key will be returned. Retrieval of other
885          * items requires the use of #mdb_cursor_get().
886          *
887          * @note The memory pointed to by the returned values is owned by the
888          * database. The caller need not dispose of the memory, and may not
889          * modify it in any way. For values returned in a read-only transaction
890          * any modification attempts will cause a SIGSEGV.
891          * @param[in] txn A transaction handle returned by #mdb_txn_begin()
892          * @param[in] dbi A database handle returned by #mdb_open()
893          * @param[in] key The key to search for in the database
894          * @param[out] data The data corresponding to the key
895          * @return A non-zero error value on failure and 0 on success. Some possible
896          * errors are:
897          * <ul>
898          *      <li>#MDB_NOTFOUND - the key was not in the database.
899          *      <li>EINVAL - an invalid parameter was specified.
900          * </ul>
901          */
902 int  mdb_get(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data);
903
904         /** @brief Store items into a database.
905          *
906          * This function stores key/data pairs in the database. The default behavior
907          * is to enter the new key/data pair, replacing any previously existing key
908          * if duplicates are disallowed, or adding a duplicate data item if
909          * duplicates are allowed (#MDB_DUPSORT).
910          * @param[in] txn A transaction handle returned by #mdb_txn_begin()
911          * @param[in] dbi A database handle returned by #mdb_open()
912          * @param[in] key The key to store in the database
913          * @param[in,out] data The data to store
914          * @param[in] flags Special options for this operation. This parameter
915          * must be set to 0 or by bitwise OR'ing together one or more of the
916          * values described here.
917          * <ul>
918          *      <li>#MDB_NODUPDATA - enter the new key/data pair only if it does not
919          *              already appear in the database. This flag may only be specified
920          *              if the database was opened with #MDB_DUPSORT. The function will
921          *              return #MDB_KEYEXIST if the key/data pair already appears in the
922          *              database.
923          *      <li>#MDB_NOOVERWRITE - enter the new key/data pair only if the key
924          *              does not already appear in the database. The function will return
925          *              #MDB_KEYEXIST if the key already appears in the database, even if
926          *              the database supports duplicates (#MDB_DUPSORT). The \b data
927          *              parameter will be set to point to the existing item.
928          *      <li>#MDB_RESERVE - reserve space for data of the given size, but
929          *              don't copy the given data. Instead, return a pointer to the
930          *              reserved space, which the caller can fill in later. This saves
931          *              an extra memcpy if the data is being generated later.
932          *      <li>#MDB_APPEND - append the given key/data pair to the end of the
933          *              database. No key comparisons are performed. This option allows
934          *              fast bulk loading when keys are already known to be in the
935          *              correct order. Loading unsorted keys with this flag will cause
936          *              data corruption.
937          *      <li>#MDB_APPENDDUP - as above, but for sorted dup data.
938          * </ul>
939          * @return A non-zero error value on failure and 0 on success. Some possible
940          * errors are:
941          * <ul>
942          *      <li>EACCES - an attempt was made to write in a read-only transaction.
943          *      <li>EINVAL - an invalid parameter was specified.
944          *      <li>ENOMEM - the database is full, see #mdb_env_set_mapsize().
945          * </ul>
946          */
947 int  mdb_put(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data,
948                             unsigned int flags);
949
950         /** @brief Delete items from a database.
951          *
952          * This function removes key/data pairs from the database.
953          * If the database does not support sorted duplicate data items
954          * (#MDB_DUPSORT) the data parameter is ignored.
955          * If the database supports sorted duplicates and the data parameter
956          * is NULL, all of the duplicate data items for the key will be
957          * deleted. Otherwise, if the data parameter is non-NULL
958          * only the matching data item will be deleted.
959          * This function will return #MDB_NOTFOUND if the specified key/data
960          * pair is not in the database.
961          * @param[in] txn A transaction handle returned by #mdb_txn_begin()
962          * @param[in] dbi A database handle returned by #mdb_open()
963          * @param[in] key The key to delete from the database
964          * @param[in] data The data to delete
965          * @return A non-zero error value on failure and 0 on success. Some possible
966          * errors are:
967          * <ul>
968          *      <li>EACCES - an attempt was made to write in a read-only transaction.
969          *      <li>EINVAL - an invalid parameter was specified.
970          * </ul>
971          */
972 int  mdb_del(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data);
973
974         /** @brief Create a cursor handle.
975          *
976          * Cursors are associated with a specific transaction and database and
977          * may not span threads.
978          * @param[in] txn A transaction handle returned by #mdb_txn_begin()
979          * @param[in] dbi A database handle returned by #mdb_open()
980          * @param[out] cursor Address where the new #MDB_cursor handle will be stored
981          * @return A non-zero error value on failure and 0 on success. Some possible
982          * errors are:
983          * <ul>
984          *      <li>EINVAL - an invalid parameter was specified.
985          * </ul>
986          */
987 int  mdb_cursor_open(MDB_txn *txn, MDB_dbi dbi, MDB_cursor **cursor);
988
989         /** @brief Close a cursor handle.
990          *
991          * The cursor handle will be freed and must not be used again after this call.
992          * @param[in] cursor A cursor handle returned by #mdb_cursor_open()
993          */
994 void mdb_cursor_close(MDB_cursor *cursor);
995
996         /** @brief Renew a cursor handle.
997          *
998          * Cursors are associated with a specific transaction and database and
999          * may not span threads. Cursors that are only used in read-only
1000          * transactions may be re-used, to avoid unnecessary malloc/free overhead.
1001          * The cursor may be associated with a new read-only transaction, and
1002          * referencing the same database handle as it was created with.
1003          * @param[in] txn A transaction handle returned by #mdb_txn_begin()
1004          * @param[in] cursor A cursor handle returned by #mdb_cursor_open()
1005          * @return A non-zero error value on failure and 0 on success. Some possible
1006          * errors are:
1007          * <ul>
1008          *      <li>EINVAL - an invalid parameter was specified.
1009          * </ul>
1010          */
1011 int  mdb_cursor_renew(MDB_txn *txn, MDB_cursor *cursor);
1012
1013         /** @brief Return the cursor's transaction handle.
1014          *
1015          * @param[in] cursor A cursor handle returned by #mdb_cursor_open()
1016          */
1017 MDB_txn *mdb_cursor_txn(MDB_cursor *cursor);
1018
1019         /** @brief Return the cursor's database handle.
1020          *
1021          * @param[in] cursor A cursor handle returned by #mdb_cursor_open()
1022          */
1023 MDB_dbi mdb_cursor_dbi(MDB_cursor *cursor);
1024
1025         /** @brief Retrieve by cursor.
1026          *
1027          * This function retrieves key/data pairs from the database. The address and length
1028          * of the key are returned in the object to which \b key refers (except for the
1029          * case of the #MDB_SET option, in which the \b key object is unchanged), and
1030          * the address and length of the data are returned in the object to which \b data
1031          * refers.
1032          * @param[in] cursor A cursor handle returned by #mdb_cursor_open()
1033          * @param[in,out] key The key for a retrieved item
1034          * @param[in,out] data The data of a retrieved item
1035          * @param[in] op A cursor operation #MDB_cursor_op
1036          * @return A non-zero error value on failure and 0 on success. Some possible
1037          * errors are:
1038          * <ul>
1039          *      <li>#MDB_NOTFOUND - no matching key found.
1040          *      <li>EINVAL - an invalid parameter was specified.
1041          * </ul>
1042          */
1043 int  mdb_cursor_get(MDB_cursor *cursor, MDB_val *key, MDB_val *data,
1044                             MDB_cursor_op op);
1045
1046         /** @brief Store by cursor.
1047          *
1048          * This function stores key/data pairs into the database.
1049          * If the function fails for any reason, the state of the cursor will be
1050          * unchanged. If the function succeeds and an item is inserted into the
1051          * database, the cursor is always positioned to refer to the newly inserted item.
1052          * @param[in] cursor A cursor handle returned by #mdb_cursor_open()
1053          * @param[in] key The key operated on.
1054          * @param[in] data The data operated on.
1055          * @param[in] flags Options for this operation. This parameter
1056          * must be set to 0 or one of the values described here.
1057          * <ul>
1058          *      <li>#MDB_CURRENT - overwrite the data of the key/data pair to which
1059          *              the cursor refers with the specified data item. The \b key
1060          *              parameter is ignored.
1061          *      <li>#MDB_NODUPDATA - enter the new key/data pair only if it does not
1062          *              already appear in the database. This flag may only be specified
1063          *              if the database was opened with #MDB_DUPSORT. The function will
1064          *              return #MDB_KEYEXIST if the key/data pair already appears in the
1065          *              database.
1066          *      <li>#MDB_NOOVERWRITE - enter the new key/data pair only if the key
1067          *              does not already appear in the database. The function will return
1068          *              #MDB_KEYEXIST if the key already appears in the database, even if
1069          *              the database supports duplicates (#MDB_DUPSORT).
1070          *      <li>#MDB_RESERVE - reserve space for data of the given size, but
1071          *              don't copy the given data. Instead, return a pointer to the
1072          *              reserved space, which the caller can fill in later. This saves
1073          *              an extra memcpy if the data is being generated later.
1074          *      <li>#MDB_APPEND - append the given key/data pair to the end of the
1075          *              database. No key comparisons are performed. This option allows
1076          *              fast bulk loading when keys are already known to be in the
1077          *              correct order. Loading unsorted keys with this flag will cause
1078          *              data corruption.
1079          *      <li>#MDB_APPENDDUP - as above, but for sorted dup data.
1080          * </ul>
1081          * @return A non-zero error value on failure and 0 on success. Some possible
1082          * errors are:
1083          * <ul>
1084          *      <li>EACCES - an attempt was made to modify a read-only database.
1085          *      <li>EINVAL - an invalid parameter was specified.
1086          * </ul>
1087          */
1088 int  mdb_cursor_put(MDB_cursor *cursor, MDB_val *key, MDB_val *data,
1089                                 unsigned int flags);
1090
1091         /** @brief Delete current key/data pair
1092          *
1093          * This function deletes the key/data pair to which the cursor refers.
1094          * @param[in] cursor A cursor handle returned by #mdb_cursor_open()
1095          * @param[in] flags Options for this operation. This parameter
1096          * must be set to 0 or one of the values described here.
1097          * <ul>
1098          *      <li>#MDB_NODUPDATA - delete all of the data items for the current key.
1099          *              This flag may only be specified if the database was opened with #MDB_DUPSORT.
1100          * </ul>
1101          * @return A non-zero error value on failure and 0 on success. Some possible
1102          * errors are:
1103          * <ul>
1104          *      <li>EACCES - an attempt was made to modify a read-only database.
1105          *      <li>EINVAL - an invalid parameter was specified.
1106          * </ul>
1107          */
1108 int  mdb_cursor_del(MDB_cursor *cursor, unsigned int flags);
1109
1110         /** @brief Return count of duplicates for current key.
1111          *
1112          * This call is only valid on databases that support sorted duplicate
1113          * data items #MDB_DUPSORT.
1114          * @param[in] cursor A cursor handle returned by #mdb_cursor_open()
1115          * @param[out] countp Address where the count will be stored
1116          * @return A non-zero error value on failure and 0 on success. Some possible
1117          * errors are:
1118          * <ul>
1119          *      <li>EINVAL - cursor is not initialized, or an invalid parameter was specified.
1120          * </ul>
1121          */
1122 int  mdb_cursor_count(MDB_cursor *cursor, size_t *countp);
1123
1124         /** @brief Compare two data items according to a particular database.
1125          *
1126          * This returns a comparison as if the two data items were keys in the
1127          * specified database.
1128          * @param[in] txn A transaction handle returned by #mdb_txn_begin()
1129          * @param[in] dbi A database handle returned by #mdb_open()
1130          * @param[in] a The first item to compare
1131          * @param[in] b The second item to compare
1132          * @return < 0 if a < b, 0 if a == b, > 0 if a > b
1133          */
1134 int  mdb_cmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b);
1135
1136         /** @brief Compare two data items according to a particular database.
1137          *
1138          * This returns a comparison as if the two items were data items of
1139          * a sorted duplicates #MDB_DUPSORT database.
1140          * @param[in] txn A transaction handle returned by #mdb_txn_begin()
1141          * @param[in] dbi A database handle returned by #mdb_open()
1142          * @param[in] a The first item to compare
1143          * @param[in] b The second item to compare
1144          * @return < 0 if a < b, 0 if a == b, > 0 if a > b
1145          */
1146 int  mdb_dcmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b);
1147 /**     @} */
1148
1149 #ifdef __cplusplus
1150 }
1151 #endif
1152 #endif /* _MDB_H_ */