DOCSP-46690: Compression #158
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for docs-pymongo ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for docs-pymongo ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
rachel-mack
approved these changes
Jan 29, 2025
source/connect/compression.txt
Outdated
Comment on lines
26
to
32
| - `Snappy <https://google.github.io/snappy/>`__: You can use Snappy compression | ||
| with MongoDB 3.4 and later by including the `python-snappy <https://pypi.org/project/python-snappy/>`__ | ||
| package in your application. | ||
| - `Zlib <https://zlib.net/>`__: You can use Zlib compression with MongoDB 3.6 and later. | ||
| - `Zstandard <https://github.com/facebook/zstd/>`__: You can use Zstandard compression | ||
| with MongoDB 4.2 and later by including the `zstandard <https://pypi.org/project/zstandard/>`__ | ||
| package in your application. |
There was a problem hiding this comment.
For the tech reviewer: Does MongoDB have a recommendation for which method we prefer?
If so, we should include (recommended) after the name and put that item at the top of the list. There's a push to make our docs more opinionated. I think @rustagir just had a PR that included a compression recommendation?
There was a problem hiding this comment.
I believe snappy and zstd are considered faster than zlib but we have never actually benchmarked it in Python so I can't give a recommendation.
ShaneHarvey
reviewed
Jan 31, 2025
source/connect/compression.txt
Outdated
Comment on lines
26
to
32
| - `Snappy <https://google.github.io/snappy/>`__: You can use Snappy compression | ||
| with MongoDB 3.4 and later by including the `python-snappy <https://pypi.org/project/python-snappy/>`__ | ||
| package in your application. | ||
| - `Zlib <https://zlib.net/>`__: You can use Zlib compression with MongoDB 3.6 and later. | ||
| - `Zstandard <https://github.com/facebook/zstd/>`__: You can use Zstandard compression | ||
| with MongoDB 4.2 and later by including the `zstandard <https://pypi.org/project/zstandard/>`__ | ||
| package in your application. |
There was a problem hiding this comment.
I believe snappy and zstd are considered faster than zlib but we have never actually benchmarked it in Python so I can't give a recommendation.
source/connect/compression.txt
Outdated
| - `Snappy <https://google.github.io/snappy/>`__: You can use Snappy compression | ||
| with MongoDB 3.4 and later by including the `python-snappy <https://pypi.org/project/python-snappy/>`__ | ||
| package in your application. | ||
| - `Zlib <https://zlib.net/>`__: You can use Zlib compression with MongoDB 3.6 and later. |
There was a problem hiding this comment.
Let's link to https://docs.python.org/3/library/zlib.html.
ShaneHarvey
approved these changes
Jan 31, 2025
mcmorisi
added a commit
that referenced
this pull request
Feb 3, 2025
(cherry picked from commit e3f2626)
mcmorisi
added a commit
that referenced
this pull request
Feb 3, 2025
(cherry picked from commit e3f2626)
mcmorisi
added a commit
that referenced
this pull request
Feb 3, 2025
(cherry picked from commit e3f2626)
mcmorisi
added a commit
that referenced
this pull request
Feb 3, 2025
(cherry picked from commit e3f2626)
mcmorisi
added a commit
that referenced
this pull request
Feb 3, 2025
(cherry picked from commit e3f2626)
mongoKart
pushed a commit
to mongoKart/docs-pymongo
that referenced
this pull request
Feb 6, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-46690
Staging Links
Self-Review Checklist