@@ -983,6 +983,7 @@ class ClientEncryption {
983
983
// {$and: [{$gt: [<fieldpath>, <value1>]}, {$lt: [<fieldpath>, <value2>]}]
984
984
// $gt may also be $gte. $lt may also be $lte.
985
985
// Only supported when queryType is "range" and algorithm is "Range".
986
+ // NOTE: The "range" queryType and "Range" algorithm are currently unstable API and subject to backwards breaking changes.
986
987
encryptExpression(expr: Document, opts: EncryptOpts): Document;
987
988
988
989
// Decrypts an encrypted value (BSON binary of subtype 6).
@@ -1167,6 +1168,7 @@ class EncryptOpts {
1167
1168
rangeOpts: Optional<RangeOpts>
1168
1169
}
1169
1170
1171
+ // NOTE: RangeOpts is currently unstable API and subject to backwards breaking changes.
1170
1172
// RangeOpts specifies index options for a Queryable Encryption field supporting "range" queries.
1171
1173
// min, max, trimFactor, sparsity, and precision must match the values set in the encryptedFields of the destination collection.
1172
1174
// For double and decimal128, min/max/precision must all be set, or all be unset.
@@ -1201,7 +1203,7 @@ One of the strings:
1201
1203
- "AEAD_AES_256_CBC_HMAC_SHA_512-Random"
1202
1204
- "Indexed"
1203
1205
- "Unindexed"
1204
- - "Range"
1206
+ - "Range" (unstable)
1205
1207
1206
1208
The result of explicit encryption with the "Indexed" or "Range" algorithm must be processed by the server to insert or
1207
1209
query. Drivers MUST document the following behavior:
@@ -1210,6 +1212,9 @@ query. Drivers MUST document the following behavior:
1210
1212
> `AutoEncryptionOpts`. `AutoEncryptionOpts.bypassQueryAnalysis` may be true. `AutoEncryptionOpts.bypassAutoEncryption`
1211
1213
> must be false.
1212
1214
1215
+ > [!NOTE]
1216
+ > The "Range" algorithm is currently unstable API and subject to backwards breaking changes.
1217
+
1213
1218
#### contentionFactor
1214
1219
1215
1220
contentionFactor only applies when algorithm is "Indexed" or "Range". It is an error to set contentionFactor when
@@ -1225,10 +1230,16 @@ One of the strings:
1225
1230
queryType only applies when algorithm is "Indexed" or "Range". It is an error to set queryType when algorithm is not
1226
1231
"Indexed" or "Range".
1227
1232
1233
+ > [!NOTE]
1234
+ > The "range" queryType is currently unstable API and subject to backwards breaking changes.
1235
+
1228
1236
#### rangeOpts
1229
1237
1230
1238
rangeOpts only applies when algorithm is "range". It is an error to set rangeOpts when algorithm is not "range".
1231
1239
1240
+ > [!NOTE]
1241
+ > rangeOpts is currently unstable API and subject to backwards breaking changes.
1242
+
1232
1243
## User facing API: When Auto Encryption Fails
1233
1244
1234
1245
Auto encryption requires parsing the MongoDB query language client side (with the [mongocryptd](#mongocryptd) process or
@@ -2375,6 +2386,8 @@ explicit session parameter as described in the [Drivers Sessions Specification](
2375
2386
2376
2387
## Changelog
2377
2388
2389
+ - 2024-06-13: Document range as unstable.
2390
+
2378
2391
- 2024-05-31: Replace rangePreview with range.
2379
2392
2380
2393
- 2024-03-20: Add `delegated` option to "kmip" KMS provider
0 commit comments