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

   1 .TH MDB_COPY 1 "2014/07/01" "LMDB 0.9.14"
   2 .\" Copyright 2012-2018 Howard Chu, Symas Corp. All Rights Reserved.
   3 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   4 .SH NAME
   5 mdb_copy \- LMDB environment copy tool
   6 .SH SYNOPSIS
   7 .B mdb_copy
   8 [\c
   9 .BR \-V ]
  10 [\c
  11 .BR \-c ]
  12 [\c
  13 .BR \-n ]
  14 .B srcpath
  15 [\c
  16 .BR dstpath ]
  17 .SH DESCRIPTION
  18 The
  19 .B mdb_copy
  20 utility copies an LMDB environment. The environment can
  21 be copied regardless of whether it is currently in use.
  22 No lockfile is created, since it gets recreated at need.
  23
  24 If
  25 .I dstpath
  26 is specified it must be the path of an empty directory
  27 for storing the backup. Otherwise, the backup will be
  28 written to stdout.
  29
  30 .SH OPTIONS
  31 .TP
  32 .BR \-V
  33 Write the library version number to the standard output, and exit.
  34 .TP
  35 .BR \-c
  36 Compact while copying. Only current data pages will be copied; freed
  37 or unused pages will be omitted from the copy. This option will
  38 slow down the backup process as it is more CPU-intensive.
  39 Currently it fails if the environment has suffered a page leak.
  40 .TP
  41 .BR \-n
  42 Open LDMB environment(s) which do not use subdirectories.
  43
  44 .SH DIAGNOSTICS
  45 Exit status is zero if no errors occur.
  46 Errors result in a non-zero exit status and
  47 a diagnostic message being written to standard error.
  48 .SH CAVEATS
  49 This utility can trigger significant file size growth if run
  50 in parallel with write transactions, because pages which they
  51 free during copying cannot be reused until the copy is done.
  52 .SH "SEE ALSO"
  53 .BR mdb_stat (1)
  54 .SH AUTHOR
  55 Howard Chu of Symas Corporation <http://www.symas.com>