Skip to content

Commit dfd82d2

Browse files
authored
PYTHON-3677 Update docs on Range Index (#1195)
1 parent 79488d9 commit dfd82d2

File tree

3 files changed

+4
-9
lines changed

3 files changed

+4
-9
lines changed

doc/changelog.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ Changes in Version 4.4
66

77
- Added support for passing a list containing (key, direction) pairs
88
or keys to :meth:`~pymongo.collection.Collection.create_index`.
9-
- **BETA** Added support for range queries on client side field level encrypted collections.
109
- pymongocrypt 1.5.0 or later is now required for client side field level
1110
encryption support.
1211
- Improved support for Pyright to improve typing support for IDEs like Visual Studio Code or Visual Studio.

pymongo/encryption.py

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -799,9 +799,9 @@ def encrypt(
799799
when the algorithm is :attr:`Algorithm.INDEXED`. An integer value
800800
*must* be given when the :attr:`Algorithm.INDEXED` algorithm is
801801
used.
802-
- `range_opts`: **(BETA)** An instance of RangeOpts.
802+
- `range_opts`: Experimental only, not intended for public use.
803803
804-
.. note:: `query_type`, `contention_factor` and `range_opts` are part of the Queryable Encryption beta.
804+
.. note:: `query_type`, and `contention_factor` are part of the Queryable Encryption beta.
805805
Backwards-breaking changes may be made before the final release.
806806
807807
:Returns:
@@ -851,10 +851,7 @@ def encrypt_expression(
851851
when the algorithm is :attr:`Algorithm.INDEXED`. An integer value
852852
*must* be given when the :attr:`Algorithm.INDEXED` algorithm is
853853
used.
854-
- `range_opts`: **(BETA)** An instance of RangeOpts.
855-
856-
.. note:: Support for range queries is in beta.
857-
Backwards-breaking changes may be made before the final release.
854+
- `range_opts`: Experimental only, not intended for public use.
858855
859856
:Returns:
860857
The encrypted expression, a :class:`~bson.RawBSONDocument`.

pymongo/encryption_options.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -233,8 +233,7 @@ def __init__(
233233
) -> None:
234234
"""Options to configure encrypted queries using the rangePreview algorithm.
235235
236-
.. note:: Support for Range queries is in beta.
237-
Backwards-breaking changes may be made before the final release.
236+
.. note:: This feature is experimental only, and not intended for public use.
238237
239238
:Parameters:
240239
- `sparsity`: An integer.

0 commit comments

Comments
 (0)