@@ -978,7 +978,6 @@ class ClientEncryption {
978
978
// {$and: [{$gt: [<fieldpath>, <value1>]}, {$lt: [<fieldpath>, <value2>]}]
979
979
// $gt may also be $gte. $lt may also be $lte.
980
980
// 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.
982
981
encryptExpression(expr: Document, opts: EncryptOpts): Document;
983
982
984
983
// Decrypts an encrypted value (BSON binary of subtype 6).
@@ -1163,7 +1162,6 @@ class EncryptOpts {
1163
1162
rangeOpts: Optional<RangeOpts>
1164
1163
}
1165
1164
1166
- // NOTE: RangeOpts is currently unstable API and subject to backwards breaking changes.
1167
1165
// RangeOpts specifies index options for a Queryable Encryption field supporting "range" queries.
1168
1166
// min, max, trimFactor, sparsity, and precision must match the values set in the encryptedFields of the destination collection.
1169
1167
// For double and decimal128, min/max/precision must all be set, or all be unset.
@@ -1200,7 +1198,7 @@ One of the strings:
1200
1198
- "AEAD_AES_256_CBC_HMAC_SHA_512-Random"
1201
1199
- "Indexed"
1202
1200
- "Unindexed"
1203
- - "Range" (unstable)
1201
+ - "Range"
1204
1202
1205
1203
The result of explicit encryption with the "Indexed" or "Range" algorithm must be processed by the server to insert or
1206
1204
query. Drivers MUST document the following behavior:
@@ -1209,9 +1207,6 @@ query. Drivers MUST document the following behavior:
1209
1207
> `AutoEncryptionOpts`. `AutoEncryptionOpts.bypassQueryAnalysis` may be true. `AutoEncryptionOpts.bypassAutoEncryption`
1210
1208
> must be false.
1211
1209
1212
- > [!NOTE]
1213
- > The "Range" algorithm is currently unstable API and subject to backwards breaking changes.
1214
-
1215
1210
#### contentionFactor
1216
1211
1217
1212
contentionFactor may be used to tune performance. Only applies when algorithm is "Indexed" or "Range". libmongocrypt
@@ -1227,17 +1222,11 @@ One of the strings:
1227
1222
queryType only applies when algorithm is "Indexed" or "Range". libmongocrypt returns an error if queryType is set for a
1228
1223
non-applicable queryType.
1229
1224
1230
- > [!NOTE]
1231
- > The "range" queryType is currently unstable API and subject to backwards breaking changes.
1232
-
1233
1225
#### rangeOpts
1234
1226
1235
1227
rangeOpts only applies when algorithm is "range". libmongocrypt returns an error if rangeOpts is set for a
1236
1228
non-applicable algorithm.
1237
1229
1238
- > [!NOTE]
1239
- > rangeOpts is currently unstable API and subject to backwards breaking changes.
1240
-
1241
1230
## User facing API: When Auto Encryption Fails
1242
1231
1243
1232
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](
2383
2372
2384
2373
## Changelog
2385
2374
2375
+ - 2024-07-29: Document range as stable.
2376
+
2386
2377
- 2024-07-22: Make `trimFactor` and `sparsity` optional.
2387
2378
2388
2379
- 2024-06-13: Document range as unstable.
0 commit comments