Skip to content

Commit 2f39993

Browse files
authored
DRIVERS-2928 document "range" as unstable (#1601)
DRIVERS-2767 document "range" as unstable
1 parent b5e09dc commit 2f39993

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

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

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -983,6 +983,7 @@ class ClientEncryption {
983983
// {$and: [{$gt: [<fieldpath>, <value1>]}, {$lt: [<fieldpath>, <value2>]}]
984984
// $gt may also be $gte. $lt may also be $lte.
985985
// 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.
986987
encryptExpression(expr: Document, opts: EncryptOpts): Document;
987988

988989
// Decrypts an encrypted value (BSON binary of subtype 6).
@@ -1167,6 +1168,7 @@ class EncryptOpts {
11671168
rangeOpts: Optional<RangeOpts>
11681169
}
11691170

1171+
// NOTE: RangeOpts is currently unstable API and subject to backwards breaking changes.
11701172
// RangeOpts specifies index options for a Queryable Encryption field supporting "range" queries.
11711173
// min, max, trimFactor, sparsity, and precision must match the values set in the encryptedFields of the destination collection.
11721174
// For double and decimal128, min/max/precision must all be set, or all be unset.
@@ -1201,7 +1203,7 @@ One of the strings:
12011203
- "AEAD_AES_256_CBC_HMAC_SHA_512-Random"
12021204
- "Indexed"
12031205
- "Unindexed"
1204-
- "Range"
1206+
- "Range" (unstable)
12051207

12061208
The result of explicit encryption with the "Indexed" or "Range" algorithm must be processed by the server to insert or
12071209
query. Drivers MUST document the following behavior:
@@ -1210,6 +1212,9 @@ query. Drivers MUST document the following behavior:
12101212
> `AutoEncryptionOpts`. `AutoEncryptionOpts.bypassQueryAnalysis` may be true. `AutoEncryptionOpts.bypassAutoEncryption`
12111213
> must be false.
12121214

1215+
> [!NOTE]
1216+
> The "Range" algorithm is currently unstable API and subject to backwards breaking changes.
1217+
12131218
#### contentionFactor
12141219

12151220
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:
12251230
queryType only applies when algorithm is "Indexed" or "Range". It is an error to set queryType when algorithm is not
12261231
"Indexed" or "Range".
12271232

1233+
> [!NOTE]
1234+
> The "range" queryType is currently unstable API and subject to backwards breaking changes.
1235+
12281236
#### rangeOpts
12291237

12301238
rangeOpts only applies when algorithm is "range". It is an error to set rangeOpts when algorithm is not "range".
12311239

1240+
> [!NOTE]
1241+
> rangeOpts is currently unstable API and subject to backwards breaking changes.
1242+
12321243
## User facing API: When Auto Encryption Fails
12331244

12341245
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](
23752386

23762387
## Changelog
23772388

2389+
- 2024-06-13: Document range as unstable.
2390+
23782391
- 2024-05-31: Replace rangePreview with range.
23792392

23802393
- 2024-03-20: Add `delegated` option to "kmip" KMS provider

0 commit comments

Comments
 (0)