Skip to content

Commit

Permalink
feat(NODE-6309): Mark range API as stable (#4190)
Browse files Browse the repository at this point in the history
  • Loading branch information
baileympearson committed Sep 4, 2024
1 parent 8bfe187 commit f53e9d9
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 8 deletions.
10 changes: 3 additions & 7 deletions src/client-side-encryption/client_encryption.ts
Original file line number Diff line number Diff line change
Expand Up @@ -611,8 +611,6 @@ export class ClientEncryption {
*
* Only supported when queryType is "range" and algorithm is "Range".
*
* @experimental The Range algorithm is experimental only. It is not intended for production use. It is subject to breaking changes.
*
* @param expression - a BSON document of one of the following forms:
* 1. A Match Expression of this form:
* `{$and: [{<field>: {$gt: <value1>}}, {<field>: {$lt: <value2> }}]}`
Expand Down Expand Up @@ -769,13 +767,11 @@ export interface ClientEncryptionEncryptOptions {
contentionFactor?: bigint | number;

/**
* The query type supported. Only the queryType `equality` is stable.
*
* @experimental Public Technical Preview: The queryType `rangePreview` is experimental.
* The query type.
*/
queryType?: 'equality' | 'range';

/** @experimental Public Technical Preview: The index options for a Queryable Encryption field supporting "rangePreview" queries.*/
/** The index options for a Queryable Encryption field supporting "range" queries.*/
rangeOptions?: RangeOptions;
}

Expand Down Expand Up @@ -963,7 +959,7 @@ export interface ClientEncryptionRewrapManyDataKeyResult {

/**
* @public
* RangeOptions specifies index options for a Queryable Encryption field supporting "rangePreview" queries.
* RangeOptions specifies index options for a Queryable Encryption field supporting "range" queries.
* min, max, sparsity, trimFactor and range must match the values set in the encryptedFields of the destination collection.
* For double and decimal128, min/max/precision must all be set, or all be unset.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,4 +91,4 @@ tests:
}
}
encryptionInformation: *encryptionInformation
command_name: compactStructuredEncryptionData
command_name: compactStructuredEncryptionData

0 comments on commit f53e9d9

Please sign in to comment.