Skip to content

PYTHON-3677 Update docs on Range Index #1195

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 25, 2023
Merged

PYTHON-3677 Update docs on Range Index #1195

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion doc/changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
9 changes: 3 additions & 6 deletions pymongo/encryption.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -799,9 +799,9 @@ def encrypt(
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:
Expand Down Expand Up @@ -851,10 +851,7 @@ def encrypt_expression(
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`.
Expand Down
3 changes: 1 addition & 2 deletions pymongo/encryption_options.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,8 +233,7 @@ def __init__(
) -> 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.
Expand Down