DOCSP-45728-compressors-option (#179)

* DOCSP-45728-compressors-option * review feedback
mongodb · Dec 4, 2024 · 6f05dfe · 6f05dfe
1 parent 3d52400
commit 6f05dfe
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 0 deletions.
diff --git a/source/includes/fact-compressors-option-desc.rst b/source/includes/fact-compressors-option-desc.rst
@@ -0,0 +1,14 @@
+Specifies the compression algorithm used between the MongoDB server and
+|tool-binary|. You can use one or more of these values for the
+``--compressors`` option:
+
+- ``snappy``
+- ``zlib``
+- ``zstd``
+
+If you specify multiple compression algorithms, |tool-binary| uses the
+first one in the list supported by your MongoDB deployment.
+
+For more information on compressors, see the `Go driver network
+compression documentation
+<https://www.mongodb.com/docs/drivers/go/current/fundamentals/connections/network-compression/>`__.
diff --git a/source/mongodump.txt b/source/mongodump.txt
@@ -803,6 +803,10 @@ Options
    view's metadata file in a ``mongorestore`` operation, the view
    is recreated.
 
+.. option:: --compressors=<string>
+
+   .. include:: /includes/fact-compressors-option-desc.rst
+
 Learn More
 ----------
 

diff --git a/source/mongorestore.txt b/source/mongorestore.txt
@@ -869,6 +869,10 @@ Options
 
    - You cannot use the ``--archive`` option with the ``--dir`` option.
 
+.. option:: --compressors=<string>
+
+   .. include:: /includes/fact-compressors-option-desc.rst
+
 
 Learn More
 ----------