MDB
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
lmdb.h
Go to the documentation of this file.
1 
139 #ifndef _LMDB_H_
140 #define _LMDB_H_
141 
142 #include <sys/types.h>
143 
144 #ifdef __cplusplus
145 extern "C" {
146 #endif
147 
149 #ifdef _MSC_VER
150 typedef int mdb_mode_t;
151 #else
152 typedef mode_t mdb_mode_t;
153 #endif
154 
159 #ifdef _WIN32
160 typedef void *mdb_filehandle_t;
161 #else
162 typedef int mdb_filehandle_t;
163 #endif
164 
173 #define MDB_VERSION_MAJOR 0
174 
175 #define MDB_VERSION_MINOR 9
176 
177 #define MDB_VERSION_PATCH 9
178 
180 #define MDB_VERINT(a,b,c) (((a) << 24) | ((b) << 16) | (c))
181 
183 #define MDB_VERSION_FULL \
184  MDB_VERINT(MDB_VERSION_MAJOR,MDB_VERSION_MINOR,MDB_VERSION_PATCH)
185 
187 #define MDB_VERSION_DATE "October 24, 2013"
188 
190 #define MDB_VERSTR(a,b,c,d) "MDB " #a "." #b "." #c ": (" d ")"
191 
193 #define MDB_VERFOO(a,b,c,d) MDB_VERSTR(a,b,c,d)
194 
196 #define MDB_VERSION_STRING \
197  MDB_VERFOO(MDB_VERSION_MAJOR,MDB_VERSION_MINOR,MDB_VERSION_PATCH,MDB_VERSION_DATE)
198 
205 typedef struct MDB_env MDB_env;
206 
212 typedef struct MDB_txn MDB_txn;
213 
215 typedef unsigned int MDB_dbi;
216 
218 typedef struct MDB_cursor MDB_cursor;
219 
231 typedef struct MDB_val {
232  size_t mv_size;
233  void *mv_data;
234 } MDB_val;
235 
237 typedef int (MDB_cmp_func)(const MDB_val *a, const MDB_val *b);
238 
253 typedef void (MDB_rel_func)(MDB_val *item, void *oldptr, void *newptr, void *relctx);
254 
261 #define MDB_FIXEDMAP 0x01
262 
263 #define MDB_NOSUBDIR 0x4000
264 
265 #define MDB_NOSYNC 0x10000
266 
267 #define MDB_RDONLY 0x20000
268 
269 #define MDB_NOMETASYNC 0x40000
270 
271 #define MDB_WRITEMAP 0x80000
272 
273 #define MDB_MAPASYNC 0x100000
274 
275 #define MDB_NOTLS 0x200000
276 
277 #define MDB_NOLOCK 0x400000
278 
279 #define MDB_NORDAHEAD 0x800000
280 
288 #define MDB_REVERSEKEY 0x02
289 
290 #define MDB_DUPSORT 0x04
291 
293 #define MDB_INTEGERKEY 0x08
294 
295 #define MDB_DUPFIXED 0x10
296 
297 #define MDB_INTEGERDUP 0x20
298 
299 #define MDB_REVERSEDUP 0x40
300 
301 #define MDB_CREATE 0x40000
302 
308 #define MDB_NOOVERWRITE 0x10
309 
313 #define MDB_NODUPDATA 0x20
314 
315 #define MDB_CURRENT 0x40
316 
319 #define MDB_RESERVE 0x10000
320 
321 #define MDB_APPEND 0x20000
322 
323 #define MDB_APPENDDUP 0x40000
324 
325 #define MDB_MULTIPLE 0x80000
326 /* @} */
327 
333 typedef enum MDB_cursor_op {
358 } MDB_cursor_op;
359 
366 #define MDB_SUCCESS 0
367 
368 #define MDB_KEYEXIST (-30799)
369 
370 #define MDB_NOTFOUND (-30798)
371 
372 #define MDB_PAGE_NOTFOUND (-30797)
373 
374 #define MDB_CORRUPTED (-30796)
375 
376 #define MDB_PANIC (-30795)
377 
378 #define MDB_VERSION_MISMATCH (-30794)
379 
380 #define MDB_INVALID (-30793)
381 
382 #define MDB_MAP_FULL (-30792)
383 
384 #define MDB_DBS_FULL (-30791)
385 
386 #define MDB_READERS_FULL (-30790)
387 
388 #define MDB_TLS_FULL (-30789)
389 
390 #define MDB_TXN_FULL (-30788)
391 
392 #define MDB_CURSOR_FULL (-30787)
393 
394 #define MDB_PAGE_FULL (-30786)
395 
396 #define MDB_MAP_RESIZED (-30785)
397 
398 #define MDB_INCOMPATIBLE (-30784)
399 
400 #define MDB_BAD_RSLOT (-30783)
401 
402 #define MDB_BAD_TXN (-30782)
403 
404 #define MDB_BAD_VALSIZE (-30781)
405 #define MDB_LAST_ERRCODE MDB_BAD_VALSIZE
406 
409 typedef struct MDB_stat {
410  unsigned int ms_psize;
412  unsigned int ms_depth;
414  size_t ms_leaf_pages;
416  size_t ms_entries;
417 } MDB_stat;
418 
420 typedef struct MDB_envinfo {
421  void *me_mapaddr;
422  size_t me_mapsize;
423  size_t me_last_pgno;
424  size_t me_last_txnid;
425  unsigned int me_maxreaders;
426  unsigned int me_numreaders;
427 } MDB_envinfo;
428 
436 char *mdb_version(int *major, int *minor, int *patch);
437 
448 char *mdb_strerror(int err);
449 
461 int mdb_env_create(MDB_env **env);
462 
563 int mdb_env_open(MDB_env *env, const char *path, unsigned int flags, mdb_mode_t mode);
564 
579 int mdb_env_copy(MDB_env *env, const char *path);
580 
594 int mdb_env_copyfd(MDB_env *env, mdb_filehandle_t fd);
595 
602 int mdb_env_stat(MDB_env *env, MDB_stat *stat);
603 
610 int mdb_env_info(MDB_env *env, MDB_envinfo *stat);
611 
629 int mdb_env_sync(MDB_env *env, int force);
630 
639 void mdb_env_close(MDB_env *env);
640 
654 int mdb_env_set_flags(MDB_env *env, unsigned int flags, int onoff);
655 
666 int mdb_env_get_flags(MDB_env *env, unsigned int *flags);
667 
680 int mdb_env_get_path(MDB_env *env, const char **path);
681 
692 int mdb_env_get_fd(MDB_env *env, mdb_filehandle_t *fd);
693 
720 int mdb_env_set_mapsize(MDB_env *env, size_t size);
721 
739 int mdb_env_set_maxreaders(MDB_env *env, unsigned int readers);
740 
751 int mdb_env_get_maxreaders(MDB_env *env, unsigned int *readers);
752 
767 int mdb_env_set_maxdbs(MDB_env *env, MDB_dbi dbs);
768 
777 
812 int mdb_txn_begin(MDB_env *env, MDB_txn *parent, unsigned int flags, MDB_txn **txn);
813 
819 
836 int mdb_txn_commit(MDB_txn *txn);
837 
846 void mdb_txn_abort(MDB_txn *txn);
847 
865 void mdb_txn_reset(MDB_txn *txn);
866 
881 int mdb_txn_renew(MDB_txn *txn);
882 
884 #define mdb_open(txn,name,flags,dbi) mdb_dbi_open(txn,name,flags,dbi)
885 
886 #define mdb_close(env,dbi) mdb_dbi_close(env,dbi)
887 
951 int mdb_dbi_open(MDB_txn *txn, const char *name, unsigned int flags, MDB_dbi *dbi);
952 
965 int mdb_stat(MDB_txn *txn, MDB_dbi dbi, MDB_stat *stat);
966 
974 int mdb_dbi_flags(MDB_txn *txn, MDB_dbi dbi, unsigned int *flags);
975 
985 void mdb_dbi_close(MDB_env *env, MDB_dbi dbi);
986 
995 int mdb_drop(MDB_txn *txn, MDB_dbi dbi, int del);
996 
1016 int mdb_set_compare(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp);
1017 
1039 int mdb_set_dupsort(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp);
1040 
1059 int mdb_set_relfunc(MDB_txn *txn, MDB_dbi dbi, MDB_rel_func *rel);
1060 
1075 int mdb_set_relctx(MDB_txn *txn, MDB_dbi dbi, void *ctx);
1076 
1103 int mdb_get(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data);
1104 
1150 int mdb_put(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data,
1151  unsigned int flags);
1152 
1175 int mdb_del(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data);
1176 
1199 int mdb_cursor_open(MDB_txn *txn, MDB_dbi dbi, MDB_cursor **cursor);
1200 
1207 void mdb_cursor_close(MDB_cursor *cursor);
1208 
1225 int mdb_cursor_renew(MDB_txn *txn, MDB_cursor *cursor);
1226 
1232 
1237 MDB_dbi mdb_cursor_dbi(MDB_cursor *cursor);
1238 
1258 int mdb_cursor_get(MDB_cursor *cursor, MDB_val *key, MDB_val *data,
1259  MDB_cursor_op op);
1260 
1315 int mdb_cursor_put(MDB_cursor *cursor, MDB_val *key, MDB_val *data,
1316  unsigned int flags);
1317 
1335 int mdb_cursor_del(MDB_cursor *cursor, unsigned int flags);
1336 
1349 int mdb_cursor_count(MDB_cursor *cursor, size_t *countp);
1350 
1361 int mdb_cmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b);
1362 
1373 int mdb_dcmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b);
1374 
1381 typedef int (MDB_msg_func)(const char *msg, void *ctx);
1382 
1390 int mdb_reader_list(MDB_env *env, MDB_msg_func *func, void *ctx);
1391 
1398 int mdb_reader_check(MDB_env *env, int *dead);
1401 #ifdef __cplusplus
1402 }
1403 #endif
1404 #endif /* _LMDB_H_ */