Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCSP-45728-compressors-option #179

Merged
merged 2 commits into from
Dec 4, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions source/includes/fact-compressors-option-desc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Specify the compression algorithm used between the MongoDB server and
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(parallelism)
Consider "Specifies" rather than "Specify" to create parallelism between this and the other options.

|tool-binary|. You can specify one or more of these values for the
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(word choice)
Maybe "use" or "include" to avoid repeating specify.

``--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/>`__.
4 changes: 4 additions & 0 deletions source/mongodump.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
----------

Expand Down
4 changes: 4 additions & 0 deletions source/mongorestore.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
----------
Expand Down