| 1 |
.TH MDB_DUMP 1 "2015/09/30" "LMDB 0.9.17" |
| 2 |
.\" Copyright 2014-2018 Howard Chu, Symas Corp. All Rights Reserved. |
| 3 |
.\" Copying restrictions apply. See COPYRIGHT/LICENSE. |
| 4 |
.SH NAME |
| 5 |
mdb_dump \- LMDB environment export tool |
| 6 |
.SH SYNOPSIS |
| 7 |
.B mdb_dump |
| 8 |
[\c |
| 9 |
.BR \-V ] |
| 10 |
[\c |
| 11 |
.BI \-f \ file\fR] |
| 12 |
[\c |
| 13 |
.BR \-l ] |
| 14 |
[\c |
| 15 |
.BR \-n ] |
| 16 |
[\c |
| 17 |
.BR \-p ] |
| 18 |
[\c |
| 19 |
.BR \-a \ | |
| 20 |
.BI \-s \ subdb\fR] |
| 21 |
.BR \ envpath |
| 22 |
.SH DESCRIPTION |
| 23 |
The |
| 24 |
.B mdb_dump |
| 25 |
utility reads a database and writes its contents to the |
| 26 |
standard output using a portable flat-text format |
| 27 |
understood by the |
| 28 |
.BR mdb_load (1) |
| 29 |
utility. |
| 30 |
.SH OPTIONS |
| 31 |
.TP |
| 32 |
.BR \-V |
| 33 |
Write the library version number to the standard output, and exit. |
| 34 |
.TP |
| 35 |
.BR \-f \ file |
| 36 |
Write to the specified file instead of to the standard output. |
| 37 |
.TP |
| 38 |
.BR \-l |
| 39 |
List the databases stored in the environment. Just the |
| 40 |
names will be listed, no data will be output. |
| 41 |
.TP |
| 42 |
.BR \-n |
| 43 |
Dump an LMDB database which does not use subdirectories. |
| 44 |
.TP |
| 45 |
.BR \-p |
| 46 |
If characters in either the key or data items are printing characters (as |
| 47 |
defined by isprint(3)), output them directly. This option permits users to |
| 48 |
use standard text editors and tools to modify the contents of databases. |
| 49 |
|
| 50 |
Note: different systems may have different notions about what characters |
| 51 |
are considered printing characters, and databases dumped in this manner may |
| 52 |
be less portable to external systems. |
| 53 |
.TP |
| 54 |
.BR \-a |
| 55 |
Dump all of the subdatabases in the environment. |
| 56 |
.TP |
| 57 |
.BR \-s \ subdb |
| 58 |
Dump a specific subdatabase. If no database is specified, only the main database is dumped. |
| 59 |
.SH DIAGNOSTICS |
| 60 |
Exit status is zero if no errors occur. |
| 61 |
Errors result in a non-zero exit status and |
| 62 |
a diagnostic message being written to standard error. |
| 63 |
|
| 64 |
Dumping and reloading databases that use user-defined comparison functions |
| 65 |
will result in new databases that use the default comparison functions. |
| 66 |
\fBIn this case it is quite likely that the reloaded database will be |
| 67 |
damaged beyond repair permitting neither record storage nor retrieval.\fP |
| 68 |
|
| 69 |
The only available workaround is to modify the source for the |
| 70 |
.BR mdb_load (1) |
| 71 |
utility to load the database using the correct comparison functions. |
| 72 |
.SH "SEE ALSO" |
| 73 |
.BR mdb_load (1) |
| 74 |
.SH AUTHOR |
| 75 |
Howard Chu of Symas Corporation <http://www.symas.com> |