Skip to content

DOCS-10958 networkMessageCompressors disabled by default in shell. #3083

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.

Sign up for GitHub

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

Closed
wants to merge 1 commit into from
Closed

DOCS-10958 networkMessageCompressors disabled by default in shell. #3083

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion source/includes/fact-networkMessageCompressors.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

You can specify the following compressors:

- :term:`snappy` (Default)
- :term:`snappy`

- :term:`zlib`

Expand Down
11 changes: 7 additions & 4 deletions source/includes/options-conf.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -707,19 +707,22 @@ description: |
.. versionadded:: 3.4

.. versionchanged:: 3.6
\

- Add support for :term:`zlib` compressor.
- Add support for :term:`zlib` compressor.

- Enabled by default. To disable, set to ``disabled``.
- Enabled by default using the :term:`snappy` compressor. To
Copy link
Contributor

Choose a reason for hiding this comment

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

sounds like we use the snappy compressor to enable this feature.

maybe:
MongoDB enables snappy network compression for communication, by default. To disable compression ...

disable compression, set this option to ``disabled``.

Enables network compression for communication between this
:program:`mongod` or :program:`mongos` instance and:

- other members in the deployment, if a member of a replica set or a
sharded cluster

- a :program:`mongo` shell

- a :program:`mongo` shell when network compression is enabled
(disabled by default)
Copy link
Contributor

Choose a reason for hiding this comment

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

the phrase "when network compression is enabled (disabled by default)":

-- unclear that you are referring to mongo shell's compression enablement
-- given that this is followed by a blurb that states that both sides must have this feature enabled (whether other members of sharded cluster, etc), it's unnecessary as stated. We can either just state that mongo shell disables this feature by default. or just remove it all together.


- drivers that support the ``OP_COMPRESSED`` message format.

.. include:: /includes/fact-networkMessageCompressors.rst
Expand Down
4 changes: 3 additions & 1 deletion source/includes/options-mongo.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -411,9 +411,11 @@ description: |
.. versionadded:: 3.4

.. versionchanged:: 3.6
\

- Add support for :term:`zlib` compressor.
- Enabled by default. To disable, set to ``disabled``.

- Disabled by default in the :program:`mongo` shell.
Copy link
Contributor

Choose a reason for hiding this comment

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

So, it was disabled in the mongo shell in 3.4. So, this probably doesn't need to be in part of the 3.6 changes


Enables network compression for communication between this
{{program}} shell and:
Expand Down
10 changes: 7 additions & 3 deletions source/includes/options-mongod.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2624,9 +2624,12 @@ description: |
.. versionadded:: 3.4

.. versionchanged:: 3.6
\

- Add support for :term:`zlib` compressor.
- Enabled by default. To disable, set to ``disabled``.
- Add support for :term:`zlib` compressor.

- Enabled by default using the :term:`snappy` compressor. To
Copy link
Contributor

Choose a reason for hiding this comment

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

sounds like we use the snappy compressor to enable this feature.

disable compression, set this option to ``disabled``.

Enables network compression for communication between this
{{program}} instance and:
Expand All @@ -2637,7 +2640,8 @@ description: |
- other members of the sharded cluster, if the instance is part of a
sharded cluster

- a :program:`mongo` shell,
- a :program:`mongo` shell when network compression is enabled
Copy link
Contributor

Choose a reason for hiding this comment

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

same as before.

(disabled by default)

- drivers that support the ``OP_COMPRESSED`` message format.

Expand Down
11 changes: 9 additions & 2 deletions source/includes/options-mongos.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -486,15 +486,22 @@ description: |
.. versionadded:: 3.4

.. versionchanged:: 3.6
\

Add support for :term:`zlib` compressor.
- Add support for :term:`zlib` compressor.

- Enabled by default using the :term:`snappy` compressor. To
Copy link
Contributor

Choose a reason for hiding this comment

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

same as before.

disable compression, set this option to ``disabled``.

Enables network compression for communication between this
{{program}} instance and:

- other members of the sharded cluster

- a :program:`mongo` shell.
- a :program:`mongo` shell when network compression is enabled
Copy link
Contributor

Choose a reason for hiding this comment

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

ditto.

(disabled by default)

- drivers that support the ``OP_COMPRESSED`` message format.

.. include:: /includes/fact-networkMessageCompressors.rst

Expand Down