From dfd82d2375bd641f9d7c70ae34751c1db3fc673d Mon Sep 17 00:00:00 2001 From: Steven Silvester Date: Tue, 25 Apr 2023 17:28:10 -0500 Subject: [PATCH] PYTHON-3677 Update docs on Range Index (#1195) --- doc/changelog.rst | 1 - pymongo/encryption.py | 9 +++------ pymongo/encryption_options.py | 3 +-- 3 files changed, 4 insertions(+), 9 deletions(-) diff --git a/doc/changelog.rst b/doc/changelog.rst index 2ad33e41e..3c0419f40 100644 --- a/doc/changelog.rst +++ b/doc/changelog.rst @@ -6,7 +6,6 @@ Changes in Version 4.4 - Added support for passing a list containing (key, direction) pairs or keys to :meth:`~pymongo.collection.Collection.create_index`. -- **BETA** Added support for range queries on client side field level encrypted collections. - pymongocrypt 1.5.0 or later is now required for client side field level encryption support. - Improved support for Pyright to improve typing support for IDEs like Visual Studio Code or Visual Studio. diff --git a/pymongo/encryption.py b/pymongo/encryption.py index d94e1969b..4ad59d436 100644 --- a/pymongo/encryption.py +++ b/pymongo/encryption.py @@ -799,9 +799,9 @@ class ClientEncryption(Generic[_DocumentType]): when the algorithm is :attr:`Algorithm.INDEXED`. An integer value *must* be given when the :attr:`Algorithm.INDEXED` algorithm is used. - - `range_opts`: **(BETA)** An instance of RangeOpts. + - `range_opts`: Experimental only, not intended for public use. - .. note:: `query_type`, `contention_factor` and `range_opts` are part of the Queryable Encryption beta. + .. note:: `query_type`, and `contention_factor` are part of the Queryable Encryption beta. Backwards-breaking changes may be made before the final release. :Returns: @@ -851,10 +851,7 @@ class ClientEncryption(Generic[_DocumentType]): when the algorithm is :attr:`Algorithm.INDEXED`. An integer value *must* be given when the :attr:`Algorithm.INDEXED` algorithm is used. - - `range_opts`: **(BETA)** An instance of RangeOpts. - - .. note:: Support for range queries is in beta. - Backwards-breaking changes may be made before the final release. + - `range_opts`: Experimental only, not intended for public use. :Returns: The encrypted expression, a :class:`~bson.RawBSONDocument`. diff --git a/pymongo/encryption_options.py b/pymongo/encryption_options.py index 6c966e30c..d8e9daad1 100644 --- a/pymongo/encryption_options.py +++ b/pymongo/encryption_options.py @@ -233,8 +233,7 @@ class RangeOpts: ) -> None: """Options to configure encrypted queries using the rangePreview algorithm. - .. note:: Support for Range queries is in beta. - Backwards-breaking changes may be made before the final release. + .. note:: This feature is experimental only, and not intended for public use. :Parameters: - `sparsity`: An integer.