LMDB
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
lmdb.h
Go to the documentation of this file.
1 
159 #ifndef _LMDB_H_
160 #define _LMDB_H_
161 
162 #include <sys/types.h>
163 
164 #ifdef __cplusplus
165 extern "C" {
166 #endif
167 
169 #ifdef _MSC_VER
170 typedef int mdb_mode_t;
171 #else
172 typedef mode_t mdb_mode_t;
173 #endif
174 
179 #ifdef _WIN32
180 typedef void *mdb_filehandle_t;
181 #else
182 typedef int mdb_filehandle_t;
183 #endif
184 
193 #define MDB_VERSION_MAJOR 0
194 
195 #define MDB_VERSION_MINOR 9
196 
197 #define MDB_VERSION_PATCH 18
198 
200 #define MDB_VERINT(a,b,c) (((a) << 24) | ((b) << 16) | (c))
201 
203 #define MDB_VERSION_FULL \
204  MDB_VERINT(MDB_VERSION_MAJOR,MDB_VERSION_MINOR,MDB_VERSION_PATCH)
205 
207 #define MDB_VERSION_DATE "December 19, 2015"
208 
210 #define MDB_VERSTR(a,b,c,d) "LMDB " #a "." #b "." #c ": (" d ")"
211 
213 #define MDB_VERFOO(a,b,c,d) MDB_VERSTR(a,b,c,d)
214 
216 #define MDB_VERSION_STRING \
217  MDB_VERFOO(MDB_VERSION_MAJOR,MDB_VERSION_MINOR,MDB_VERSION_PATCH,MDB_VERSION_DATE)
218 
225 typedef struct MDB_env MDB_env;
226 
232 typedef struct MDB_txn MDB_txn;
233 
235 typedef unsigned int MDB_dbi;
236 
238 typedef struct MDB_cursor MDB_cursor;
239 
251 typedef struct MDB_val {
252  size_t mv_size;
253  void *mv_data;
254 } MDB_val;
255 
257 typedef int (MDB_cmp_func)(const MDB_val *a, const MDB_val *b);
258 
273 typedef void (MDB_rel_func)(MDB_val *item, void *oldptr, void *newptr, void *relctx);
274 
279 #define MDB_FIXEDMAP 0x01
280 
281 #define MDB_NOSUBDIR 0x4000
282 
283 #define MDB_NOSYNC 0x10000
284 
285 #define MDB_RDONLY 0x20000
286 
287 #define MDB_NOMETASYNC 0x40000
288 
289 #define MDB_WRITEMAP 0x80000
290 
291 #define MDB_MAPASYNC 0x100000
292 
293 #define MDB_NOTLS 0x200000
294 
295 #define MDB_NOLOCK 0x400000
296 
297 #define MDB_NORDAHEAD 0x800000
298 
299 #define MDB_NOMEMINIT 0x1000000
300 
306 #define MDB_REVERSEKEY 0x02
307 
308 #define MDB_DUPSORT 0x04
309 
311 #define MDB_INTEGERKEY 0x08
312 
313 #define MDB_DUPFIXED 0x10
314 
315 #define MDB_INTEGERDUP 0x20
316 
317 #define MDB_REVERSEDUP 0x40
318 
319 #define MDB_CREATE 0x40000
320 
326 #define MDB_NOOVERWRITE 0x10
327 
331 #define MDB_NODUPDATA 0x20
332 
333 #define MDB_CURRENT 0x40
334 
337 #define MDB_RESERVE 0x10000
338 
339 #define MDB_APPEND 0x20000
340 
341 #define MDB_APPENDDUP 0x40000
342 
343 #define MDB_MULTIPLE 0x80000
344 /* @} */
345 
352 #define MDB_CP_COMPACT 0x01
353 /* @} */
354 
360 typedef enum MDB_cursor_op {
387 } MDB_cursor_op;
388 
395 #define MDB_SUCCESS 0
396 
397 #define MDB_KEYEXIST (-30799)
398 
399 #define MDB_NOTFOUND (-30798)
400 
401 #define MDB_PAGE_NOTFOUND (-30797)
402 
403 #define MDB_CORRUPTED (-30796)
404 
405 #define MDB_PANIC (-30795)
406 
407 #define MDB_VERSION_MISMATCH (-30794)
408 
409 #define MDB_INVALID (-30793)
410 
411 #define MDB_MAP_FULL (-30792)
412 
413 #define MDB_DBS_FULL (-30791)
414 
415 #define MDB_READERS_FULL (-30790)
416 
417 #define MDB_TLS_FULL (-30789)
418 
419 #define MDB_TXN_FULL (-30788)
420 
421 #define MDB_CURSOR_FULL (-30787)
422 
423 #define MDB_PAGE_FULL (-30786)
424 
425 #define MDB_MAP_RESIZED (-30785)
426 
434 #define MDB_INCOMPATIBLE (-30784)
435 
436 #define MDB_BAD_RSLOT (-30783)
437 
438 #define MDB_BAD_TXN (-30782)
439 
440 #define MDB_BAD_VALSIZE (-30781)
441 
442 #define MDB_BAD_DBI (-30780)
443 
444 #define MDB_LAST_ERRCODE MDB_BAD_DBI
445 
448 typedef struct MDB_stat {
449  unsigned int ms_psize;
451  unsigned int ms_depth;
453  size_t ms_leaf_pages;
455  size_t ms_entries;
456 } MDB_stat;
457 
459 typedef struct MDB_envinfo {
460  void *me_mapaddr;
461  size_t me_mapsize;
462  size_t me_last_pgno;
463  size_t me_last_txnid;
464  unsigned int me_maxreaders;
465  unsigned int me_numreaders;
466 } MDB_envinfo;
467 
475 char *mdb_version(int *major, int *minor, int *patch);
476 
487 char *mdb_strerror(int err);
488 
500 int mdb_env_create(MDB_env **env);
501 
621 int mdb_env_open(MDB_env *env, const char *path, unsigned int flags, mdb_mode_t mode);
622 
637 int mdb_env_copy(MDB_env *env, const char *path);
638 
652 int mdb_env_copyfd(MDB_env *env, mdb_filehandle_t fd);
653 
676 int mdb_env_copy2(MDB_env *env, const char *path, unsigned int flags);
677 
695 int mdb_env_copyfd2(MDB_env *env, mdb_filehandle_t fd, unsigned int flags);
696 
703 int mdb_env_stat(MDB_env *env, MDB_stat *stat);
704 
711 int mdb_env_info(MDB_env *env, MDB_envinfo *stat);
712 
732 int mdb_env_sync(MDB_env *env, int force);
733 
742 void mdb_env_close(MDB_env *env);
743 
758 int mdb_env_set_flags(MDB_env *env, unsigned int flags, int onoff);
759 
770 int mdb_env_get_flags(MDB_env *env, unsigned int *flags);
771 
784 int mdb_env_get_path(MDB_env *env, const char **path);
785 
796 int mdb_env_get_fd(MDB_env *env, mdb_filehandle_t *fd);
797 
830 int mdb_env_set_mapsize(MDB_env *env, size_t size);
831 
849 int mdb_env_set_maxreaders(MDB_env *env, unsigned int readers);
850 
861 int mdb_env_get_maxreaders(MDB_env *env, unsigned int *readers);
862 
881 int mdb_env_set_maxdbs(MDB_env *env, MDB_dbi dbs);
882 
891 
898 int mdb_env_set_userctx(MDB_env *env, void *ctx);
899 
905 void *mdb_env_get_userctx(MDB_env *env);
906 
913 typedef void MDB_assert_func(MDB_env *env, const char *msg);
914 
923 
958 int mdb_txn_begin(MDB_env *env, MDB_txn *parent, unsigned int flags, MDB_txn **txn);
959 
965 
975 size_t mdb_txn_id(MDB_txn *txn);
976 
993 int mdb_txn_commit(MDB_txn *txn);
994 
1003 void mdb_txn_abort(MDB_txn *txn);
1004 
1022 void mdb_txn_reset(MDB_txn *txn);
1023 
1038 int mdb_txn_renew(MDB_txn *txn);
1039 
1041 #define mdb_open(txn,name,flags,dbi) mdb_dbi_open(txn,name,flags,dbi)
1042 
1043 #define mdb_close(env,dbi) mdb_dbi_close(env,dbi)
1044 
1112 int mdb_dbi_open(MDB_txn *txn, const char *name, unsigned int flags, MDB_dbi *dbi);
1113 
1126 int mdb_stat(MDB_txn *txn, MDB_dbi dbi, MDB_stat *stat);
1127 
1135 int mdb_dbi_flags(MDB_txn *txn, MDB_dbi dbi, unsigned int *flags);
1136 
1153 void mdb_dbi_close(MDB_env *env, MDB_dbi dbi);
1154 
1164 int mdb_drop(MDB_txn *txn, MDB_dbi dbi, int del);
1165 
1185 int mdb_set_compare(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp);
1186 
1208 int mdb_set_dupsort(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp);
1209 
1228 int mdb_set_relfunc(MDB_txn *txn, MDB_dbi dbi, MDB_rel_func *rel);
1229 
1244 int mdb_set_relctx(MDB_txn *txn, MDB_dbi dbi, void *ctx);
1245 
1272 int mdb_get(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data);
1273 
1321 int mdb_put(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data,
1322  unsigned int flags);
1323 
1346 int mdb_del(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data);
1347 
1370 int mdb_cursor_open(MDB_txn *txn, MDB_dbi dbi, MDB_cursor **cursor);
1371 
1378 void mdb_cursor_close(MDB_cursor *cursor);
1379 
1396 int mdb_cursor_renew(MDB_txn *txn, MDB_cursor *cursor);
1397 
1403 
1408 MDB_dbi mdb_cursor_dbi(MDB_cursor *cursor);
1409 
1429 int mdb_cursor_get(MDB_cursor *cursor, MDB_val *key, MDB_val *data,
1430  MDB_cursor_op op);
1431 
1490 int mdb_cursor_put(MDB_cursor *cursor, MDB_val *key, MDB_val *data,
1491  unsigned int flags);
1492 
1510 int mdb_cursor_del(MDB_cursor *cursor, unsigned int flags);
1511 
1524 int mdb_cursor_count(MDB_cursor *cursor, size_t *countp);
1525 
1536 int mdb_cmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b);
1537 
1548 int mdb_dcmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b);
1549 
1556 typedef int (MDB_msg_func)(const char *msg, void *ctx);
1557 
1565 int mdb_reader_list(MDB_env *env, MDB_msg_func *func, void *ctx);
1566 
1573 int mdb_reader_check(MDB_env *env, int *dead);
1576 #ifdef __cplusplus
1577 }
1578 #endif
1579 
1587 #endif /* _LMDB_H_ */