Skip to content

Commit 1a7502c

Browse files
committed
Fix up changelog and docs for 3.9.0 release
1 parent 55c8bdd commit 1a7502c

File tree

5 files changed

+26
-12
lines changed

5 files changed

+26
-12
lines changed
+6-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1-
:mod:`encryption_options` -- Options to configure client side encryption
2-
========================================================================
1+
:mod:`encryption_options` -- Support for automatic client side encryption
2+
=========================================================================
33

44
.. automodule:: pymongo.encryption_options
5-
:members:
5+
:synopsis: Support for automatic client side encryption
6+
7+
.. autoclass:: pymongo.encryption_options.AutoEncryptionOpts
8+
:members:

doc/changelog.rst

+9-2
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@ Version 3.9 adds support for MongoDB 4.2. Highlights include:
1111
- New method :meth:`pymongo.client_session.ClientSession.with_transaction` to
1212
support conveniently running a transaction in a session with automatic
1313
retries and at-most-once semantics.
14+
- Initial support for client side field level encyption. See the docstring for
15+
:class:`~pymongo.mongo_client.MongoClient`,
16+
:class:`~pymongo.encryption_options.AutoEncryptionOpts`,
17+
and :mod:`~pymongo.encryption` for details. **Note: Support for client side
18+
encryption is in beta. Backwards-breaking changes may be made before the
19+
final release.**
1420
- Added the ``max_commit_time_ms`` parameter to
1521
:meth:`~pymongo.client_session.ClientSession.start_transaction`.
1622
- Implement the `URI options specification`_ in the
@@ -68,8 +74,9 @@ Version 3.9 adds support for MongoDB 4.2. Highlights include:
6874
the buffer protocol.
6975
- Resume tokens can now be accessed from a ``ChangeStream`` cursor using the
7076
:attr:`~pymongo.change_stream.ChangeStream.resume_token` attribute.
71-
- Connections now survive primary step-down. Applications should expect less
72-
socket connection turnover during replica set elections.
77+
- Connections now survive primary step-down when using MongoDB 4.2+.
78+
Applications should expect less socket connection turnover during
79+
replica set elections.
7380

7481
Unavoidable breaking changes:
7582

pymongo/encryption.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15-
"""Client side encryption.
15+
"""Support for explicit client side encryption.
1616
1717
**Support for client side encryption is in beta. Backwards-breaking changes
1818
may be made before the final release.**

pymongo/encryption_options.py

+5-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15-
"""Options to configure client side encryption."""
15+
"""Support for automatic client side encryption.
16+
17+
**Support for client side encryption is in beta. Backwards-breaking changes
18+
may be made before the final release.**
19+
"""
1620

1721
import copy
1822

pymongo/mongo_client.py

+5-5
Original file line numberDiff line numberDiff line change
@@ -479,11 +479,11 @@ def __init__(
479479
| (If not set explicitly, client side encryption will not be enabled.)
480480
481481
- `auto_encryption_opts`: A
482-
:class:`~pymongo.encryption.AutoEncryptionOpts` which configures
483-
this client to automatically encrypt collection commands and
484-
automatically decrypt results. **Support for client side encryption
485-
is in beta. Backwards-breaking changes may be made before the
486-
final release.**
482+
:class:`~pymongo.encryption_options.AutoEncryptionOpts` which
483+
configures this client to automatically encrypt collection commands
484+
and automatically decrypt results. **Support for client side
485+
encryption is in beta. Backwards-breaking changes may be made
486+
before the final release.**
487487
488488
.. mongodoc:: connections
489489

0 commit comments

Comments
 (0)