Skip to content

Commit 89edd81

Browse files
authored
DRIVERS-2776 document "range" as stable (#1617)
1 parent 458f80c commit 89edd81

File tree

2 files changed

+4
-13
lines changed

2 files changed

+4
-13
lines changed

source/client-side-encryption/client-side-encryption.md

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -978,7 +978,6 @@ class ClientEncryption {
978978
// {$and: [{$gt: [<fieldpath>, <value1>]}, {$lt: [<fieldpath>, <value2>]}]
979979
// $gt may also be $gte. $lt may also be $lte.
980980
// Only supported when queryType is "range" and algorithm is "Range".
981-
// NOTE: The "range" queryType and "Range" algorithm are currently unstable API and subject to backwards breaking changes.
982981
encryptExpression(expr: Document, opts: EncryptOpts): Document;
983982

984983
// Decrypts an encrypted value (BSON binary of subtype 6).
@@ -1163,7 +1162,6 @@ class EncryptOpts {
11631162
rangeOpts: Optional<RangeOpts>
11641163
}
11651164

1166-
// NOTE: RangeOpts is currently unstable API and subject to backwards breaking changes.
11671165
// RangeOpts specifies index options for a Queryable Encryption field supporting "range" queries.
11681166
// min, max, trimFactor, sparsity, and precision must match the values set in the encryptedFields of the destination collection.
11691167
// For double and decimal128, min/max/precision must all be set, or all be unset.
@@ -1200,7 +1198,7 @@ One of the strings:
12001198
- "AEAD_AES_256_CBC_HMAC_SHA_512-Random"
12011199
- "Indexed"
12021200
- "Unindexed"
1203-
- "Range" (unstable)
1201+
- "Range"
12041202

12051203
The result of explicit encryption with the "Indexed" or "Range" algorithm must be processed by the server to insert or
12061204
query. Drivers MUST document the following behavior:
@@ -1209,9 +1207,6 @@ query. Drivers MUST document the following behavior:
12091207
> `AutoEncryptionOpts`. `AutoEncryptionOpts.bypassQueryAnalysis` may be true. `AutoEncryptionOpts.bypassAutoEncryption`
12101208
> must be false.
12111209

1212-
> [!NOTE]
1213-
> The "Range" algorithm is currently unstable API and subject to backwards breaking changes.
1214-
12151210
#### contentionFactor
12161211

12171212
contentionFactor may be used to tune performance. Only applies when algorithm is "Indexed" or "Range". libmongocrypt
@@ -1227,17 +1222,11 @@ One of the strings:
12271222
queryType only applies when algorithm is "Indexed" or "Range". libmongocrypt returns an error if queryType is set for a
12281223
non-applicable queryType.
12291224

1230-
> [!NOTE]
1231-
> The "range" queryType is currently unstable API and subject to backwards breaking changes.
1232-
12331225
#### rangeOpts
12341226

12351227
rangeOpts only applies when algorithm is "range". libmongocrypt returns an error if rangeOpts is set for a
12361228
non-applicable algorithm.
12371229

1238-
> [!NOTE]
1239-
> rangeOpts is currently unstable API and subject to backwards breaking changes.
1240-
12411230
## User facing API: When Auto Encryption Fails
12421231

12431232
Auto encryption requires parsing the MongoDB query language client side (with the [mongocryptd](#mongocryptd) process or
@@ -2383,6 +2372,8 @@ explicit session parameter as described in the [Drivers Sessions Specification](
23832372

23842373
## Changelog
23852374

2375+
- 2024-07-29: Document range as stable.
2376+
23862377
- 2024-07-22: Make `trimFactor` and `sparsity` optional.
23872378

23882379
- 2024-06-13: Document range as unstable.

source/client-side-encryption/tests/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2820,7 +2820,7 @@ MONGOCRYPT-705.
28202820

28212821
> [!NOTE]
28222822
> MongoDB Server 8.0 introduced a backwards breaking change to the Queryable Encryption (QE) range protocol: QE Range V2
2823-
> libmongocrypt 1.10.0 is required to use the QE Range V2.
2823+
> libmongocrypt 1.11.0 is required to use the QE Range V2.
28242824

28252825
> [!NOTE]
28262826
> MongoDB Server 7.0 introduced a backwards breaking change to the Queryable Encryption (QE) protocol: QEv2.

0 commit comments

Comments
 (0)