mdb_copy.1 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. .TH MDB_COPY 1 "2014/07/01" "LMDB 0.9.14"
  2. .\" Copyright 2012-2021 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. If
  24. .I dstpath
  25. is specified it must be the path of an empty directory
  26. for storing the backup. Otherwise, the backup will be
  27. written to stdout.
  28. .SH OPTIONS
  29. .TP
  30. .BR \-V
  31. Write the library version number to the standard output, and exit.
  32. .TP
  33. .BR \-c
  34. Compact while copying. Only current data pages will be copied; freed
  35. or unused pages will be omitted from the copy. This option will
  36. slow down the backup process as it is more CPU-intensive.
  37. Currently it fails if the environment has suffered a page leak.
  38. .TP
  39. .BR \-n
  40. Open LDMB environment(s) which do not use subdirectories.
  41. .SH DIAGNOSTICS
  42. Exit status is zero if no errors occur.
  43. Errors result in a non-zero exit status and
  44. a diagnostic message being written to standard error.
  45. .SH CAVEATS
  46. This utility can trigger significant file size growth if run
  47. in parallel with write transactions, because pages which they
  48. free during copying cannot be reused until the copy is done.
  49. .SH "SEE ALSO"
  50. .BR mdb_stat (1)
  51. .SH AUTHOR
  52. Howard Chu of Symas Corporation <http://www.symas.com>