MDB
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
lmdb.h
Go to the documentation of this file.
1 
149 #ifndef _LMDB_H_
150 #define _LMDB_H_
151 
152 #include <sys/types.h>
153 
154 #ifdef __cplusplus
155 extern "C" {
156 #endif
157 
159 #ifdef _MSC_VER
160 typedef int mdb_mode_t;
161 #else
162 typedef mode_t mdb_mode_t;
163 #endif
164 
169 #ifdef _WIN32
170 typedef void *mdb_filehandle_t;
171 #else
172 typedef int mdb_filehandle_t;
173 #endif
174 
183 #define MDB_VERSION_MAJOR 0
184 
185 #define MDB_VERSION_MINOR 9
186 
187 #define MDB_VERSION_PATCH 11
188 
190 #define MDB_VERINT(a,b,c) (((a) << 24) | ((b) << 16) | (c))
191 
193 #define MDB_VERSION_FULL \
194  MDB_VERINT(MDB_VERSION_MAJOR,MDB_VERSION_MINOR,MDB_VERSION_PATCH)
195 
197 #define MDB_VERSION_DATE "January 15, 2014"
198 
200 #define MDB_VERSTR(a,b,c,d) "MDB " #a "." #b "." #c ": (" d ")"
201 
203 #define MDB_VERFOO(a,b,c,d) MDB_VERSTR(a,b,c,d)
204 
206 #define MDB_VERSION_STRING \
207  MDB_VERFOO(MDB_VERSION_MAJOR,MDB_VERSION_MINOR,MDB_VERSION_PATCH,MDB_VERSION_DATE)
208 
215 typedef struct MDB_env MDB_env;
216 
222 typedef struct MDB_txn MDB_txn;
223 
225 typedef unsigned int MDB_dbi;
226 
228 typedef struct MDB_cursor MDB_cursor;
229 
241 typedef struct MDB_val {
242  size_t mv_size;
243  void *mv_data;
244 } MDB_val;
245 
247 typedef int (MDB_cmp_func)(const MDB_val *a, const MDB_val *b);
248 
263 typedef void (MDB_rel_func)(MDB_val *item, void *oldptr, void *newptr, void *relctx);
264 
269 #define MDB_FIXEDMAP 0x01
270 
271 #define MDB_NOSUBDIR 0x4000
272 
273 #define MDB_NOSYNC 0x10000
274 
275 #define MDB_RDONLY 0x20000
276 
277 #define MDB_NOMETASYNC 0x40000
278 
279 #define MDB_WRITEMAP 0x80000
280 
281 #define MDB_MAPASYNC 0x100000
282 
283 #define MDB_NOTLS 0x200000
284 
285 #define MDB_NOLOCK 0x400000
286 
287 #define MDB_NORDAHEAD 0x800000
288 
289 #define MDB_NOMEMINIT 0x1000000
290 
296 #define MDB_REVERSEKEY 0x02
297 
298 #define MDB_DUPSORT 0x04
299 
301 #define MDB_INTEGERKEY 0x08
302 
303 #define MDB_DUPFIXED 0x10
304 
305 #define MDB_INTEGERDUP 0x20
306 
307 #define MDB_REVERSEDUP 0x40
308 
309 #define MDB_CREATE 0x40000
310 
316 #define MDB_NOOVERWRITE 0x10
317 
321 #define MDB_NODUPDATA 0x20
322 
323 #define MDB_CURRENT 0x40
324 
327 #define MDB_RESERVE 0x10000
328 
329 #define MDB_APPEND 0x20000
330 
331 #define MDB_APPENDDUP 0x40000
332 
333 #define MDB_MULTIPLE 0x80000
334 /* @} */
335 
341 typedef enum MDB_cursor_op {
366 } MDB_cursor_op;
367 
374 #define MDB_SUCCESS 0
375 
376 #define MDB_KEYEXIST (-30799)
377 
378 #define MDB_NOTFOUND (-30798)
379 
380 #define MDB_PAGE_NOTFOUND (-30797)
381 
382 #define MDB_CORRUPTED (-30796)
383 
384 #define MDB_PANIC (-30795)
385 
386 #define MDB_VERSION_MISMATCH (-30794)
387 
388 #define MDB_INVALID (-30793)
389 
390 #define MDB_MAP_FULL (-30792)
391 
392 #define MDB_DBS_FULL (-30791)
393 
394 #define MDB_READERS_FULL (-30790)
395 
396 #define MDB_TLS_FULL (-30789)
397 
398 #define MDB_TXN_FULL (-30788)
399 
400 #define MDB_CURSOR_FULL (-30787)
401 
402 #define MDB_PAGE_FULL (-30786)
403 
404 #define MDB_MAP_RESIZED (-30785)
405 
406 #define MDB_INCOMPATIBLE (-30784)
407 
408 #define MDB_BAD_RSLOT (-30783)
409 
410 #define MDB_BAD_TXN (-30782)
411 
412 #define MDB_BAD_VALSIZE (-30781)
413 #define MDB_LAST_ERRCODE MDB_BAD_VALSIZE
414 
417 typedef struct MDB_stat {
418  unsigned int ms_psize;
420  unsigned int ms_depth;
422  size_t ms_leaf_pages;
424  size_t ms_entries;
425 } MDB_stat;
426 
428 typedef struct MDB_envinfo {
429  void *me_mapaddr;
430  size_t me_mapsize;
431  size_t me_last_pgno;
432  size_t me_last_txnid;
433  unsigned int me_maxreaders;
434  unsigned int me_numreaders;
435 } MDB_envinfo;
436 
444 char *mdb_version(int *major, int *minor, int *patch);
445 
456 char *mdb_strerror(int err);
457 
469 int mdb_env_create(MDB_env **env);
470 
590 int mdb_env_open(MDB_env *env, const char *path, unsigned int flags, mdb_mode_t mode);
591 
606 int mdb_env_copy(MDB_env *env, const char *path);
607 
621 int mdb_env_copyfd(MDB_env *env, mdb_filehandle_t fd);
622 
629 int mdb_env_stat(MDB_env *env, MDB_stat *stat);
630 
637 int mdb_env_info(MDB_env *env, MDB_envinfo *stat);
638 
656 int mdb_env_sync(MDB_env *env, int force);
657 
666 void mdb_env_close(MDB_env *env);
667 
681 int mdb_env_set_flags(MDB_env *env, unsigned int flags, int onoff);
682 
693 int mdb_env_get_flags(MDB_env *env, unsigned int *flags);
694 
707 int mdb_env_get_path(MDB_env *env, const char **path);
708 
719 int mdb_env_get_fd(MDB_env *env, mdb_filehandle_t *fd);
720 
747 int mdb_env_set_mapsize(MDB_env *env, size_t size);
748 
766 int mdb_env_set_maxreaders(MDB_env *env, unsigned int readers);
767 
778 int mdb_env_get_maxreaders(MDB_env *env, unsigned int *readers);
779 
794 int mdb_env_set_maxdbs(MDB_env *env, MDB_dbi dbs);
795 
804 
811 int mdb_env_set_userctx(MDB_env *env, void *ctx);
812 
818 void *mdb_env_get_userctx(MDB_env *env);
819 
826 typedef void MDB_assert_func(MDB_env *env, const char *msg);
827 
836 
871 int mdb_txn_begin(MDB_env *env, MDB_txn *parent, unsigned int flags, MDB_txn **txn);
872 
878 
895 int mdb_txn_commit(MDB_txn *txn);
896 
905 void mdb_txn_abort(MDB_txn *txn);
906 
924 void mdb_txn_reset(MDB_txn *txn);
925 
940 int mdb_txn_renew(MDB_txn *txn);
941 
943 #define mdb_open(txn,name,flags,dbi) mdb_dbi_open(txn,name,flags,dbi)
944 
945 #define mdb_close(env,dbi) mdb_dbi_close(env,dbi)
946 
1010 int mdb_dbi_open(MDB_txn *txn, const char *name, unsigned int flags, MDB_dbi *dbi);
1011 
1024 int mdb_stat(MDB_txn *txn, MDB_dbi dbi, MDB_stat *stat);
1025 
1033 int mdb_dbi_flags(MDB_txn *txn, MDB_dbi dbi, unsigned int *flags);
1034 
1044 void mdb_dbi_close(MDB_env *env, MDB_dbi dbi);
1045 
1054 int mdb_drop(MDB_txn *txn, MDB_dbi dbi, int del);
1055 
1075 int mdb_set_compare(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp);
1076 
1098 int mdb_set_dupsort(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp);
1099 
1118 int mdb_set_relfunc(MDB_txn *txn, MDB_dbi dbi, MDB_rel_func *rel);
1119 
1134 int mdb_set_relctx(MDB_txn *txn, MDB_dbi dbi, void *ctx);
1135 
1162 int mdb_get(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data);
1163 
1211 int mdb_put(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data,
1212  unsigned int flags);
1213 
1236 int mdb_del(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data);
1237 
1260 int mdb_cursor_open(MDB_txn *txn, MDB_dbi dbi, MDB_cursor **cursor);
1261 
1268 void mdb_cursor_close(MDB_cursor *cursor);
1269 
1286 int mdb_cursor_renew(MDB_txn *txn, MDB_cursor *cursor);
1287 
1293 
1298 MDB_dbi mdb_cursor_dbi(MDB_cursor *cursor);
1299 
1319 int mdb_cursor_get(MDB_cursor *cursor, MDB_val *key, MDB_val *data,
1320  MDB_cursor_op op);
1321 
1376 int mdb_cursor_put(MDB_cursor *cursor, MDB_val *key, MDB_val *data,
1377  unsigned int flags);
1378 
1396 int mdb_cursor_del(MDB_cursor *cursor, unsigned int flags);
1397 
1410 int mdb_cursor_count(MDB_cursor *cursor, size_t *countp);
1411 
1422 int mdb_cmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b);
1423 
1434 int mdb_dcmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b);
1435 
1442 typedef int (MDB_msg_func)(const char *msg, void *ctx);
1443 
1451 int mdb_reader_list(MDB_env *env, MDB_msg_func *func, void *ctx);
1452 
1459 int mdb_reader_check(MDB_env *env, int *dead);
1462 #ifdef __cplusplus
1463 }
1464 #endif
1465 #endif /* _LMDB_H_ */
Statistics for a database in the environment.
Definition: lmdb.h:417
int mdb_set_relfunc(MDB_txn *txn, MDB_dbi dbi, MDB_rel_func *rel)
Set a relocation function for a MDB_FIXEDMAP database.
Definition: mdb.c:8362
size_t me_mapsize
Definition: lmdb.h:430
void mdb_cursor_close(MDB_cursor *cursor)
Close a cursor handle.
Definition: mdb.c:6819
int mdb_env_set_assert(MDB_env *env, MDB_assert_func *func)
Definition: mdb.c:7972
Definition: lmdb.h:353
int mdb_del(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data)
Delete items from a database.
Definition: mdb.c:7465
Definition: lmdb.h:348
int mdb_env_set_mapsize(MDB_env *env, size_t size)
Set the size of the memory map to use for this environment.
Definition: mdb.c:3452
Definition: lmdb.h:354
int mdb_dbi_open(MDB_txn *txn, const char *name, unsigned int flags, MDB_dbi *dbi)
Open a database in the environment.
Definition: mdb.c:8079
Definition: lmdb.h:356
char * mdb_version(int *major, int *minor, int *patch)
Return the mdb library version information.
Definition: mdb.c:1173
size_t ms_entries
Definition: lmdb.h:424
int mdb_cursor_count(MDB_cursor *cursor, size_t *countp)
Return count of duplicates for current key.
Definition: mdb.c:6796
int mdb_txn_commit(MDB_txn *txn)
Commit all the operations of a transaction into the database.
Definition: mdb.c:2890
int mdb_cursor_put(MDB_cursor *cursor, MDB_val *key, MDB_val *data, unsigned int flags)
Store by cursor.
Definition: mdb.c:5747
int mdb_stat(MDB_txn *txn, MDB_dbi dbi, MDB_stat *stat)
Retrieve statistics for a database.
Definition: mdb.c:8181
void mdb_dbi_close(MDB_env *env, MDB_dbi dbi)
Close a database handle.
Definition: mdb.c:8195
size_t ms_overflow_pages
Definition: lmdb.h:423
void * mdb_env_get_userctx(MDB_env *env)
Get the application information associated with the MDB_env.
Definition: mdb.c:7966
int mdb_env_get_maxreaders(MDB_env *env, unsigned int *readers)
Get the maximum number of threads/reader slots for the environment.
Definition: mdb.c:3504
size_t mv_size
Definition: lmdb.h:242
MDB_txn * mdb_cursor_txn(MDB_cursor *cursor)
Return the cursor's transaction handle.
Definition: mdb.c:6834
int mdb_set_dupsort(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp)
Set a custom data comparison function for a MDB_DUPSORT database.
Definition: mdb.c:8353
unsigned int ms_psize
Definition: lmdb.h:418
Opaque structure for a transaction handle.
Definition: mdb.c:888
int mdb_env_info(MDB_env *env, MDB_envinfo *stat)
Return information about the MDB environment.
Definition: mdb.c:8034
Opaque structure for navigating through a database.
Definition: mdb.c:968
int mdb_env_set_maxdbs(MDB_env *env, MDB_dbi dbs)
Set the maximum number of named databases for the environment.
Definition: mdb.c:3486
int mdb_env_get_maxkeysize(MDB_env *env)
Get the maximum size of keys and MDB_DUPSORT data we can write.
Definition: mdb.c:8380
MDB_env * mdb_txn_env(MDB_txn *txn)
Returns the transaction's MDB_env.
Definition: mdb.c:2474
Information about the environment.
Definition: lmdb.h:428
void * mv_data
Definition: lmdb.h:243
void MDB_assert_func(MDB_env *env, const char *msg)
A callback function for most MDB assert() failures, called before printing the message and aborting...
Definition: lmdb.h:826
void * me_mapaddr
Definition: lmdb.h:429
Definition: lmdb.h:359
Definition: lmdb.h:346
int mdb_cmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b)
Compare two data items according to a particular database.
Definition: mdb.c:1393
MDB_dbi mdb_cursor_dbi(MDB_cursor *cursor)
Return the cursor's database handle.
Definition: mdb.c:6841
int mdb_reader_list(MDB_env *env, MDB_msg_func *func, void *ctx)
Dump the entries in the reader lock table.
Definition: mdb.c:8385
int( MDB_msg_func)(const char *msg, void *ctx)
A callback function used to print a message from the library.
Definition: lmdb.h:1442
size_t ms_branch_pages
Definition: lmdb.h:421
int mdb_env_copyfd(MDB_env *env, mdb_filehandle_t fd)
Copy an MDB environment to the specified file descriptor.
int mdb_env_get_path(MDB_env *env, const char **path)
Return the path that was used in mdb_env_open().
Definition: mdb.c:7983
Definition: lmdb.h:351
int mdb_env_get_flags(MDB_env *env, unsigned int *flags)
Get environment flags.
Definition: mdb.c:7947
int mdb_drop(MDB_txn *txn, MDB_dbi dbi, int del)
Empty or delete+close a database.
Definition: mdb.c:8298
unsigned int me_maxreaders
Definition: lmdb.h:433
size_t ms_leaf_pages
Definition: lmdb.h:422
int mdb_env_open(MDB_env *env, const char *path, unsigned int flags, mdb_mode_t mode)
Open an environment handle.
Definition: mdb.c:4084
int mdb_env_copy(MDB_env *env, const char *path)
Copy an MDB environment to the specified path.
Definition: mdb.c:4388
void mdb_txn_reset(MDB_txn *txn)
Reset a read-only transaction.
Definition: mdb.c:2561
Definition: lmdb.h:358
int mdb_dbi_flags(MDB_txn *txn, MDB_dbi dbi, unsigned int *flags)
Retrieve the DB flags for a database handle.
Definition: mdb.c:8207
Definition: lmdb.h:363
Definition: lmdb.h:342
int mdb_set_relctx(MDB_txn *txn, MDB_dbi dbi, void *ctx)
Set a context pointer for a MDB_FIXEDMAP database's relocation function.
Definition: mdb.c:8371
size_t me_last_pgno
Definition: lmdb.h:431
Definition: lmdb.h:362
int mdb_txn_renew(MDB_txn *txn)
Renew a read-only transaction.
Definition: mdb.c:2356
int mdb_reader_check(MDB_env *env, int *dead)
Check for stale entries in the reader lock table.
Definition: mdb.c:8461
int mdb_dcmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b)
Compare two data items according to a particular database.
Definition: mdb.c:1399
int mdb_cursor_renew(MDB_txn *txn, MDB_cursor *cursor)
Renew a cursor handle.
Definition: mdb.c:6782
int mdb_set_compare(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp)
Set a custom key comparison function for a database.
Definition: mdb.c:8344
Generic structure used for passing keys and data in and out of the database.
Definition: lmdb.h:241
unsigned int MDB_dbi
A handle for an individual database in the DB environment.
Definition: lmdb.h:225
int mdb_env_sync(MDB_env *env, int force)
Flush the data buffers to disk.
Definition: mdb.c:2079
size_t me_last_txnid
Definition: lmdb.h:432
int mdb_filehandle_t
Definition: lmdb.h:172
int mdb_env_get_fd(MDB_env *env, mdb_filehandle_t *fd)
Return the filedescriptor for the given environment.
Definition: mdb.c:7993
int mdb_txn_begin(MDB_env *env, MDB_txn *parent, unsigned int flags, MDB_txn **txn)
Create a transaction for use with the environment.
Definition: mdb.c:2378
MDB_cursor_op
Cursor Get operations.
Definition: lmdb.h:341
Definition: lmdb.h:360
int mdb_cursor_get(MDB_cursor *cursor, MDB_val *key, MDB_val *data, MDB_cursor_op op)
Retrieve by cursor.
Definition: mdb.c:5551
int mdb_env_create(MDB_env **env)
Create an MDB environment handle.
Definition: mdb.c:3353
unsigned int me_numreaders
Definition: lmdb.h:434
void mdb_txn_abort(MDB_txn *txn)
Abandon all the operations of the transaction instead of saving them.
Definition: mdb.c:2574
mode_t mdb_mode_t
Definition: lmdb.h:162
Definition: lmdb.h:364
Opaque structure for a database environment.
Definition: mdb.c:1027
Definition: lmdb.h:350
int( MDB_cmp_func)(const MDB_val *a, const MDB_val *b)
A callback function used to compare two keys in a database.
Definition: lmdb.h:247
Definition: lmdb.h:347
Definition: lmdb.h:343
void( MDB_rel_func)(MDB_val *item, void *oldptr, void *newptr, void *relctx)
A callback function used to relocate a position-dependent data item in a fixed-address database...
Definition: lmdb.h:263
int mdb_env_stat(MDB_env *env, MDB_stat *stat)
Return statistics about the MDB environment.
Definition: mdb.c:8021
char * mdb_strerror(int err)
Return a string describing a given error code.
Definition: mdb.c:1205
int mdb_env_set_maxreaders(MDB_env *env, unsigned int readers)
Set the maximum number of threads/reader slots for the environment.
Definition: mdb.c:3495
Definition: lmdb.h:365
int mdb_env_set_flags(MDB_env *env, unsigned int flags, int onoff)
Set environment flags.
Definition: mdb.c:7935
int mdb_env_set_userctx(MDB_env *env, void *ctx)
Set application information associated with the MDB_env.
Definition: mdb.c:7957
int mdb_cursor_del(MDB_cursor *cursor, unsigned int flags)
Delete current key/data pair.
Definition: mdb.c:6233
Definition: lmdb.h:345
int mdb_get(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data)
Get items from a database.
Definition: mdb.c:5036
unsigned int ms_depth
Definition: lmdb.h:420
int mdb_put(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data, unsigned int flags)
Store items into a database.
Definition: mdb.c:7915
void mdb_env_close(MDB_env *env)
Close the environment and release the memory map.
Definition: mdb.c:4446
int mdb_cursor_open(MDB_txn *txn, MDB_dbi dbi, MDB_cursor **cursor)
Create a cursor handle.
Definition: mdb.c:6747