@@ -321,6 +321,22 @@ If you're using :ref:`views <views-landing-page>`:
321
321
- To export the documents in a view, use
322
322
:option:`--viewsAsCollections <mongodump --viewsAsCollections>`.
323
323
324
+ Metadata Output
325
+ ~~~~~~~~~~~~~~~
326
+
327
+ If :binary:`~bin.mongodump` outputs to a directory, the output contains
328
+ collection metadata which includes the following properties:
329
+
330
+ - Collection names
331
+ - Collection types
332
+ - Collection configuration options
333
+ - UUIDs
334
+ - Indexes
335
+
336
+ If :binary:`~bin.mongodump` outputs to standard output (``stdout``), the
337
+ output does not include metadata. For more information, see the
338
+ :option:`--out` option.
339
+
324
340
Metadata Format
325
341
~~~~~~~~~~~~~~~
326
342
@@ -794,7 +810,8 @@ Options
794
810
.. option:: --archive=<file>
795
811
796
812
Writes the output to a specified archive file or, if the archive
797
- file is unspecified, writes to the standard output (``stdout``).
813
+ file is unspecified, writes to the standard output (``stdout``). An
814
+ archive file is a single-file alternative to multiple BSON files.
798
815
799
816
- To output the dump to an archive file, run
800
817
:binary:`~bin.mongodump` with the :option:`--archive <mongodump
@@ -816,6 +833,13 @@ Options
816
833
You cannot use the :option:`--archive <mongodump --archive>` option
817
834
with the :option:`--out <mongodump --out>` option.
818
835
836
+ .. note::
837
+
838
+ If :binary:`~bin.mongodump` writes to an archive file,
839
+ ``mongodump`` performance can improve. For more information on
840
+ ``mongodump`` performance impacts, see :ref:`Output Format
841
+ Considerations <considerations-output-format>`.
842
+
819
843
.. option:: --oplog
820
844
821
845
Creates a file named :file:`oplog.bson` as part of the
0 commit comments