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 10
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 "November 11, 2013"
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 
271 #define MDB_FIXEDMAP 0x01
272 
273 #define MDB_NOSUBDIR 0x4000
274 
275 #define MDB_NOSYNC 0x10000
276 
277 #define MDB_RDONLY 0x20000
278 
279 #define MDB_NOMETASYNC 0x40000
280 
281 #define MDB_WRITEMAP 0x80000
282 
283 #define MDB_MAPASYNC 0x100000
284 
285 #define MDB_NOTLS 0x200000
286 
287 #define MDB_NOLOCK 0x400000
288 
289 #define MDB_NORDAHEAD 0x800000
290 
291 #define MDB_NOMEMINIT 0x1000000
292 
300 #define MDB_REVERSEKEY 0x02
301 
302 #define MDB_DUPSORT 0x04
303 
305 #define MDB_INTEGERKEY 0x08
306 
307 #define MDB_DUPFIXED 0x10
308 
309 #define MDB_INTEGERDUP 0x20
310 
311 #define MDB_REVERSEDUP 0x40
312 
313 #define MDB_CREATE 0x40000
314 
320 #define MDB_NOOVERWRITE 0x10
321 
325 #define MDB_NODUPDATA 0x20
326 
327 #define MDB_CURRENT 0x40
328 
331 #define MDB_RESERVE 0x10000
332 
333 #define MDB_APPEND 0x20000
334 
335 #define MDB_APPENDDUP 0x40000
336 
337 #define MDB_MULTIPLE 0x80000
338 /* @} */
339 
345 typedef enum MDB_cursor_op {
370 } MDB_cursor_op;
371 
378 #define MDB_SUCCESS 0
379 
380 #define MDB_KEYEXIST (-30799)
381 
382 #define MDB_NOTFOUND (-30798)
383 
384 #define MDB_PAGE_NOTFOUND (-30797)
385 
386 #define MDB_CORRUPTED (-30796)
387 
388 #define MDB_PANIC (-30795)
389 
390 #define MDB_VERSION_MISMATCH (-30794)
391 
392 #define MDB_INVALID (-30793)
393 
394 #define MDB_MAP_FULL (-30792)
395 
396 #define MDB_DBS_FULL (-30791)
397 
398 #define MDB_READERS_FULL (-30790)
399 
400 #define MDB_TLS_FULL (-30789)
401 
402 #define MDB_TXN_FULL (-30788)
403 
404 #define MDB_CURSOR_FULL (-30787)
405 
406 #define MDB_PAGE_FULL (-30786)
407 
408 #define MDB_MAP_RESIZED (-30785)
409 
410 #define MDB_INCOMPATIBLE (-30784)
411 
412 #define MDB_BAD_RSLOT (-30783)
413 
414 #define MDB_BAD_TXN (-30782)
415 
416 #define MDB_BAD_VALSIZE (-30781)
417 #define MDB_LAST_ERRCODE MDB_BAD_VALSIZE
418 
421 typedef struct MDB_stat {
422  unsigned int ms_psize;
424  unsigned int ms_depth;
426  size_t ms_leaf_pages;
428  size_t ms_entries;
429 } MDB_stat;
430 
432 typedef struct MDB_envinfo {
433  void *me_mapaddr;
434  size_t me_mapsize;
435  size_t me_last_pgno;
436  size_t me_last_txnid;
437  unsigned int me_maxreaders;
438  unsigned int me_numreaders;
439 } MDB_envinfo;
440 
448 char *mdb_version(int *major, int *minor, int *patch);
449 
460 char *mdb_strerror(int err);
461 
473 int mdb_env_create(MDB_env **env);
474 
594 int mdb_env_open(MDB_env *env, const char *path, unsigned int flags, mdb_mode_t mode);
595 
610 int mdb_env_copy(MDB_env *env, const char *path);
611 
625 int mdb_env_copyfd(MDB_env *env, mdb_filehandle_t fd);
626 
633 int mdb_env_stat(MDB_env *env, MDB_stat *stat);
634 
641 int mdb_env_info(MDB_env *env, MDB_envinfo *stat);
642 
660 int mdb_env_sync(MDB_env *env, int force);
661 
670 void mdb_env_close(MDB_env *env);
671 
685 int mdb_env_set_flags(MDB_env *env, unsigned int flags, int onoff);
686 
697 int mdb_env_get_flags(MDB_env *env, unsigned int *flags);
698 
711 int mdb_env_get_path(MDB_env *env, const char **path);
712 
723 int mdb_env_get_fd(MDB_env *env, mdb_filehandle_t *fd);
724 
751 int mdb_env_set_mapsize(MDB_env *env, size_t size);
752 
770 int mdb_env_set_maxreaders(MDB_env *env, unsigned int readers);
771 
782 int mdb_env_get_maxreaders(MDB_env *env, unsigned int *readers);
783 
798 int mdb_env_set_maxdbs(MDB_env *env, MDB_dbi dbs);
799 
808 
843 int mdb_txn_begin(MDB_env *env, MDB_txn *parent, unsigned int flags, MDB_txn **txn);
844 
850 
867 int mdb_txn_commit(MDB_txn *txn);
868 
877 void mdb_txn_abort(MDB_txn *txn);
878 
896 void mdb_txn_reset(MDB_txn *txn);
897 
912 int mdb_txn_renew(MDB_txn *txn);
913 
915 #define mdb_open(txn,name,flags,dbi) mdb_dbi_open(txn,name,flags,dbi)
916 
917 #define mdb_close(env,dbi) mdb_dbi_close(env,dbi)
918 
982 int mdb_dbi_open(MDB_txn *txn, const char *name, unsigned int flags, MDB_dbi *dbi);
983 
996 int mdb_stat(MDB_txn *txn, MDB_dbi dbi, MDB_stat *stat);
997 
1005 int mdb_dbi_flags(MDB_txn *txn, MDB_dbi dbi, unsigned int *flags);
1006 
1016 void mdb_dbi_close(MDB_env *env, MDB_dbi dbi);
1017 
1026 int mdb_drop(MDB_txn *txn, MDB_dbi dbi, int del);
1027 
1047 int mdb_set_compare(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp);
1048 
1070 int mdb_set_dupsort(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp);
1071 
1090 int mdb_set_relfunc(MDB_txn *txn, MDB_dbi dbi, MDB_rel_func *rel);
1091 
1106 int mdb_set_relctx(MDB_txn *txn, MDB_dbi dbi, void *ctx);
1107 
1134 int mdb_get(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data);
1135 
1183 int mdb_put(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data,
1184  unsigned int flags);
1185 
1208 int mdb_del(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data);
1209 
1232 int mdb_cursor_open(MDB_txn *txn, MDB_dbi dbi, MDB_cursor **cursor);
1233 
1240 void mdb_cursor_close(MDB_cursor *cursor);
1241 
1258 int mdb_cursor_renew(MDB_txn *txn, MDB_cursor *cursor);
1259 
1265 
1270 MDB_dbi mdb_cursor_dbi(MDB_cursor *cursor);
1271 
1291 int mdb_cursor_get(MDB_cursor *cursor, MDB_val *key, MDB_val *data,
1292  MDB_cursor_op op);
1293 
1348 int mdb_cursor_put(MDB_cursor *cursor, MDB_val *key, MDB_val *data,
1349  unsigned int flags);
1350 
1368 int mdb_cursor_del(MDB_cursor *cursor, unsigned int flags);
1369 
1382 int mdb_cursor_count(MDB_cursor *cursor, size_t *countp);
1383 
1394 int mdb_cmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b);
1395 
1406 int mdb_dcmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b);
1407 
1414 typedef int (MDB_msg_func)(const char *msg, void *ctx);
1415 
1423 int mdb_reader_list(MDB_env *env, MDB_msg_func *func, void *ctx);
1424 
1431 int mdb_reader_check(MDB_env *env, int *dead);
1434 #ifdef __cplusplus
1435 }
1436 #endif
1437 #endif /* _LMDB_H_ */
Statistics for a database in the environment.
Definition: lmdb.h:421
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:8244
size_t me_mapsize
Definition: lmdb.h:434
void mdb_cursor_close(MDB_cursor *cursor)
Close a cursor handle.
Definition: mdb.c:6715
Definition: lmdb.h:357
int mdb_del(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data)
Delete items from a database.
Definition: mdb.c:7370
Definition: lmdb.h:352
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:3366
Definition: lmdb.h:358
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:7961
Definition: lmdb.h:360
char * mdb_version(int *major, int *minor, int *patch)
Return the mdb library version information.
Definition: mdb.c:1143
size_t ms_entries
Definition: lmdb.h:428
int mdb_cursor_count(MDB_cursor *cursor, size_t *countp)
Return count of duplicates for current key.
Definition: mdb.c:6692
int mdb_txn_commit(MDB_txn *txn)
Commit all the operations of a transaction into the database.
Definition: mdb.c:2801
int mdb_cursor_put(MDB_cursor *cursor, MDB_val *key, MDB_val *data, unsigned int flags)
Store by cursor.
Definition: mdb.c:5662
int mdb_stat(MDB_txn *txn, MDB_dbi dbi, MDB_stat *stat)
Retrieve statistics for a database.
Definition: mdb.c:8063
void mdb_dbi_close(MDB_env *env, MDB_dbi dbi)
Close a database handle.
Definition: mdb.c:8077
size_t ms_overflow_pages
Definition: lmdb.h:427
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:3418
size_t mv_size
Definition: lmdb.h:242
MDB_txn * mdb_cursor_txn(MDB_cursor *cursor)
Return the cursor&#39;s transaction handle.
Definition: mdb.c:6730
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:8235
unsigned int ms_psize
Definition: lmdb.h:422
Opaque structure for a transaction handle.
Definition: mdb.c:863
int mdb_env_info(MDB_env *env, MDB_envinfo *stat)
Return information about the MDB environment.
Definition: mdb.c:7916
Opaque structure for navigating through a database.
Definition: mdb.c:943
int mdb_env_set_maxdbs(MDB_env *env, MDB_dbi dbs)
Set the maximum number of named databases for the environment.
Definition: mdb.c:3400
int mdb_env_get_maxkeysize(MDB_env *env)
Get the maximum size of a key for the environment.
Definition: mdb.c:8262
MDB_env * mdb_txn_env(MDB_txn *txn)
Returns the transaction&#39;s MDB_env.
Definition: mdb.c:2385
Information about the environment.
Definition: lmdb.h:432
void * mv_data
Definition: lmdb.h:243
void * me_mapaddr
Definition: lmdb.h:433
Definition: lmdb.h:363
Definition: lmdb.h:350
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:1322
MDB_dbi mdb_cursor_dbi(MDB_cursor *cursor)
Return the cursor&#39;s database handle.
Definition: mdb.c:6737
int mdb_reader_list(MDB_env *env, MDB_msg_func *func, void *ctx)
Dump the entries in the reader lock table.
Definition: mdb.c:8267
int( MDB_msg_func)(const char *msg, void *ctx)
A callback function used to print a message from the library.
Definition: lmdb.h:1414
size_t ms_branch_pages
Definition: lmdb.h:425
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:7865
Definition: lmdb.h:355
int mdb_env_get_flags(MDB_env *env, unsigned int *flags)
Get environment flags.
Definition: mdb.c:7855
int mdb_drop(MDB_txn *txn, MDB_dbi dbi, int del)
Empty or delete+close a database.
Definition: mdb.c:8180
unsigned int me_maxreaders
Definition: lmdb.h:437
size_t ms_leaf_pages
Definition: lmdb.h:426
int mdb_env_open(MDB_env *env, const char *path, unsigned int flags, mdb_mode_t mode)
Open an environment handle.
Definition: mdb.c:3989
int mdb_env_copy(MDB_env *env, const char *path)
Copy an MDB environment to the specified path.
Definition: mdb.c:4293
void mdb_txn_reset(MDB_txn *txn)
Reset a read-only transaction.
Definition: mdb.c:2472
Definition: lmdb.h:362
int mdb_dbi_flags(MDB_txn *txn, MDB_dbi dbi, unsigned int *flags)
Retrieve the DB flags for a database handle.
Definition: mdb.c:8089
Definition: lmdb.h:367
Definition: lmdb.h:346
int mdb_set_relctx(MDB_txn *txn, MDB_dbi dbi, void *ctx)
Set a context pointer for a MDB_FIXEDMAP database&#39;s relocation function.
Definition: mdb.c:8253
size_t me_last_pgno
Definition: lmdb.h:435
Definition: lmdb.h:366
int mdb_txn_renew(MDB_txn *txn)
Renew a read-only transaction.
Definition: mdb.c:2267
int mdb_reader_check(MDB_env *env, int *dead)
Check for stale entries in the reader lock table.
Definition: mdb.c:8345
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:1328
int mdb_cursor_renew(MDB_txn *txn, MDB_cursor *cursor)
Renew a cursor handle.
Definition: mdb.c:6678
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:8226
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:1988
size_t me_last_txnid
Definition: lmdb.h:436
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:7875
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:2289
MDB_cursor_op
Cursor Get operations.
Definition: lmdb.h:345
Definition: lmdb.h:364
int mdb_cursor_get(MDB_cursor *cursor, MDB_val *key, MDB_val *data, MDB_cursor_op op)
Retrieve by cursor.
Definition: mdb.c:5465
int mdb_env_create(MDB_env **env)
Create an MDB environment handle.
Definition: mdb.c:3267
unsigned int me_numreaders
Definition: lmdb.h:438
void mdb_txn_abort(MDB_txn *txn)
Abandon all the operations of the transaction instead of saving them.
Definition: mdb.c:2485
mode_t mdb_mode_t
Definition: lmdb.h:162
Definition: lmdb.h:368
Opaque structure for a database environment.
Definition: mdb.c:1002
Definition: lmdb.h:354
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:351
Definition: lmdb.h:347
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:7903
char * mdb_strerror(int err)
Return a string describing a given error code.
Definition: mdb.c:1175
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:3409
Definition: lmdb.h:369
int mdb_env_set_flags(MDB_env *env, unsigned int flags, int onoff)
Set environment flags.
Definition: mdb.c:7843
int mdb_cursor_del(MDB_cursor *cursor, unsigned int flags)
Delete current key/data pair.
Definition: mdb.c:6125
Definition: lmdb.h:349
int mdb_get(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data)
Get items from a database.
Definition: mdb.c:4948
unsigned int ms_depth
Definition: lmdb.h:424
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:7823
void mdb_env_close(MDB_env *env)
Close the environment and release the memory map.
Definition: mdb.c:4351
int mdb_cursor_open(MDB_txn *txn, MDB_dbi dbi, MDB_cursor **cursor)
Create a cursor handle.
Definition: mdb.c:6643