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

   1 .TH MDB_LOAD 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_load \- LMDB environment import tool
   6 .SH SYNOPSIS
   7 .B mdb_load
   8 [\c
   9 .BR \-V ]
  10 [\c
  11 .BI \-f \ file\fR]
  12 [\c
  13 .BR \-n ]
  14 [\c
  15 .BI \-s \ subdb\fR]
  16 [\c
  17 .BR \-N ]
  18 [\c
  19 .BR \-T ]
  20 .BR \ envpath
  21 .SH DESCRIPTION
  22 The
  23 .B mdb_load
  24 utility reads from the standard input and loads it into the
  25 LMDB environment
  26 .BR envpath .
  27
  28 The input to
  29 .B mdb_load
  30 must be in the output format specified by the
  31 .BR mdb_dump (1)
  32 utility or as specified by the
  33 .B -T
  34 option below.
  35 .SH OPTIONS
  36 .TP
  37 .BR \-V
  38 Write the library version number to the standard output, and exit.
  39 .TP
  40 .BR \-f \ file
  41 Read from the specified file instead of from the standard input.
  42 .TP
  43 .BR \-n
  44 Load an LMDB database which does not use subdirectories.
  45 .TP
  46 .BR \-s \ subdb
  47 Load a specific subdatabase. If no database is specified, data is loaded into the main database.
  48 .TP
  49 .BR \-N
  50 Don't overwrite existing records when loading into an already existing database; just skip them.
  51 .TP
  52 .BR \-T
  53 Load data from simple text files. The input must be paired lines of text, where the first
  54 line of the pair is the key item, and the second line of the pair is its corresponding
  55 data item.
  56
  57 A simple escape mechanism, where newline and backslash (\\) characters are special, is
  58 applied to the text input. Newline characters are interpreted as record separators.
  59 Backslash characters in the text will be interpreted in one of two ways: If the backslash
  60 character precedes another backslash character, the pair will be interpreted as a literal
  61 backslash. If the backslash character precedes any other character, the two characters
  62 following the backslash will be interpreted as a hexadecimal specification of a single
  63 character; for example, \\0a is a newline character in the ASCII character set.
  64
  65 For this reason, any backslash or newline characters that naturally occur in the text
  66 input must be escaped to avoid misinterpretation by
  67 .BR mdb_load .
  68
  69 .SH DIAGNOSTICS
  70 Exit status is zero if no errors occur.
  71 Errors result in a non-zero exit status and
  72 a diagnostic message being written to standard error.
  73
  74 .SH "SEE ALSO"
  75 .BR mdb_dump (1)
  76 .SH AUTHOR
  77 Howard Chu of Symas Corporation <http://www.symas.com>