lmdb 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 38c990ca72b4b416101d10eef8362c018283c53e
4
+ data.tar.gz: db4c4060224dfb0a80c300a0337a7c7b21a22f94
5
+ SHA512:
6
+ metadata.gz: e9d3dc4c9dc912c869b4cd9f8075d5aceee6ff7bbaee9cf279b619307a73a9d7267ec1cd2119089527c574af44d42243d4425d344a5d096ba89930e0eb7364e8
7
+ data.tar.gz: 0916b92cdd120e864427a1bf7d377e8604215accd62a8cfff79739d065750027ee071c29969d376b2c4e269f29bcfb43c7e2c142cf00af90b168f5183fa2df31
data/.gitignore ADDED
@@ -0,0 +1,8 @@
1
+ *.o
2
+ *.so
3
+ .#*
4
+ *.log
5
+ *.mdb
6
+ Makefile
7
+ tmp/
8
+ Gemfile.lock
data/CHANGES ADDED
@@ -0,0 +1,3 @@
1
+ 0.1.0
2
+
3
+ * Initial release
data/CONTRIBUTORS ADDED
@@ -0,0 +1,3 @@
1
+ Daniel Mendler <mail@daniel-mendler.de>
2
+ Dimitrij Denissenko <dimitrij.denissenko@blacksquaremedia.com>
3
+ Evgeniy Dolzhenko <evgeniy.dolzhenko@blacksquaremedia.com>
data/Gemfile ADDED
@@ -0,0 +1,2 @@
1
+ source "https://rubygems.org"
2
+ gemspec
data/README.md ADDED
@@ -0,0 +1,37 @@
1
+ # LMDB
2
+
3
+ Ruby bindings for the amazing OpenLDAP's Lightning Memory-Mapped Database (LLMDB)
4
+ http://symas.com/mdb/
5
+
6
+ ### Installation
7
+
8
+ Install via rubygems:
9
+
10
+ ```ruby
11
+ gem install lmdb
12
+ ```
13
+
14
+ ### Licence (MIT)
15
+
16
+ ```
17
+ Copyright (c) 2013 Daniel Mendler
18
+
19
+ Permission is hereby granted, free of charge, to any person obtaining
20
+ a copy of this software and associated documentation files (the
21
+ "Software"), to deal in the Software without restriction, including
22
+ without limitation the rights to use, copy, modify, merge, publish,
23
+ distribute, sublicense, and/or sell copies of the Software, and to
24
+ permit persons to whom the Software is furnished to do so, subject to
25
+ the following conditions:
26
+
27
+ The above copyright notice and this permission notice shall be
28
+ included in all copies or substantial portions of the Software.
29
+
30
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
31
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
32
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
33
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
34
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
35
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
36
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
37
+ ```
data/Rakefile ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env rake
2
+
3
+ require 'bundler/setup'
4
+ require 'rspec/core/rake_task'
5
+ require "rake/extensiontask"
6
+
7
+ # Install spec tasks
8
+ RSpec::Core::RakeTask.new :spec
9
+
10
+ # Install compile task
11
+ Rake::ExtensionTask.new('lmdb_ext')
12
+
13
+ desc 'Default: compile & run specs.'
14
+ task default: [:compile, :spec]
@@ -0,0 +1,15 @@
1
+ ERROR(SUCCESS)
2
+ ERROR(KEYEXIST)
3
+ ERROR(NOTFOUND)
4
+ ERROR(PAGE_NOTFOUND)
5
+ ERROR(CORRUPTED)
6
+ ERROR(PANIC)
7
+ ERROR(VERSION_MISMATCH)
8
+ ERROR(INVALID)
9
+ ERROR(MAP_FULL)
10
+ ERROR(DBS_FULL)
11
+ ERROR(READERS_FULL)
12
+ ERROR(TLS_FULL)
13
+ ERROR(TXN_FULL)
14
+ ERROR(CURSOR_FULL)
15
+ ERROR(PAGE_FULL)
@@ -0,0 +1,24 @@
1
+ require 'mkmf'
2
+
3
+ # Embed lmdb if we cannot find it
4
+ def have_lmbd
5
+ find_header('lmdb.h') && have_library('lmdb', 'mdb_env_create')
6
+ end
7
+
8
+ if enable_config("bundled-lmdb", false) || !have_lmbd
9
+ $VPATH << "$(srcdir)/liblmdb"
10
+ $INCFLAGS << " -I$(srcdir)/liblmdb"
11
+ $srcs = Dir.glob("#{$srcdir}/{,liblmdb/}*.c").map {|n| File.basename(n) }
12
+
13
+ have_header 'limits.h'
14
+ have_header 'string.h'
15
+ have_header 'stdlib.h'
16
+ have_header 'errno.h'
17
+ have_header 'sys/types.h'
18
+ have_header 'assert.h'
19
+
20
+ have_header 'ruby.h'
21
+ find_header 'lmdb.h'
22
+ end
23
+
24
+ create_makefile('lmdb_ext')
@@ -0,0 +1,16 @@
1
+ mtest
2
+ mtest[23456]
3
+ testdb
4
+ mdb_copy
5
+ mdb_stat
6
+ *.[ao]
7
+ *.so
8
+ *[~#]
9
+ *.bak
10
+ *.orig
11
+ *.rej
12
+ core
13
+ core.*
14
+ valgrind.*
15
+ man/
16
+ html/
@@ -0,0 +1,41 @@
1
+ LMDB 0.9 Change Log
2
+
3
+ LMDB 0.9.8 Engineering
4
+ Allow mdb_env_set_mapsize() on an open environment
5
+ Fix mdb_dbi_flags() (ITS#7672)
6
+ Fix mdb_page_unspill() in nested txns
7
+ Fix mdb_cursor_get(CURRENT|NEXT) after a delete
8
+ Fix mdb_cursor_get(DUP) to always return key (ITS#7671)
9
+ Fix mdb_cursor_del() to always advance to next item (ITS#7670)
10
+ Fix mdb_cursor_set(SET_RANGE) for tree with single page (ITS#7681)
11
+ Fix mdb_env_copy() retry open if O_DIRECT fails (ITS#7682)
12
+ Tweak mdb_page_spill() to be less aggressive
13
+ Documentation
14
+ Update caveats since mdb_reader_check() added in 0.9.7
15
+
16
+ LMDB 0.9.7 Release (2013/08/17)
17
+ Don't leave stale lockfile on failed RDONLY open (ITS#7664)
18
+ Fix mdb_page_split() ref beyond cursor depth
19
+ Fix read txn data race (ITS#7635)
20
+ Fix mdb_rebalance (ITS#7536, #7538)
21
+ Fix mdb_drop() (ITS#7561)
22
+ Misc DEBUG macro fixes
23
+ Add MDB_NOTLS envflag
24
+ Add mdb_env_copyfd()
25
+ Add mdb_txn_env() (ITS#7660)
26
+ Add mdb_dbi_flags() (ITS#7661)
27
+ Add mdb_env_get_maxkeysize()
28
+ Add mdb_env_reader_list()/mdb_env_reader_check()
29
+ Add mdb_page_spill/unspill, remove hard txn size limit
30
+ Use shorter names for semaphores (ITS#7615)
31
+ Build
32
+ Fix install target (ITS#7656)
33
+ Documentation
34
+ Misc updates for cursors, DB handles, data lifetime
35
+
36
+ LMDB 0.9.6 Release (2013/02/25)
37
+ Many fixes/enhancements
38
+
39
+ LMDB 0.9.5 Release (2012/11/30)
40
+ Renamed from libmdb to liblmdb
41
+ Many fixes/enhancements
@@ -0,0 +1,20 @@
1
+ Copyright 2011-2013 Howard Chu, Symas Corp.
2
+ All rights reserved.
3
+
4
+ Redistribution and use in source and binary forms, with or without
5
+ modification, are permitted only as authorized by the OpenLDAP
6
+ Public License.
7
+
8
+ A copy of this license is available in the file LICENSE in the
9
+ top-level directory of the distribution or, alternatively, at
10
+ <http://www.OpenLDAP.org/license.html>.
11
+
12
+ OpenLDAP is a registered trademark of the OpenLDAP Foundation.
13
+
14
+ Individual files and/or contributed packages may be copyright by
15
+ other parties and/or subject to additional restrictions.
16
+
17
+ This work also contains materials derived from public sources.
18
+
19
+ Additional information about OpenLDAP can be obtained at
20
+ <http://www.openldap.org/>.
@@ -0,0 +1,47 @@
1
+ The OpenLDAP Public License
2
+ Version 2.8, 17 August 2003
3
+
4
+ Redistribution and use of this software and associated documentation
5
+ ("Software"), with or without modification, are permitted provided
6
+ that the following conditions are met:
7
+
8
+ 1. Redistributions in source form must retain copyright statements
9
+ and notices,
10
+
11
+ 2. Redistributions in binary form must reproduce applicable copyright
12
+ statements and notices, this list of conditions, and the following
13
+ disclaimer in the documentation and/or other materials provided
14
+ with the distribution, and
15
+
16
+ 3. Redistributions must contain a verbatim copy of this document.
17
+
18
+ The OpenLDAP Foundation may revise this license from time to time.
19
+ Each revision is distinguished by a version number. You may use
20
+ this Software under terms of this license revision or under the
21
+ terms of any subsequent revision of the license.
22
+
23
+ THIS SOFTWARE IS PROVIDED BY THE OPENLDAP FOUNDATION AND ITS
24
+ CONTRIBUTORS ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
25
+ INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
26
+ AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
27
+ SHALL THE OPENLDAP FOUNDATION, ITS CONTRIBUTORS, OR THE AUTHOR(S)
28
+ OR OWNER(S) OF THE SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT,
29
+ INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
30
+ BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
31
+ LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
32
+ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33
+ LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
34
+ ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35
+ POSSIBILITY OF SUCH DAMAGE.
36
+
37
+ The names of the authors and copyright holders must not be used in
38
+ advertising or otherwise to promote the sale, use or other dealing
39
+ in this Software without specific, written prior permission. Title
40
+ to copyright in this Software shall at all times remain with copyright
41
+ holders.
42
+
43
+ OpenLDAP is a registered trademark of the OpenLDAP Foundation.
44
+
45
+ Copyright 1999-2003 The OpenLDAP Foundation, Redwood City,
46
+ California, USA. All Rights Reserved. Permission to copy and
47
+ distribute verbatim copies of this document is granted.
@@ -0,0 +1,1367 @@
1
+ /** @file lmdb.h
2
+ * @brief Lightning memory-mapped database library
3
+ *
4
+ * @mainpage Lightning Memory-Mapped Database Manager (MDB)
5
+ *
6
+ * @section intro_sec Introduction
7
+ * MDB is a Btree-based database management library modeled loosely on the
8
+ * BerkeleyDB API, but much simplified. The entire database is exposed
9
+ * in a memory map, and all data fetches return data directly
10
+ * from the mapped memory, so no malloc's or memcpy's occur during
11
+ * data fetches. As such, the library is extremely simple because it
12
+ * requires no page caching layer of its own, and it is extremely high
13
+ * performance and memory-efficient. It is also fully transactional with
14
+ * full ACID semantics, and when the memory map is read-only, the
15
+ * database integrity cannot be corrupted by stray pointer writes from
16
+ * application code.
17
+ *
18
+ * The library is fully thread-aware and supports concurrent read/write
19
+ * access from multiple processes and threads. Data pages use a copy-on-
20
+ * write strategy so no active data pages are ever overwritten, which
21
+ * also provides resistance to corruption and eliminates the need of any
22
+ * special recovery procedures after a system crash. Writes are fully
23
+ * serialized; only one write transaction may be active at a time, which
24
+ * guarantees that writers can never deadlock. The database structure is
25
+ * multi-versioned so readers run with no locks; writers cannot block
26
+ * readers, and readers don't block writers.
27
+ *
28
+ * Unlike other well-known database mechanisms which use either write-ahead
29
+ * transaction logs or append-only data writes, MDB requires no maintenance
30
+ * during operation. Both write-ahead loggers and append-only databases
31
+ * require periodic checkpointing and/or compaction of their log or database
32
+ * files otherwise they grow without bound. MDB tracks free pages within
33
+ * the database and re-uses them for new write operations, so the database
34
+ * size does not grow without bound in normal use.
35
+ *
36
+ * The memory map can be used as a read-only or read-write map. It is
37
+ * read-only by default as this provides total immunity to corruption.
38
+ * Using read-write mode offers much higher write performance, but adds
39
+ * the possibility for stray application writes thru pointers to silently
40
+ * corrupt the database. Of course if your application code is known to
41
+ * be bug-free (...) then this is not an issue.
42
+ *
43
+ * @section caveats_sec Caveats
44
+ * Troubleshooting the lock file, plus semaphores on BSD systems:
45
+ *
46
+ * - A broken lockfile can cause sync issues.
47
+ * Stale reader transactions left behind by an aborted program
48
+ * cause further writes to grow the database quickly, and
49
+ * stale locks can block further operation.
50
+ *
51
+ * Fix: Check for stale readers periodically, using the
52
+ * #mdb_reader_check function or the mdb_stat tool. Or just
53
+ * make all programs using the database close it; the lockfile
54
+ * is always reset on first open of the environment.
55
+ *
56
+ * - On BSD systems or others configured with MDB_USE_POSIX_SEM,
57
+ * startup can fail due to semaphores owned by another userid.
58
+ *
59
+ * Fix: Open and close the database as the user which owns the
60
+ * semaphores (likely last user) or as root, while no other
61
+ * process is using the database.
62
+ *
63
+ * Restrictions/caveats (in addition to those listed for some functions):
64
+ *
65
+ * - Only the database owner should normally use the database on
66
+ * BSD systems or when otherwise configured with MDB_USE_POSIX_SEM.
67
+ * Multiple users can cause startup to fail later, as noted above.
68
+ *
69
+ * - A thread can only use one transaction at a time, plus any child
70
+ * transactions. Each transaction belongs to one thread. See below.
71
+ * The #MDB_NOTLS flag changes this for read-only transactions.
72
+ *
73
+ * - Use an MDB_env* in the process which opened it, without fork()ing.
74
+ *
75
+ * - Do not have open an MDB database twice in the same process at
76
+ * the same time. Not even from a plain open() call - close()ing it
77
+ * breaks flock() advisory locking.
78
+ *
79
+ * - Avoid long-lived transactions. Read transactions prevent
80
+ * reuse of pages freed by newer write transactions, thus the
81
+ * database can grow quickly. Write transactions prevent
82
+ * other write transactions, since writes are serialized.
83
+ *
84
+ * - Avoid suspending a process with active transactions. These
85
+ * would then be "long-lived" as above. Also read transactions
86
+ * suspended when writers commit could sometimes see wrong data.
87
+ *
88
+ * ...when several processes can use a database concurrently:
89
+ *
90
+ * - Avoid aborting a process with an active transaction.
91
+ * The transaction becomes "long-lived" as above until a check
92
+ * for stale readers is performed or the lockfile is reset,
93
+ * since the process may not remove it from the lockfile.
94
+ *
95
+ * - If you do that anyway, do a periodic check for stale readers. Or
96
+ * close the environment once in a while, so the lockfile can get reset.
97
+ *
98
+ * - Do not use MDB databases on remote filesystems, even between
99
+ * processes on the same host. This breaks flock() on some OSes,
100
+ * possibly memory map sync, and certainly sync between programs
101
+ * on different hosts.
102
+ *
103
+ * - Opening a database can fail if another process is opening or
104
+ * closing it at exactly the same time.
105
+ *
106
+ * @author Howard Chu, Symas Corporation.
107
+ *
108
+ * @copyright Copyright 2011-2013 Howard Chu, Symas Corp. All rights reserved.
109
+ *
110
+ * Redistribution and use in source and binary forms, with or without
111
+ * modification, are permitted only as authorized by the OpenLDAP
112
+ * Public License.
113
+ *
114
+ * A copy of this license is available in the file LICENSE in the
115
+ * top-level directory of the distribution or, alternatively, at
116
+ * <http://www.OpenLDAP.org/license.html>.
117
+ *
118
+ * @par Derived From:
119
+ * This code is derived from btree.c written by Martin Hedenfalk.
120
+ *
121
+ * Copyright (c) 2009, 2010 Martin Hedenfalk <martin@bzero.se>
122
+ *
123
+ * Permission to use, copy, modify, and distribute this software for any
124
+ * purpose with or without fee is hereby granted, provided that the above
125
+ * copyright notice and this permission notice appear in all copies.
126
+ *
127
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
128
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
129
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
130
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
131
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
132
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
133
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
134
+ */
135
+ #ifndef _LMDB_H_
136
+ #define _LMDB_H_
137
+
138
+ #include <sys/types.h>
139
+
140
+ #ifdef __cplusplus
141
+ extern "C" {
142
+ #endif
143
+
144
+ /** Unix permissions for creating files, or dummy definition for Windows */
145
+ #ifdef _MSC_VER
146
+ typedef int mdb_mode_t;
147
+ #else
148
+ typedef mode_t mdb_mode_t;
149
+ #endif
150
+
151
+ /** An abstraction for a file handle.
152
+ * On POSIX systems file handles are small integers. On Windows
153
+ * they're opaque pointers.
154
+ */
155
+ #ifdef _WIN32
156
+ typedef void *mdb_filehandle_t;
157
+ #else
158
+ typedef int mdb_filehandle_t;
159
+ #endif
160
+
161
+ /** @defgroup mdb MDB API
162
+ * @{
163
+ * @brief OpenLDAP Lightning Memory-Mapped Database Manager
164
+ */
165
+ /** @defgroup Version Version Macros
166
+ * @{
167
+ */
168
+ /** Library major version */
169
+ #define MDB_VERSION_MAJOR 0
170
+ /** Library minor version */
171
+ #define MDB_VERSION_MINOR 9
172
+ /** Library patch version */
173
+ #define MDB_VERSION_PATCH 8
174
+
175
+ /** Combine args a,b,c into a single integer for easy version comparisons */
176
+ #define MDB_VERINT(a,b,c) (((a) << 24) | ((b) << 16) | (c))
177
+
178
+ /** The full library version as a single integer */
179
+ #define MDB_VERSION_FULL \
180
+ MDB_VERINT(MDB_VERSION_MAJOR,MDB_VERSION_MINOR,MDB_VERSION_PATCH)
181
+
182
+ /** The release date of this library version */
183
+ #define MDB_VERSION_DATE "August 29, 2013"
184
+
185
+ /** A stringifier for the version info */
186
+ #define MDB_VERSTR(a,b,c,d) "MDB " #a "." #b "." #c ": (" d ")"
187
+
188
+ /** A helper for the stringifier macro */
189
+ #define MDB_VERFOO(a,b,c,d) MDB_VERSTR(a,b,c,d)
190
+
191
+ /** The full library version as a C string */
192
+ #define MDB_VERSION_STRING \
193
+ MDB_VERFOO(MDB_VERSION_MAJOR,MDB_VERSION_MINOR,MDB_VERSION_PATCH,MDB_VERSION_DATE)
194
+ /** @} */
195
+
196
+ /** @brief Opaque structure for a database environment.
197
+ *
198
+ * A DB environment supports multiple databases, all residing in the same
199
+ * shared-memory map.
200
+ */
201
+ typedef struct MDB_env MDB_env;
202
+
203
+ /** @brief Opaque structure for a transaction handle.
204
+ *
205
+ * All database operations require a transaction handle. Transactions may be
206
+ * read-only or read-write.
207
+ */
208
+ typedef struct MDB_txn MDB_txn;
209
+
210
+ /** @brief A handle for an individual database in the DB environment. */
211
+ typedef unsigned int MDB_dbi;
212
+
213
+ /** @brief Opaque structure for navigating through a database */
214
+ typedef struct MDB_cursor MDB_cursor;
215
+
216
+ /** @brief Generic structure used for passing keys and data in and out
217
+ * of the database.
218
+ *
219
+ * Key sizes must be between 1 and the liblmdb build-time constant
220
+ * #MDB_MAXKEYSIZE inclusive. This currently defaults to 511. The
221
+ * same applies to data sizes in databases with the #MDB_DUPSORT flag.
222
+ * Other data items can in theory be from 0 to 0xffffffff bytes long.
223
+ *
224
+ * Values returned from the database are valid only until a subsequent
225
+ * update operation, or the end of the transaction.
226
+ */
227
+ typedef struct MDB_val {
228
+ size_t mv_size; /**< size of the data item */
229
+ void *mv_data; /**< address of the data item */
230
+ } MDB_val;
231
+
232
+ /** @brief A callback function used to compare two keys in a database */
233
+ typedef int (MDB_cmp_func)(const MDB_val *a, const MDB_val *b);
234
+
235
+ /** @brief A callback function used to relocate a position-dependent data item
236
+ * in a fixed-address database.
237
+ *
238
+ * The \b newptr gives the item's desired address in
239
+ * the memory map, and \b oldptr gives its previous address. The item's actual
240
+ * data resides at the address in \b item. This callback is expected to walk
241
+ * through the fields of the record in \b item and modify any
242
+ * values based at the \b oldptr address to be relative to the \b newptr address.
243
+ * @param[in,out] item The item that is to be relocated.
244
+ * @param[in] oldptr The previous address.
245
+ * @param[in] newptr The new address to relocate to.
246
+ * @param[in] relctx An application-provided context, set by #mdb_set_relctx().
247
+ * @todo This feature is currently unimplemented.
248
+ */
249
+ typedef void (MDB_rel_func)(MDB_val *item, void *oldptr, void *newptr, void *relctx);
250
+
251
+ /** @defgroup mdb_env Environment Flags
252
+ *
253
+ * Values do not overlap Database Flags.
254
+ * @{
255
+ */
256
+ /** mmap at a fixed address (experimental) */
257
+ #define MDB_FIXEDMAP 0x01
258
+ /** no environment directory */
259
+ #define MDB_NOSUBDIR 0x4000
260
+ /** don't fsync after commit */
261
+ #define MDB_NOSYNC 0x10000
262
+ /** read only */
263
+ #define MDB_RDONLY 0x20000
264
+ /** don't fsync metapage after commit */
265
+ #define MDB_NOMETASYNC 0x40000
266
+ /** use writable mmap */
267
+ #define MDB_WRITEMAP 0x80000
268
+ /** use asynchronous msync when MDB_WRITEMAP is used */
269
+ #define MDB_MAPASYNC 0x100000
270
+ /** tie reader locktable slots to #MDB_txn objects instead of to threads */
271
+ #define MDB_NOTLS 0x200000
272
+ /** @} */
273
+
274
+ /** @defgroup mdb_dbi_open Database Flags
275
+ *
276
+ * Values do not overlap Environment Flags.
277
+ * @{
278
+ */
279
+ /** use reverse string keys */
280
+ #define MDB_REVERSEKEY 0x02
281
+ /** use sorted duplicates */
282
+ #define MDB_DUPSORT 0x04
283
+ /** numeric keys in native byte order.
284
+ * The keys must all be of the same size. */
285
+ #define MDB_INTEGERKEY 0x08
286
+ /** with #MDB_DUPSORT, sorted dup items have fixed size */
287
+ #define MDB_DUPFIXED 0x10
288
+ /** with #MDB_DUPSORT, dups are numeric in native byte order */
289
+ #define MDB_INTEGERDUP 0x20
290
+ /** with #MDB_DUPSORT, use reverse string dups */
291
+ #define MDB_REVERSEDUP 0x40
292
+ /** create DB if not already existing */
293
+ #define MDB_CREATE 0x40000
294
+ /** @} */
295
+
296
+ /** @defgroup mdb_put Write Flags
297
+ * @{
298
+ */
299
+ /** For put: Don't write if the key already exists. */
300
+ #define MDB_NOOVERWRITE 0x10
301
+ /** Only for #MDB_DUPSORT<br>
302
+ * For put: don't write if the key and data pair already exist.<br>
303
+ * For mdb_cursor_del: remove all duplicate data items.
304
+ */
305
+ #define MDB_NODUPDATA 0x20
306
+ /** For mdb_cursor_put: overwrite the current key/data pair */
307
+ #define MDB_CURRENT 0x40
308
+ /** For put: Just reserve space for data, don't copy it. Return a
309
+ * pointer to the reserved space.
310
+ */
311
+ #define MDB_RESERVE 0x10000
312
+ /** Data is being appended, don't split full pages. */
313
+ #define MDB_APPEND 0x20000
314
+ /** Duplicate data is being appended, don't split full pages. */
315
+ #define MDB_APPENDDUP 0x40000
316
+ /** Store multiple data items in one call. Only for #MDB_DUPFIXED. */
317
+ #define MDB_MULTIPLE 0x80000
318
+ /* @} */
319
+
320
+ /** @brief Cursor Get operations.
321
+ *
322
+ * This is the set of all operations for retrieving data
323
+ * using a cursor.
324
+ */
325
+ typedef enum MDB_cursor_op {
326
+ MDB_FIRST, /**< Position at first key/data item */
327
+ MDB_FIRST_DUP, /**< Position at first data item of current key.
328
+ Only for #MDB_DUPSORT */
329
+ MDB_GET_BOTH, /**< Position at key/data pair. Only for #MDB_DUPSORT */
330
+ MDB_GET_BOTH_RANGE, /**< position at key, nearest data. Only for #MDB_DUPSORT */
331
+ MDB_GET_CURRENT, /**< Return key/data at current cursor position */
332
+ MDB_GET_MULTIPLE, /**< Return all the duplicate data items at the current
333
+ cursor position. Only for #MDB_DUPFIXED */
334
+ MDB_LAST, /**< Position at last key/data item */
335
+ MDB_LAST_DUP, /**< Position at last data item of current key.
336
+ Only for #MDB_DUPSORT */
337
+ MDB_NEXT, /**< Position at next data item */
338
+ MDB_NEXT_DUP, /**< Position at next data item of current key.
339
+ Only for #MDB_DUPSORT */
340
+ MDB_NEXT_MULTIPLE, /**< Return all duplicate data items at the next
341
+ cursor position. Only for #MDB_DUPFIXED */
342
+ MDB_NEXT_NODUP, /**< Position at first data item of next key */
343
+ MDB_PREV, /**< Position at previous data item */
344
+ MDB_PREV_DUP, /**< Position at previous data item of current key.
345
+ Only for #MDB_DUPSORT */
346
+ MDB_PREV_NODUP, /**< Position at last data item of previous key */
347
+ MDB_SET, /**< Position at specified key */
348
+ MDB_SET_KEY, /**< Position at specified key, return key + data */
349
+ MDB_SET_RANGE /**< Position at first key greater than or equal to specified key. */
350
+ } MDB_cursor_op;
351
+
352
+ /** @defgroup errors Return Codes
353
+ *
354
+ * BerkeleyDB uses -30800 to -30999, we'll go under them
355
+ * @{
356
+ */
357
+ /** Successful result */
358
+ #define MDB_SUCCESS 0
359
+ /** key/data pair already exists */
360
+ #define MDB_KEYEXIST (-30799)
361
+ /** key/data pair not found (EOF) */
362
+ #define MDB_NOTFOUND (-30798)
363
+ /** Requested page not found - this usually indicates corruption */
364
+ #define MDB_PAGE_NOTFOUND (-30797)
365
+ /** Located page was wrong type */
366
+ #define MDB_CORRUPTED (-30796)
367
+ /** Update of meta page failed, probably I/O error */
368
+ #define MDB_PANIC (-30795)
369
+ /** Environment version mismatch */
370
+ #define MDB_VERSION_MISMATCH (-30794)
371
+ /** File is not a valid MDB file */
372
+ #define MDB_INVALID (-30793)
373
+ /** Environment mapsize reached */
374
+ #define MDB_MAP_FULL (-30792)
375
+ /** Environment maxdbs reached */
376
+ #define MDB_DBS_FULL (-30791)
377
+ /** Environment maxreaders reached */
378
+ #define MDB_READERS_FULL (-30790)
379
+ /** Too many TLS keys in use - Windows only */
380
+ #define MDB_TLS_FULL (-30789)
381
+ /** Txn has too many dirty pages */
382
+ #define MDB_TXN_FULL (-30788)
383
+ /** Cursor stack too deep - internal error */
384
+ #define MDB_CURSOR_FULL (-30787)
385
+ /** Page has not enough space - internal error */
386
+ #define MDB_PAGE_FULL (-30786)
387
+ /** Database contents grew beyond environment mapsize */
388
+ #define MDB_MAP_RESIZED (-30785)
389
+ /** MDB_INCOMPATIBLE: Operation and DB incompatible, or DB flags changed */
390
+ #define MDB_INCOMPATIBLE (-30784)
391
+ /** Invalid reuse of reader locktable slot */
392
+ #define MDB_BAD_RSLOT (-30783)
393
+ /** Transaction cannot recover - it must be aborted */
394
+ #define MDB_BAD_TXN (-30782)
395
+ /** Too big key/data, key is empty, or wrong DUPFIXED size */
396
+ #define MDB_BAD_VALSIZE (-30781)
397
+ #define MDB_LAST_ERRCODE MDB_BAD_VALSIZE
398
+ /** @} */
399
+
400
+ /** @brief Statistics for a database in the environment */
401
+ typedef struct MDB_stat {
402
+ unsigned int ms_psize; /**< Size of a database page.
403
+ This is currently the same for all databases. */
404
+ unsigned int ms_depth; /**< Depth (height) of the B-tree */
405
+ size_t ms_branch_pages; /**< Number of internal (non-leaf) pages */
406
+ size_t ms_leaf_pages; /**< Number of leaf pages */
407
+ size_t ms_overflow_pages; /**< Number of overflow pages */
408
+ size_t ms_entries; /**< Number of data items */
409
+ } MDB_stat;
410
+
411
+ /** @brief Information about the environment */
412
+ typedef struct MDB_envinfo {
413
+ void *me_mapaddr; /**< Address of map, if fixed */
414
+ size_t me_mapsize; /**< Size of the data memory map */
415
+ size_t me_last_pgno; /**< ID of the last used page */
416
+ size_t me_last_txnid; /**< ID of the last committed transaction */
417
+ unsigned int me_maxreaders; /**< max reader slots in the environment */
418
+ unsigned int me_numreaders; /**< max reader slots used in the environment */
419
+ } MDB_envinfo;
420
+
421
+ /** @brief Return the mdb library version information.
422
+ *
423
+ * @param[out] major if non-NULL, the library major version number is copied here
424
+ * @param[out] minor if non-NULL, the library minor version number is copied here
425
+ * @param[out] patch if non-NULL, the library patch version number is copied here
426
+ * @retval "version string" The library version as a string
427
+ */
428
+ char *mdb_version(int *major, int *minor, int *patch);
429
+
430
+ /** @brief Return a string describing a given error code.
431
+ *
432
+ * This function is a superset of the ANSI C X3.159-1989 (ANSI C) strerror(3)
433
+ * function. If the error code is greater than or equal to 0, then the string
434
+ * returned by the system function strerror(3) is returned. If the error code
435
+ * is less than 0, an error string corresponding to the MDB library error is
436
+ * returned. See @ref errors for a list of MDB-specific error codes.
437
+ * @param[in] err The error code
438
+ * @retval "error message" The description of the error
439
+ */
440
+ char *mdb_strerror(int err);
441
+
442
+ /** @brief Create an MDB environment handle.
443
+ *
444
+ * This function allocates memory for a #MDB_env structure. To release
445
+ * the allocated memory and discard the handle, call #mdb_env_close().
446
+ * Before the handle may be used, it must be opened using #mdb_env_open().
447
+ * Various other options may also need to be set before opening the handle,
448
+ * e.g. #mdb_env_set_mapsize(), #mdb_env_set_maxreaders(), #mdb_env_set_maxdbs(),
449
+ * depending on usage requirements.
450
+ * @param[out] env The address where the new handle will be stored
451
+ * @return A non-zero error value on failure and 0 on success.
452
+ */
453
+ int mdb_env_create(MDB_env **env);
454
+
455
+ /** @brief Open an environment handle.
456
+ *
457
+ * If this function fails, #mdb_env_close() must be called to discard the #MDB_env handle.
458
+ * @param[in] env An environment handle returned by #mdb_env_create()
459
+ * @param[in] path The directory in which the database files reside. This
460
+ * directory must already exist and be writable.
461
+ * @param[in] flags Special options for this environment. This parameter
462
+ * must be set to 0 or by bitwise OR'ing together one or more of the
463
+ * values described here.
464
+ * Flags set by mdb_env_set_flags() are also used.
465
+ * <ul>
466
+ * <li>#MDB_FIXEDMAP
467
+ * use a fixed address for the mmap region. This flag must be specified
468
+ * when creating the environment, and is stored persistently in the environment.
469
+ * If successful, the memory map will always reside at the same virtual address
470
+ * and pointers used to reference data items in the database will be constant
471
+ * across multiple invocations. This option may not always work, depending on
472
+ * how the operating system has allocated memory to shared libraries and other uses.
473
+ * The feature is highly experimental.
474
+ * <li>#MDB_NOSUBDIR
475
+ * By default, MDB creates its environment in a directory whose
476
+ * pathname is given in \b path, and creates its data and lock files
477
+ * under that directory. With this option, \b path is used as-is for
478
+ * the database main data file. The database lock file is the \b path
479
+ * with "-lock" appended.
480
+ * <li>#MDB_RDONLY
481
+ * Open the environment in read-only mode. No write operations will be
482
+ * allowed. MDB will still modify the lock file - except on read-only
483
+ * filesystems, where MDB does not use locks.
484
+ * <li>#MDB_WRITEMAP
485
+ * Use a writeable memory map unless MDB_RDONLY is set. This is faster
486
+ * and uses fewer mallocs, but loses protection from application bugs
487
+ * like wild pointer writes and other bad updates into the database.
488
+ * Incompatible with nested transactions.
489
+ * <li>#MDB_NOMETASYNC
490
+ * Flush system buffers to disk only once per transaction, omit the
491
+ * metadata flush. Defer that until the system flushes files to disk,
492
+ * or next non-MDB_RDONLY commit or #mdb_env_sync(). This optimization
493
+ * maintains database integrity, but a system crash may undo the last
494
+ * committed transaction. I.e. it preserves the ACI (atomicity,
495
+ * consistency, isolation) but not D (durability) database property.
496
+ * This flag may be changed at any time using #mdb_env_set_flags().
497
+ * <li>#MDB_NOSYNC
498
+ * Don't flush system buffers to disk when committing a transaction.
499
+ * This optimization means a system crash can corrupt the database or
500
+ * lose the last transactions if buffers are not yet flushed to disk.
501
+ * The risk is governed by how often the system flushes dirty buffers
502
+ * to disk and how often #mdb_env_sync() is called. However, if the
503
+ * filesystem preserves write order and the #MDB_WRITEMAP flag is not
504
+ * used, transactions exhibit ACI (atomicity, consistency, isolation)
505
+ * properties and only lose D (durability). I.e. database integrity
506
+ * is maintained, but a system crash may undo the final transactions.
507
+ * Note that (#MDB_NOSYNC | #MDB_WRITEMAP) leaves the system with no
508
+ * hint for when to write transactions to disk, unless #mdb_env_sync()
509
+ * is called. (#MDB_MAPASYNC | #MDB_WRITEMAP) may be preferable.
510
+ * This flag may be changed at any time using #mdb_env_set_flags().
511
+ * <li>#MDB_MAPASYNC
512
+ * When using #MDB_WRITEMAP, use asynchronous flushes to disk.
513
+ * As with #MDB_NOSYNC, a system crash can then corrupt the
514
+ * database or lose the last transactions. Calling #mdb_env_sync()
515
+ * ensures on-disk database integrity until next commit.
516
+ * This flag may be changed at any time using #mdb_env_set_flags().
517
+ * <li>#MDB_NOTLS
518
+ * Don't use Thread-Local Storage. Tie reader locktable slots to
519
+ * #MDB_txn objects instead of to threads. I.e. #mdb_txn_reset() keeps
520
+ * the slot reseved for the #MDB_txn object. A thread may use parallel
521
+ * read-only transactions. A read-only transaction may span threads if
522
+ * the user synchronizes its use. Applications that multiplex many
523
+ * user threads over individual OS threads need this option. Such an
524
+ * application must also serialize the write transactions in an OS
525
+ * thread, since MDB's write locking is unaware of the user threads.
526
+ * </ul>
527
+ * @param[in] mode The UNIX permissions to set on created files. This parameter
528
+ * is ignored on Windows.
529
+ * @return A non-zero error value on failure and 0 on success. Some possible
530
+ * errors are:
531
+ * <ul>
532
+ * <li>#MDB_VERSION_MISMATCH - the version of the MDB library doesn't match the
533
+ * version that created the database environment.
534
+ * <li>#MDB_INVALID - the environment file headers are corrupted.
535
+ * <li>ENOENT - the directory specified by the path parameter doesn't exist.
536
+ * <li>EACCES - the user didn't have permission to access the environment files.
537
+ * <li>EAGAIN - the environment was locked by another process.
538
+ * </ul>
539
+ */
540
+ int mdb_env_open(MDB_env *env, const char *path, unsigned int flags, mdb_mode_t mode);
541
+
542
+ /** @brief Copy an MDB environment to the specified path.
543
+ *
544
+ * This function may be used to make a backup of an existing environment.
545
+ * No lockfile is created, since it gets recreated at need.
546
+ * @note This call can trigger significant file size growth if run in
547
+ * parallel with write transactions, because it employs a read-only
548
+ * transaction. See long-lived transactions under @ref caveats_sec.
549
+ * @param[in] env An environment handle returned by #mdb_env_create(). It
550
+ * must have already been opened successfully.
551
+ * @param[in] path The directory in which the copy will reside. This
552
+ * directory must already exist and be writable but must otherwise be
553
+ * empty.
554
+ * @return A non-zero error value on failure and 0 on success.
555
+ */
556
+ int mdb_env_copy(MDB_env *env, const char *path);
557
+
558
+ /** @brief Copy an MDB environment to the specified file descriptor.
559
+ *
560
+ * This function may be used to make a backup of an existing environment.
561
+ * No lockfile is created, since it gets recreated at need.
562
+ * @note This call can trigger significant file size growth if run in
563
+ * parallel with write transactions, because it employs a read-only
564
+ * transaction. See long-lived transactions under @ref caveats_sec.
565
+ * @param[in] env An environment handle returned by #mdb_env_create(). It
566
+ * must have already been opened successfully.
567
+ * @param[in] fd The filedescriptor to write the copy to. It must
568
+ * have already been opened for Write access.
569
+ * @return A non-zero error value on failure and 0 on success.
570
+ */
571
+ int mdb_env_copyfd(MDB_env *env, mdb_filehandle_t fd);
572
+
573
+ /** @brief Return statistics about the MDB environment.
574
+ *
575
+ * @param[in] env An environment handle returned by #mdb_env_create()
576
+ * @param[out] stat The address of an #MDB_stat structure
577
+ * where the statistics will be copied
578
+ */
579
+ int mdb_env_stat(MDB_env *env, MDB_stat *stat);
580
+
581
+ /** @brief Return information about the MDB environment.
582
+ *
583
+ * @param[in] env An environment handle returned by #mdb_env_create()
584
+ * @param[out] stat The address of an #MDB_envinfo structure
585
+ * where the information will be copied
586
+ */
587
+ int mdb_env_info(MDB_env *env, MDB_envinfo *stat);
588
+
589
+ /** @brief Flush the data buffers to disk.
590
+ *
591
+ * Data is always written to disk when #mdb_txn_commit() is called,
592
+ * but the operating system may keep it buffered. MDB always flushes
593
+ * the OS buffers upon commit as well, unless the environment was
594
+ * opened with #MDB_NOSYNC or in part #MDB_NOMETASYNC.
595
+ * @param[in] env An environment handle returned by #mdb_env_create()
596
+ * @param[in] force If non-zero, force a synchronous flush. Otherwise
597
+ * if the environment has the #MDB_NOSYNC flag set the flushes
598
+ * will be omitted, and with #MDB_MAPASYNC they will be asynchronous.
599
+ * @return A non-zero error value on failure and 0 on success. Some possible
600
+ * errors are:
601
+ * <ul>
602
+ * <li>EINVAL - an invalid parameter was specified.
603
+ * <li>EIO - an error occurred during synchronization.
604
+ * </ul>
605
+ */
606
+ int mdb_env_sync(MDB_env *env, int force);
607
+
608
+ /** @brief Close the environment and release the memory map.
609
+ *
610
+ * Only a single thread may call this function. All transactions, databases,
611
+ * and cursors must already be closed before calling this function. Attempts to
612
+ * use any such handles after calling this function will cause a SIGSEGV.
613
+ * The environment handle will be freed and must not be used again after this call.
614
+ * @param[in] env An environment handle returned by #mdb_env_create()
615
+ */
616
+ void mdb_env_close(MDB_env *env);
617
+
618
+ /** @brief Set environment flags.
619
+ *
620
+ * This may be used to set some flags in addition to those from
621
+ * #mdb_env_open(), or to unset these flags.
622
+ * @param[in] env An environment handle returned by #mdb_env_create()
623
+ * @param[in] flags The flags to change, bitwise OR'ed together
624
+ * @param[in] onoff A non-zero value sets the flags, zero clears them.
625
+ * @return A non-zero error value on failure and 0 on success. Some possible
626
+ * errors are:
627
+ * <ul>
628
+ * <li>EINVAL - an invalid parameter was specified.
629
+ * </ul>
630
+ */
631
+ int mdb_env_set_flags(MDB_env *env, unsigned int flags, int onoff);
632
+
633
+ /** @brief Get environment flags.
634
+ *
635
+ * @param[in] env An environment handle returned by #mdb_env_create()
636
+ * @param[out] flags The address of an integer to store the flags
637
+ * @return A non-zero error value on failure and 0 on success. Some possible
638
+ * errors are:
639
+ * <ul>
640
+ * <li>EINVAL - an invalid parameter was specified.
641
+ * </ul>
642
+ */
643
+ int mdb_env_get_flags(MDB_env *env, unsigned int *flags);
644
+
645
+ /** @brief Return the path that was used in #mdb_env_open().
646
+ *
647
+ * @param[in] env An environment handle returned by #mdb_env_create()
648
+ * @param[out] path Address of a string pointer to contain the path. This
649
+ * is the actual string in the environment, not a copy. It should not be
650
+ * altered in any way.
651
+ * @return A non-zero error value on failure and 0 on success. Some possible
652
+ * errors are:
653
+ * <ul>
654
+ * <li>EINVAL - an invalid parameter was specified.
655
+ * </ul>
656
+ */
657
+ int mdb_env_get_path(MDB_env *env, const char **path);
658
+
659
+ /** @brief Set the size of the memory map to use for this environment.
660
+ *
661
+ * The size should be a multiple of the OS page size. The default is
662
+ * 10485760 bytes. The size of the memory map is also the maximum size
663
+ * of the database. The value should be chosen as large as possible,
664
+ * to accommodate future growth of the database.
665
+ * This function should be called after #mdb_env_create() and before #mdb_env_open().
666
+ * It may be called at later times if no transactions are active in
667
+ * this process. Note that the library does not check for this condition,
668
+ * the caller must ensure it explicitly.
669
+ *
670
+ * If the mapsize is changed by another process, #mdb_txn_begin() will
671
+ * return #MDB_MAP_RESIZED. This function may be called with a size
672
+ * of zero to adopt the new size.
673
+ *
674
+ * Any attempt to set a size smaller than the space already consumed
675
+ * by the environment will be silently changed to the current size of the used space.
676
+ * @param[in] env An environment handle returned by #mdb_env_create()
677
+ * @param[in] size The size in bytes
678
+ * @return A non-zero error value on failure and 0 on success. Some possible
679
+ * errors are:
680
+ * <ul>
681
+ * <li>EINVAL - an invalid parameter was specified, or the environment has
682
+ * an active write transaction.
683
+ * </ul>
684
+ */
685
+ int mdb_env_set_mapsize(MDB_env *env, size_t size);
686
+
687
+ /** @brief Set the maximum number of threads/reader slots for the environment.
688
+ *
689
+ * This defines the number of slots in the lock table that is used to track readers in the
690
+ * the environment. The default is 126.
691
+ * Starting a read-only transaction normally ties a lock table slot to the
692
+ * current thread until the environment closes or the thread exits. If
693
+ * MDB_NOTLS is in use, #mdb_txn_begin() instead ties the slot to the
694
+ * MDB_txn object until it or the #MDB_env object is destroyed.
695
+ * This function may only be called after #mdb_env_create() and before #mdb_env_open().
696
+ * @param[in] env An environment handle returned by #mdb_env_create()
697
+ * @param[in] readers The maximum number of reader lock table slots
698
+ * @return A non-zero error value on failure and 0 on success. Some possible
699
+ * errors are:
700
+ * <ul>
701
+ * <li>EINVAL - an invalid parameter was specified, or the environment is already open.
702
+ * </ul>
703
+ */
704
+ int mdb_env_set_maxreaders(MDB_env *env, unsigned int readers);
705
+
706
+ /** @brief Get the maximum number of threads/reader slots for the environment.
707
+ *
708
+ * @param[in] env An environment handle returned by #mdb_env_create()
709
+ * @param[out] readers Address of an integer to store the number of readers
710
+ * @return A non-zero error value on failure and 0 on success. Some possible
711
+ * errors are:
712
+ * <ul>
713
+ * <li>EINVAL - an invalid parameter was specified.
714
+ * </ul>
715
+ */
716
+ int mdb_env_get_maxreaders(MDB_env *env, unsigned int *readers);
717
+
718
+ /** @brief Set the maximum number of named databases for the environment.
719
+ *
720
+ * This function is only needed if multiple databases will be used in the
721
+ * environment. Simpler applications that use the environment as a single
722
+ * unnamed database can ignore this option.
723
+ * This function may only be called after #mdb_env_create() and before #mdb_env_open().
724
+ * @param[in] env An environment handle returned by #mdb_env_create()
725
+ * @param[in] dbs The maximum number of databases
726
+ * @return A non-zero error value on failure and 0 on success. Some possible
727
+ * errors are:
728
+ * <ul>
729
+ * <li>EINVAL - an invalid parameter was specified, or the environment is already open.
730
+ * </ul>
731
+ */
732
+ int mdb_env_set_maxdbs(MDB_env *env, MDB_dbi dbs);
733
+
734
+ /** @brief Get the maximum size of a key for the environment.
735
+ *
736
+ * @param[in] env An environment handle returned by #mdb_env_create()
737
+ * @return The maximum size of a key. (#MDB_MAXKEYSIZE)
738
+ */
739
+ int mdb_env_get_maxkeysize(MDB_env *env);
740
+
741
+ /** @brief Create a transaction for use with the environment.
742
+ *
743
+ * The transaction handle may be discarded using #mdb_txn_abort() or #mdb_txn_commit().
744
+ * @note A transaction and its cursors must only be used by a single
745
+ * thread, and a thread may only have a single transaction at a time.
746
+ * If #MDB_NOTLS is in use, this does not apply to read-only transactions.
747
+ * @note Cursors may not span transactions.
748
+ * @param[in] env An environment handle returned by #mdb_env_create()
749
+ * @param[in] parent If this parameter is non-NULL, the new transaction
750
+ * will be a nested transaction, with the transaction indicated by \b parent
751
+ * as its parent. Transactions may be nested to any level. A parent
752
+ * transaction and its cursors may not issue any other operations than
753
+ * mdb_txn_commit and mdb_txn_abort while it has active child transactions.
754
+ * @param[in] flags Special options for this transaction. This parameter
755
+ * must be set to 0 or by bitwise OR'ing together one or more of the
756
+ * values described here.
757
+ * <ul>
758
+ * <li>#MDB_RDONLY
759
+ * This transaction will not perform any write operations.
760
+ * </ul>
761
+ * @param[out] txn Address where the new #MDB_txn handle will be stored
762
+ * @return A non-zero error value on failure and 0 on success. Some possible
763
+ * errors are:
764
+ * <ul>
765
+ * <li>#MDB_PANIC - a fatal error occurred earlier and the environment
766
+ * must be shut down.
767
+ * <li>#MDB_MAP_RESIZED - another process wrote data beyond this MDB_env's
768
+ * mapsize and this environment's map must be resized as well.
769
+ * See #mdb_env_set_mapsize().
770
+ * <li>#MDB_READERS_FULL - a read-only transaction was requested and
771
+ * the reader lock table is full. See #mdb_env_set_maxreaders().
772
+ * <li>ENOMEM - out of memory.
773
+ * </ul>
774
+ */
775
+ int mdb_txn_begin(MDB_env *env, MDB_txn *parent, unsigned int flags, MDB_txn **txn);
776
+
777
+ /** @brief Returns the transaction's #MDB_env
778
+ *
779
+ * @param[in] txn A transaction handle returned by #mdb_txn_begin()
780
+ */
781
+ MDB_env *mdb_txn_env(MDB_txn *txn);
782
+
783
+ /** @brief Commit all the operations of a transaction into the database.
784
+ *
785
+ * The transaction handle is freed. It and its cursors must not be used
786
+ * again after this call, except with #mdb_cursor_renew().
787
+ * @note Earlier documentation incorrectly said all cursors would be freed.
788
+ * Only write-transactions free cursors.
789
+ * @param[in] txn A transaction handle returned by #mdb_txn_begin()
790
+ * @return A non-zero error value on failure and 0 on success. Some possible
791
+ * errors are:
792
+ * <ul>
793
+ * <li>EINVAL - an invalid parameter was specified.
794
+ * <li>ENOSPC - no more disk space.
795
+ * <li>EIO - a low-level I/O error occurred while writing.
796
+ * <li>ENOMEM - out of memory.
797
+ * </ul>
798
+ */
799
+ int mdb_txn_commit(MDB_txn *txn);
800
+
801
+ /** @brief Abandon all the operations of the transaction instead of saving them.
802
+ *
803
+ * The transaction handle is freed. It and its cursors must not be used
804
+ * again after this call, except with #mdb_cursor_renew().
805
+ * @note Earlier documentation incorrectly said all cursors would be freed.
806
+ * Only write-transactions free cursors.
807
+ * @param[in] txn A transaction handle returned by #mdb_txn_begin()
808
+ */
809
+ void mdb_txn_abort(MDB_txn *txn);
810
+
811
+ /** @brief Reset a read-only transaction.
812
+ *
813
+ * Abort the transaction like #mdb_txn_abort(), but keep the transaction
814
+ * handle. #mdb_txn_renew() may reuse the handle. This saves allocation
815
+ * overhead if the process will start a new read-only transaction soon,
816
+ * and also locking overhead if #MDB_NOTLS is in use. The reader table
817
+ * lock is released, but the table slot stays tied to its thread or
818
+ * #MDB_txn. Use mdb_txn_abort() to discard a reset handle, and to free
819
+ * its lock table slot if MDB_NOTLS is in use.
820
+ * Cursors opened within the transaction must not be used
821
+ * again after this call, except with #mdb_cursor_renew().
822
+ * Reader locks generally don't interfere with writers, but they keep old
823
+ * versions of database pages allocated. Thus they prevent the old pages
824
+ * from being reused when writers commit new data, and so under heavy load
825
+ * the database size may grow much more rapidly than otherwise.
826
+ * @param[in] txn A transaction handle returned by #mdb_txn_begin()
827
+ */
828
+ void mdb_txn_reset(MDB_txn *txn);
829
+
830
+ /** @brief Renew a read-only transaction.
831
+ *
832
+ * This acquires a new reader lock for a transaction handle that had been
833
+ * released by #mdb_txn_reset(). It must be called before a reset transaction
834
+ * may be used again.
835
+ * @param[in] txn A transaction handle returned by #mdb_txn_begin()
836
+ * @return A non-zero error value on failure and 0 on success. Some possible
837
+ * errors are:
838
+ * <ul>
839
+ * <li>#MDB_PANIC - a fatal error occurred earlier and the environment
840
+ * must be shut down.
841
+ * <li>EINVAL - an invalid parameter was specified.
842
+ * </ul>
843
+ */
844
+ int mdb_txn_renew(MDB_txn *txn);
845
+
846
+ /** Compat with version <= 0.9.4, avoid clash with libmdb from MDB Tools project */
847
+ #define mdb_open(txn,name,flags,dbi) mdb_dbi_open(txn,name,flags,dbi)
848
+ /** Compat with version <= 0.9.4, avoid clash with libmdb from MDB Tools project */
849
+ #define mdb_close(env,dbi) mdb_dbi_close(env,dbi)
850
+
851
+ /** @brief Open a database in the environment.
852
+ *
853
+ * A database handle denotes the name and parameters of a database,
854
+ * independently of whether such a database exists.
855
+ * The database handle may be discarded by calling #mdb_dbi_close().
856
+ * The old database handle is returned if the database was already open.
857
+ * The handle must only be closed once.
858
+ * The database handle will be private to the current transaction until
859
+ * the transaction is successfully committed. If the transaction is
860
+ * aborted the handle will be closed automatically.
861
+ * After a successful commit the
862
+ * handle will reside in the shared environment, and may be used
863
+ * by other transactions. This function must not be called from
864
+ * multiple concurrent transactions. A transaction that uses this function
865
+ * must finish (either commit or abort) before any other transaction may
866
+ * use this function.
867
+ *
868
+ * To use named databases (with name != NULL), #mdb_env_set_maxdbs()
869
+ * must be called before opening the environment.
870
+ * @param[in] txn A transaction handle returned by #mdb_txn_begin()
871
+ * @param[in] name The name of the database to open. If only a single
872
+ * database is needed in the environment, this value may be NULL.
873
+ * @param[in] flags Special options for this database. This parameter
874
+ * must be set to 0 or by bitwise OR'ing together one or more of the
875
+ * values described here.
876
+ * <ul>
877
+ * <li>#MDB_REVERSEKEY
878
+ * Keys are strings to be compared in reverse order, from the end
879
+ * of the strings to the beginning. By default, Keys are treated as strings and
880
+ * compared from beginning to end.
881
+ * <li>#MDB_DUPSORT
882
+ * Duplicate keys may be used in the database. (Or, from another perspective,
883
+ * keys may have multiple data items, stored in sorted order.) By default
884
+ * keys must be unique and may have only a single data item.
885
+ * <li>#MDB_INTEGERKEY
886
+ * Keys are binary integers in native byte order. Setting this option
887
+ * requires all keys to be the same size, typically sizeof(int)
888
+ * or sizeof(size_t).
889
+ * <li>#MDB_DUPFIXED
890
+ * This flag may only be used in combination with #MDB_DUPSORT. This option
891
+ * tells the library that the data items for this database are all the same
892
+ * size, which allows further optimizations in storage and retrieval. When
893
+ * all data items are the same size, the #MDB_GET_MULTIPLE and #MDB_NEXT_MULTIPLE
894
+ * cursor operations may be used to retrieve multiple items at once.
895
+ * <li>#MDB_INTEGERDUP
896
+ * This option specifies that duplicate data items are also integers, and
897
+ * should be sorted as such.
898
+ * <li>#MDB_REVERSEDUP
899
+ * This option specifies that duplicate data items should be compared as
900
+ * strings in reverse order.
901
+ * <li>#MDB_CREATE
902
+ * Create the named database if it doesn't exist. This option is not
903
+ * allowed in a read-only transaction or a read-only environment.
904
+ * </ul>
905
+ * @param[out] dbi Address where the new #MDB_dbi handle will be stored
906
+ * @return A non-zero error value on failure and 0 on success. Some possible
907
+ * errors are:
908
+ * <ul>
909
+ * <li>#MDB_NOTFOUND - the specified database doesn't exist in the environment
910
+ * and #MDB_CREATE was not specified.
911
+ * <li>#MDB_DBS_FULL - too many databases have been opened. See #mdb_env_set_maxdbs().
912
+ * </ul>
913
+ */
914
+ int mdb_dbi_open(MDB_txn *txn, const char *name, unsigned int flags, MDB_dbi *dbi);
915
+
916
+ /** @brief Retrieve statistics for a database.
917
+ *
918
+ * @param[in] txn A transaction handle returned by #mdb_txn_begin()
919
+ * @param[in] dbi A database handle returned by #mdb_dbi_open()
920
+ * @param[out] stat The address of an #MDB_stat structure
921
+ * where the statistics will be copied
922
+ * @return A non-zero error value on failure and 0 on success. Some possible
923
+ * errors are:
924
+ * <ul>
925
+ * <li>EINVAL - an invalid parameter was specified.
926
+ * </ul>
927
+ */
928
+ int mdb_stat(MDB_txn *txn, MDB_dbi dbi, MDB_stat *stat);
929
+
930
+ /** @brief Retrieve the DB flags for a database handle.
931
+ *
932
+ * @param[in] txn A transaction handle returned by #mdb_txn_begin()
933
+ * @param[in] dbi A database handle returned by #mdb_dbi_open()
934
+ * @param[out] flags Address where the flags will be returned.
935
+ * @return A non-zero error value on failure and 0 on success.
936
+ */
937
+ int mdb_dbi_flags(MDB_txn *txn, MDB_dbi dbi, unsigned int *flags);
938
+
939
+ /** @brief Close a database handle.
940
+ *
941
+ * This call is not mutex protected. Handles should only be closed by
942
+ * a single thread, and only if no other threads are going to reference
943
+ * the database handle or one of its cursors any further. Do not close
944
+ * a handle if an existing transaction has modified its database.
945
+ * @param[in] env An environment handle returned by #mdb_env_create()
946
+ * @param[in] dbi A database handle returned by #mdb_dbi_open()
947
+ */
948
+ void mdb_dbi_close(MDB_env *env, MDB_dbi dbi);
949
+
950
+ /** @brief Empty or delete+close a database.
951
+ *
952
+ * @param[in] txn A transaction handle returned by #mdb_txn_begin()
953
+ * @param[in] dbi A database handle returned by #mdb_dbi_open()
954
+ * @param[in] del 0 to empty the DB, 1 to delete it from the
955
+ * environment and close the DB handle.
956
+ * @return A non-zero error value on failure and 0 on success.
957
+ */
958
+ int mdb_drop(MDB_txn *txn, MDB_dbi dbi, int del);
959
+
960
+ /** @brief Set a custom key comparison function for a database.
961
+ *
962
+ * The comparison function is called whenever it is necessary to compare a
963
+ * key specified by the application with a key currently stored in the database.
964
+ * If no comparison function is specified, and no special key flags were specified
965
+ * with #mdb_dbi_open(), the keys are compared lexically, with shorter keys collating
966
+ * before longer keys.
967
+ * @warning This function must be called before any data access functions are used,
968
+ * otherwise data corruption may occur. The same comparison function must be used by every
969
+ * program accessing the database, every time the database is used.
970
+ * @param[in] txn A transaction handle returned by #mdb_txn_begin()
971
+ * @param[in] dbi A database handle returned by #mdb_dbi_open()
972
+ * @param[in] cmp A #MDB_cmp_func function
973
+ * @return A non-zero error value on failure and 0 on success. Some possible
974
+ * errors are:
975
+ * <ul>
976
+ * <li>EINVAL - an invalid parameter was specified.
977
+ * </ul>
978
+ */
979
+ int mdb_set_compare(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp);
980
+
981
+ /** @brief Set a custom data comparison function for a #MDB_DUPSORT database.
982
+ *
983
+ * This comparison function is called whenever it is necessary to compare a data
984
+ * item specified by the application with a data item currently stored in the database.
985
+ * This function only takes effect if the database was opened with the #MDB_DUPSORT
986
+ * flag.
987
+ * If no comparison function is specified, and no special key flags were specified
988
+ * with #mdb_dbi_open(), the data items are compared lexically, with shorter items collating
989
+ * before longer items.
990
+ * @warning This function must be called before any data access functions are used,
991
+ * otherwise data corruption may occur. The same comparison function must be used by every
992
+ * program accessing the database, every time the database is used.
993
+ * @param[in] txn A transaction handle returned by #mdb_txn_begin()
994
+ * @param[in] dbi A database handle returned by #mdb_dbi_open()
995
+ * @param[in] cmp A #MDB_cmp_func function
996
+ * @return A non-zero error value on failure and 0 on success. Some possible
997
+ * errors are:
998
+ * <ul>
999
+ * <li>EINVAL - an invalid parameter was specified.
1000
+ * </ul>
1001
+ */
1002
+ int mdb_set_dupsort(MDB_txn *txn, MDB_dbi dbi, MDB_cmp_func *cmp);
1003
+
1004
+ /** @brief Set a relocation function for a #MDB_FIXEDMAP database.
1005
+ *
1006
+ * @todo The relocation function is called whenever it is necessary to move the data
1007
+ * of an item to a different position in the database (e.g. through tree
1008
+ * balancing operations, shifts as a result of adds or deletes, etc.). It is
1009
+ * intended to allow address/position-dependent data items to be stored in
1010
+ * a database in an environment opened with the #MDB_FIXEDMAP option.
1011
+ * Currently the relocation feature is unimplemented and setting
1012
+ * this function has no effect.
1013
+ * @param[in] txn A transaction handle returned by #mdb_txn_begin()
1014
+ * @param[in] dbi A database handle returned by #mdb_dbi_open()
1015
+ * @param[in] rel A #MDB_rel_func function
1016
+ * @return A non-zero error value on failure and 0 on success. Some possible
1017
+ * errors are:
1018
+ * <ul>
1019
+ * <li>EINVAL - an invalid parameter was specified.
1020
+ * </ul>
1021
+ */
1022
+ int mdb_set_relfunc(MDB_txn *txn, MDB_dbi dbi, MDB_rel_func *rel);
1023
+
1024
+ /** @brief Set a context pointer for a #MDB_FIXEDMAP database's relocation function.
1025
+ *
1026
+ * See #mdb_set_relfunc and #MDB_rel_func for more details.
1027
+ * @param[in] txn A transaction handle returned by #mdb_txn_begin()
1028
+ * @param[in] dbi A database handle returned by #mdb_dbi_open()
1029
+ * @param[in] ctx An arbitrary pointer for whatever the application needs.
1030
+ * It will be passed to the callback function set by #mdb_set_relfunc
1031
+ * as its \b relctx parameter whenever the callback is invoked.
1032
+ * @return A non-zero error value on failure and 0 on success. Some possible
1033
+ * errors are:
1034
+ * <ul>
1035
+ * <li>EINVAL - an invalid parameter was specified.
1036
+ * </ul>
1037
+ */
1038
+ int mdb_set_relctx(MDB_txn *txn, MDB_dbi dbi, void *ctx);
1039
+
1040
+ /** @brief Get items from a database.
1041
+ *
1042
+ * This function retrieves key/data pairs from the database. The address
1043
+ * and length of the data associated with the specified \b key are returned
1044
+ * in the structure to which \b data refers.
1045
+ * If the database supports duplicate keys (#MDB_DUPSORT) then the
1046
+ * first data item for the key will be returned. Retrieval of other
1047
+ * items requires the use of #mdb_cursor_get().
1048
+ *
1049
+ * @note The memory pointed to by the returned values is owned by the
1050
+ * database. The caller need not dispose of the memory, and may not
1051
+ * modify it in any way. For values returned in a read-only transaction
1052
+ * any modification attempts will cause a SIGSEGV.
1053
+ * @note Values returned from the database are valid only until a
1054
+ * subsequent update operation, or the end of the transaction.
1055
+ * @param[in] txn A transaction handle returned by #mdb_txn_begin()
1056
+ * @param[in] dbi A database handle returned by #mdb_dbi_open()
1057
+ * @param[in] key The key to search for in the database
1058
+ * @param[out] data The data corresponding to the key
1059
+ * @return A non-zero error value on failure and 0 on success. Some possible
1060
+ * errors are:
1061
+ * <ul>
1062
+ * <li>#MDB_NOTFOUND - the key was not in the database.
1063
+ * <li>EINVAL - an invalid parameter was specified.
1064
+ * </ul>
1065
+ */
1066
+ int mdb_get(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data);
1067
+
1068
+ /** @brief Store items into a database.
1069
+ *
1070
+ * This function stores key/data pairs in the database. The default behavior
1071
+ * is to enter the new key/data pair, replacing any previously existing key
1072
+ * if duplicates are disallowed, or adding a duplicate data item if
1073
+ * duplicates are allowed (#MDB_DUPSORT).
1074
+ * @param[in] txn A transaction handle returned by #mdb_txn_begin()
1075
+ * @param[in] dbi A database handle returned by #mdb_dbi_open()
1076
+ * @param[in] key The key to store in the database
1077
+ * @param[in,out] data The data to store
1078
+ * @param[in] flags Special options for this operation. This parameter
1079
+ * must be set to 0 or by bitwise OR'ing together one or more of the
1080
+ * values described here.
1081
+ * <ul>
1082
+ * <li>#MDB_NODUPDATA - enter the new key/data pair only if it does not
1083
+ * already appear in the database. This flag may only be specified
1084
+ * if the database was opened with #MDB_DUPSORT. The function will
1085
+ * return #MDB_KEYEXIST if the key/data pair already appears in the
1086
+ * database.
1087
+ * <li>#MDB_NOOVERWRITE - enter the new key/data pair only if the key
1088
+ * does not already appear in the database. The function will return
1089
+ * #MDB_KEYEXIST if the key already appears in the database, even if
1090
+ * the database supports duplicates (#MDB_DUPSORT). The \b data
1091
+ * parameter will be set to point to the existing item.
1092
+ * <li>#MDB_RESERVE - reserve space for data of the given size, but
1093
+ * don't copy the given data. Instead, return a pointer to the
1094
+ * reserved space, which the caller can fill in later - before
1095
+ * the next update operation or the transaction ends. This saves
1096
+ * an extra memcpy if the data is being generated later.
1097
+ * <li>#MDB_APPEND - append the given key/data pair to the end of the
1098
+ * database. No key comparisons are performed. This option allows
1099
+ * fast bulk loading when keys are already known to be in the
1100
+ * correct order. Loading unsorted keys with this flag will cause
1101
+ * data corruption.
1102
+ * <li>#MDB_APPENDDUP - as above, but for sorted dup data.
1103
+ * </ul>
1104
+ * @return A non-zero error value on failure and 0 on success. Some possible
1105
+ * errors are:
1106
+ * <ul>
1107
+ * <li>#MDB_MAP_FULL - the database is full, see #mdb_env_set_mapsize().
1108
+ * <li>#MDB_TXN_FULL - the transaction has too many dirty pages.
1109
+ * <li>EACCES - an attempt was made to write in a read-only transaction.
1110
+ * <li>EINVAL - an invalid parameter was specified.
1111
+ * </ul>
1112
+ */
1113
+ int mdb_put(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data,
1114
+ unsigned int flags);
1115
+
1116
+ /** @brief Delete items from a database.
1117
+ *
1118
+ * This function removes key/data pairs from the database.
1119
+ * If the database does not support sorted duplicate data items
1120
+ * (#MDB_DUPSORT) the data parameter is ignored.
1121
+ * If the database supports sorted duplicates and the data parameter
1122
+ * is NULL, all of the duplicate data items for the key will be
1123
+ * deleted. Otherwise, if the data parameter is non-NULL
1124
+ * only the matching data item will be deleted.
1125
+ * This function will return #MDB_NOTFOUND if the specified key/data
1126
+ * pair is not in the database.
1127
+ * @param[in] txn A transaction handle returned by #mdb_txn_begin()
1128
+ * @param[in] dbi A database handle returned by #mdb_dbi_open()
1129
+ * @param[in] key The key to delete from the database
1130
+ * @param[in] data The data to delete
1131
+ * @return A non-zero error value on failure and 0 on success. Some possible
1132
+ * errors are:
1133
+ * <ul>
1134
+ * <li>EACCES - an attempt was made to write in a read-only transaction.
1135
+ * <li>EINVAL - an invalid parameter was specified.
1136
+ * </ul>
1137
+ */
1138
+ int mdb_del(MDB_txn *txn, MDB_dbi dbi, MDB_val *key, MDB_val *data);
1139
+
1140
+ /** @brief Create a cursor handle.
1141
+ *
1142
+ * A cursor is associated with a specific transaction and database.
1143
+ * A cursor cannot be used when its database handle is closed. Nor
1144
+ * when its transaction has ended, except with #mdb_cursor_renew().
1145
+ * It can be discarded with #mdb_cursor_close().
1146
+ * A cursor in a write-transaction can be closed before its transaction
1147
+ * ends, and will otherwise be closed when its transaction ends.
1148
+ * A cursor in a read-only transaction must be closed explicitly, before
1149
+ * or after its transaction ends. It can be reused with
1150
+ * #mdb_cursor_renew() before finally closing it.
1151
+ * @note Earlier documentation said that cursors in every transaction
1152
+ * were closed when the transaction committed or aborted.
1153
+ * @param[in] txn A transaction handle returned by #mdb_txn_begin()
1154
+ * @param[in] dbi A database handle returned by #mdb_dbi_open()
1155
+ * @param[out] cursor Address where the new #MDB_cursor handle will be stored
1156
+ * @return A non-zero error value on failure and 0 on success. Some possible
1157
+ * errors are:
1158
+ * <ul>
1159
+ * <li>EINVAL - an invalid parameter was specified.
1160
+ * </ul>
1161
+ */
1162
+ int mdb_cursor_open(MDB_txn *txn, MDB_dbi dbi, MDB_cursor **cursor);
1163
+
1164
+ /** @brief Close a cursor handle.
1165
+ *
1166
+ * The cursor handle will be freed and must not be used again after this call.
1167
+ * Its transaction must still be live if it is a write-transaction.
1168
+ * @param[in] cursor A cursor handle returned by #mdb_cursor_open()
1169
+ */
1170
+ void mdb_cursor_close(MDB_cursor *cursor);
1171
+
1172
+ /** @brief Renew a cursor handle.
1173
+ *
1174
+ * A cursor is associated with a specific transaction and database.
1175
+ * Cursors that are only used in read-only
1176
+ * transactions may be re-used, to avoid unnecessary malloc/free overhead.
1177
+ * The cursor may be associated with a new read-only transaction, and
1178
+ * referencing the same database handle as it was created with.
1179
+ * This may be done whether the previous transaction is live or dead.
1180
+ * @param[in] txn A transaction handle returned by #mdb_txn_begin()
1181
+ * @param[in] cursor A cursor handle returned by #mdb_cursor_open()
1182
+ * @return A non-zero error value on failure and 0 on success. Some possible
1183
+ * errors are:
1184
+ * <ul>
1185
+ * <li>EINVAL - an invalid parameter was specified.
1186
+ * </ul>
1187
+ */
1188
+ int mdb_cursor_renew(MDB_txn *txn, MDB_cursor *cursor);
1189
+
1190
+ /** @brief Return the cursor's transaction handle.
1191
+ *
1192
+ * @param[in] cursor A cursor handle returned by #mdb_cursor_open()
1193
+ */
1194
+ MDB_txn *mdb_cursor_txn(MDB_cursor *cursor);
1195
+
1196
+ /** @brief Return the cursor's database handle.
1197
+ *
1198
+ * @param[in] cursor A cursor handle returned by #mdb_cursor_open()
1199
+ */
1200
+ MDB_dbi mdb_cursor_dbi(MDB_cursor *cursor);
1201
+
1202
+ /** @brief Retrieve by cursor.
1203
+ *
1204
+ * This function retrieves key/data pairs from the database. The address and length
1205
+ * of the key are returned in the object to which \b key refers (except for the
1206
+ * case of the #MDB_SET option, in which the \b key object is unchanged), and
1207
+ * the address and length of the data are returned in the object to which \b data
1208
+ * refers.
1209
+ * See #mdb_get() for restrictions on using the output values.
1210
+ * @param[in] cursor A cursor handle returned by #mdb_cursor_open()
1211
+ * @param[in,out] key The key for a retrieved item
1212
+ * @param[in,out] data The data of a retrieved item
1213
+ * @param[in] op A cursor operation #MDB_cursor_op
1214
+ * @return A non-zero error value on failure and 0 on success. Some possible
1215
+ * errors are:
1216
+ * <ul>
1217
+ * <li>#MDB_NOTFOUND - no matching key found.
1218
+ * <li>EINVAL - an invalid parameter was specified.
1219
+ * </ul>
1220
+ */
1221
+ int mdb_cursor_get(MDB_cursor *cursor, MDB_val *key, MDB_val *data,
1222
+ MDB_cursor_op op);
1223
+
1224
+ /** @brief Store by cursor.
1225
+ *
1226
+ * This function stores key/data pairs into the database.
1227
+ * If the function fails for any reason, the state of the cursor will be
1228
+ * unchanged. If the function succeeds and an item is inserted into the
1229
+ * database, the cursor is always positioned to refer to the newly inserted item.
1230
+ * @param[in] cursor A cursor handle returned by #mdb_cursor_open()
1231
+ * @param[in] key The key operated on.
1232
+ * @param[in] data The data operated on.
1233
+ * @param[in] flags Options for this operation. This parameter
1234
+ * must be set to 0 or one of the values described here.
1235
+ * <ul>
1236
+ * <li>#MDB_CURRENT - overwrite the data of the key/data pair to which
1237
+ * the cursor refers with the specified data item. The \b key
1238
+ * parameter is ignored.
1239
+ * <li>#MDB_NODUPDATA - enter the new key/data pair only if it does not
1240
+ * already appear in the database. This flag may only be specified
1241
+ * if the database was opened with #MDB_DUPSORT. The function will
1242
+ * return #MDB_KEYEXIST if the key/data pair already appears in the
1243
+ * database.
1244
+ * <li>#MDB_NOOVERWRITE - enter the new key/data pair only if the key
1245
+ * does not already appear in the database. The function will return
1246
+ * #MDB_KEYEXIST if the key already appears in the database, even if
1247
+ * the database supports duplicates (#MDB_DUPSORT).
1248
+ * <li>#MDB_RESERVE - reserve space for data of the given size, but
1249
+ * don't copy the given data. Instead, return a pointer to the
1250
+ * reserved space, which the caller can fill in later. This saves
1251
+ * an extra memcpy if the data is being generated later.
1252
+ * <li>#MDB_APPEND - append the given key/data pair to the end of the
1253
+ * database. No key comparisons are performed. This option allows
1254
+ * fast bulk loading when keys are already known to be in the
1255
+ * correct order. Loading unsorted keys with this flag will cause
1256
+ * data corruption.
1257
+ * <li>#MDB_APPENDDUP - as above, but for sorted dup data.
1258
+ * <li>#MDB_MULTIPLE - store multiple contiguous data elements in a
1259
+ * single request. This flag may only be specified if the database
1260
+ * was opened with #MDB_DUPFIXED. The \b data argument must be an
1261
+ * array of two MDB_vals. The mv_size of the first MDB_val must be
1262
+ * the size of a single data element. The mv_data of the first MDB_val
1263
+ * must point to the beginning of the array of contiguous data elements.
1264
+ * The mv_size of the second MDB_val must be the count of the number
1265
+ * of data elements to store. On return this field will be set to
1266
+ * the count of the number of elements actually written. The mv_data
1267
+ * of the second MDB_val is unused.
1268
+ * </ul>
1269
+ * @return A non-zero error value on failure and 0 on success. Some possible
1270
+ * errors are:
1271
+ * <ul>
1272
+ * <li>#MDB_MAP_FULL - the database is full, see #mdb_env_set_mapsize().
1273
+ * <li>#MDB_TXN_FULL - the transaction has too many dirty pages.
1274
+ * <li>EACCES - an attempt was made to modify a read-only database.
1275
+ * <li>EINVAL - an invalid parameter was specified.
1276
+ * </ul>
1277
+ */
1278
+ int mdb_cursor_put(MDB_cursor *cursor, MDB_val *key, MDB_val *data,
1279
+ unsigned int flags);
1280
+
1281
+ /** @brief Delete current key/data pair
1282
+ *
1283
+ * This function deletes the key/data pair to which the cursor refers.
1284
+ * @param[in] cursor A cursor handle returned by #mdb_cursor_open()
1285
+ * @param[in] flags Options for this operation. This parameter
1286
+ * must be set to 0 or one of the values described here.
1287
+ * <ul>
1288
+ * <li>#MDB_NODUPDATA - delete all of the data items for the current key.
1289
+ * This flag may only be specified if the database was opened with #MDB_DUPSORT.
1290
+ * </ul>
1291
+ * @return A non-zero error value on failure and 0 on success. Some possible
1292
+ * errors are:
1293
+ * <ul>
1294
+ * <li>EACCES - an attempt was made to modify a read-only database.
1295
+ * <li>EINVAL - an invalid parameter was specified.
1296
+ * </ul>
1297
+ */
1298
+ int mdb_cursor_del(MDB_cursor *cursor, unsigned int flags);
1299
+
1300
+ /** @brief Return count of duplicates for current key.
1301
+ *
1302
+ * This call is only valid on databases that support sorted duplicate
1303
+ * data items #MDB_DUPSORT.
1304
+ * @param[in] cursor A cursor handle returned by #mdb_cursor_open()
1305
+ * @param[out] countp Address where the count will be stored
1306
+ * @return A non-zero error value on failure and 0 on success. Some possible
1307
+ * errors are:
1308
+ * <ul>
1309
+ * <li>EINVAL - cursor is not initialized, or an invalid parameter was specified.
1310
+ * </ul>
1311
+ */
1312
+ int mdb_cursor_count(MDB_cursor *cursor, size_t *countp);
1313
+
1314
+ /** @brief Compare two data items according to a particular database.
1315
+ *
1316
+ * This returns a comparison as if the two data items were keys in the
1317
+ * specified database.
1318
+ * @param[in] txn A transaction handle returned by #mdb_txn_begin()
1319
+ * @param[in] dbi A database handle returned by #mdb_dbi_open()
1320
+ * @param[in] a The first item to compare
1321
+ * @param[in] b The second item to compare
1322
+ * @return < 0 if a < b, 0 if a == b, > 0 if a > b
1323
+ */
1324
+ int mdb_cmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b);
1325
+
1326
+ /** @brief Compare two data items according to a particular database.
1327
+ *
1328
+ * This returns a comparison as if the two items were data items of
1329
+ * the specified database. The database must have the #MDB_DUPSORT flag.
1330
+ * @param[in] txn A transaction handle returned by #mdb_txn_begin()
1331
+ * @param[in] dbi A database handle returned by #mdb_dbi_open()
1332
+ * @param[in] a The first item to compare
1333
+ * @param[in] b The second item to compare
1334
+ * @return < 0 if a < b, 0 if a == b, > 0 if a > b
1335
+ */
1336
+ int mdb_dcmp(MDB_txn *txn, MDB_dbi dbi, const MDB_val *a, const MDB_val *b);
1337
+
1338
+ /** @brief A callback function used to print a message from the library.
1339
+ *
1340
+ * @param[in] msg The string to be printed.
1341
+ * @param[in] ctx An arbitrary context pointer for the callback.
1342
+ * @return < 0 on failure, 0 on success.
1343
+ */
1344
+ typedef int (MDB_msg_func)(const char *msg, void *ctx);
1345
+
1346
+ /** @brief Dump the entries in the reader lock table.
1347
+ *
1348
+ * @param[in] env An environment handle returned by #mdb_env_create()
1349
+ * @param[in] func A #MDB_msg_func function
1350
+ * @param[in] ctx Anything the message function needs
1351
+ * @return < 0 on failure, 0 on success.
1352
+ */
1353
+ int mdb_reader_list(MDB_env *env, MDB_msg_func *func, void *ctx);
1354
+
1355
+ /** @brief Check for stale entries in the reader lock table.
1356
+ *
1357
+ * @param[in] env An environment handle returned by #mdb_env_create()
1358
+ * @param[out] dead Number of stale slots that were cleared
1359
+ * @return 0 on success, non-zero on failure.
1360
+ */
1361
+ int mdb_reader_check(MDB_env *env, int *dead);
1362
+ /** @} */
1363
+
1364
+ #ifdef __cplusplus
1365
+ }
1366
+ #endif
1367
+ #endif /* _LMDB_H_ */