Skip to content

Commit 56bb5dd

Browse files
committed
PYTHON-1944 Mark encryption as in beta
1 parent 6f00a24 commit 56bb5dd

File tree

3 files changed

+14
-2
lines changed

3 files changed

+14
-2
lines changed

pymongo/encryption.py

Lines changed: 8 additions & 1 deletion
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-
"""Client side encryption."""
15+
"""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 contextlib
1822
import functools
@@ -344,6 +348,9 @@ def __init__(self, kms_providers, key_vault_namespace, key_vault_client,
344348
creating data keys. It does not provide an API to query keys from the
345349
key vault collection, as this can be done directly on the MongoClient.
346350
351+
.. note:: Support for client side encryption is in beta.
352+
Backwards-breaking changes may be made before the final release.
353+
347354
:Parameters:
348355
- `kms_providers`: Map of KMS provider options. Two KMS providers
349356
are supported: "aws" and "local". The kmsProviders map values

pymongo/encryption_options.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,9 @@ def __init__(self, kms_providers, key_vault_namespace,
4848
community feature. A MongoClient configured with
4949
bypassAutoEncryption=true will still automatically decrypt.
5050
51+
.. note:: Support for client side encryption is in beta.
52+
Backwards-breaking changes may be made before the final release.
53+
5154
:Parameters:
5255
- `kms_providers`: Map of KMS provider options. Two KMS providers
5356
are supported: "aws" and "local". The kmsProviders map values

pymongo/mongo_client.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -481,7 +481,9 @@ def __init__(
481481
- `auto_encryption_opts`: A
482482
:class:`~pymongo.encryption.AutoEncryptionOpts` which configures
483483
this client to automatically encrypt collection commands and
484-
automatically decrypt results.
484+
automatically decrypt results. **Support for client side encryption
485+
is in beta. Backwards-breaking changes may be made before the
486+
final release.**
485487
486488
.. mongodoc:: connections
487489

0 commit comments

Comments
 (0)