mongodb/mongo-python-driver
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

PYTHON-3677 Update docs on Range Index (#1195)

Browse Source
This commit is contained in:
Steven Silvester 2023-04-25 17:28:10 -05:00 committed by GitHub
parent 79488d95db
commit dfd82d2375
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 4 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/changelog.rst
View File

@ -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.

9
pymongo/encryption.py
View File

@ -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`.

3
pymongo/encryption_options.py
View File

@ -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.