git.sur5r.net Git - openldap/blob - libraries/liblmdb/mdb_dump.1

   1 .TH MDB_DUMP 1 "2014/06/20" "LMDB 0.9.14"
   2 .\" Copyright 2014 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 .BR \ envpath
   9 [\c
  10 .BR \-V ]
  11 [\c
  12 .BI \-f \ file\fR]
  13 [\c
  14 .BR \-l ]
  15 [\c
  16 .BR \-n ]
  17 [\c
  18 .BR \-p ]
  19 [\c
  20 .BR \-a \ |
  21 .BI \-s \ subdb\fR]
  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 defined by isprint(3)), output them directly. This option permits users to use standard text editors and tools to modify the contents of databases.
  47
  48 Note: different systems may have different notions about what characters are considered printing characters, and databases dumped in this manner may be less portable to external systems.
  49 .TP
  50 .BR \-a
  51 Dump all of the subdatabases in the environment.
  52 .TP
  53 .BR \-s \ subdb
  54 Dump a specific subdatabase. If no database is specified, only the main database is dumped.
  55 .SH DIAGNOSTICS
  56 Exit status is zero if no errors occur.
  57 Errors result in a non-zero exit status and
  58 a diagnostic message being written to standard error.
  59
  60 Dumping and reloading databases that use user-defined comparison functions will result in new databases that use the
  61 default comparison functions. \fB In this case it is quite likely that the reloaded database will be damaged beyond
  62 repair permitting neither record storage nor retrieval.\fP
  63
  64 The only available workaround is to modify the source for the
  65 .BR mdb_load (1)
  66 utility to load the database using the correct comparison functions.
  67 .SH "SEE ALSO"
  68 .BR mdb_load (1)
  69 .SH AUTHOR
  70 Howard Chu of Symas Corporation <http://www.symas.com>