diff --git a/doc/api/pymongo/encryption_options.rst b/doc/api/pymongo/encryption_options.rst index 64f8a8b62..492139faa 100644 --- a/doc/api/pymongo/encryption_options.rst +++ b/doc/api/pymongo/encryption_options.rst @@ -1,5 +1,8 @@ -:mod:`encryption_options` -- Options to configure client side encryption -======================================================================== +:mod:`encryption_options` -- Support for automatic client side encryption +========================================================================= .. automodule:: pymongo.encryption_options - :members: + :synopsis: Support for automatic client side encryption + + .. autoclass:: pymongo.encryption_options.AutoEncryptionOpts + :members: diff --git a/doc/changelog.rst b/doc/changelog.rst index 9c9e96ed0..0dc806ab3 100644 --- a/doc/changelog.rst +++ b/doc/changelog.rst @@ -11,6 +11,12 @@ Version 3.9 adds support for MongoDB 4.2. Highlights include: - New method :meth:`pymongo.client_session.ClientSession.with_transaction` to support conveniently running a transaction in a session with automatic retries and at-most-once semantics. +- Initial support for client side field level encyption. See the docstring for + :class:`~pymongo.mongo_client.MongoClient`, + :class:`~pymongo.encryption_options.AutoEncryptionOpts`, + and :mod:`~pymongo.encryption` for details. **Note: Support for client side + encryption is in beta. Backwards-breaking changes may be made before the + final release.** - Added the ``max_commit_time_ms`` parameter to :meth:`~pymongo.client_session.ClientSession.start_transaction`. - Implement the `URI options specification`_ in the @@ -68,8 +74,9 @@ Version 3.9 adds support for MongoDB 4.2. Highlights include: the buffer protocol. - Resume tokens can now be accessed from a ``ChangeStream`` cursor using the :attr:`~pymongo.change_stream.ChangeStream.resume_token` attribute. -- Connections now survive primary step-down. Applications should expect less - socket connection turnover during replica set elections. +- Connections now survive primary step-down when using MongoDB 4.2+. + Applications should expect less socket connection turnover during + replica set elections. Unavoidable breaking changes: diff --git a/pymongo/encryption.py b/pymongo/encryption.py index facd25455..1986f5f50 100644 --- a/pymongo/encryption.py +++ b/pymongo/encryption.py @@ -12,7 +12,7 @@ # See the License for the specific language governing permissions and # limitations under the License. -"""Client side encryption. +"""Support for explicit client side encryption. **Support for client side encryption is in beta. Backwards-breaking changes may be made before the final release.** diff --git a/pymongo/encryption_options.py b/pymongo/encryption_options.py index 167370836..bc469f0ea 100644 --- a/pymongo/encryption_options.py +++ b/pymongo/encryption_options.py @@ -12,7 +12,11 @@ # See the License for the specific language governing permissions and # limitations under the License. -"""Options to configure client side encryption.""" +"""Support for automatic client side encryption. + +**Support for client side encryption is in beta. Backwards-breaking changes +may be made before the final release.** +""" import copy diff --git a/pymongo/mongo_client.py b/pymongo/mongo_client.py index 1309da3e7..79ceea245 100644 --- a/pymongo/mongo_client.py +++ b/pymongo/mongo_client.py @@ -479,11 +479,11 @@ class MongoClient(common.BaseObject): | (If not set explicitly, client side encryption will not be enabled.) - `auto_encryption_opts`: A - :class:`~pymongo.encryption.AutoEncryptionOpts` which configures - this client to automatically encrypt collection commands and - automatically decrypt results. **Support for client side encryption - is in beta. Backwards-breaking changes may be made before the - final release.** + :class:`~pymongo.encryption_options.AutoEncryptionOpts` which + configures this client to automatically encrypt collection commands + and automatically decrypt results. **Support for client side + encryption is in beta. Backwards-breaking changes may be made + before the final release.** .. mongodoc:: connections