Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(NODE-6309): Mark range API as stable #4190

Merged
merged 2 commits into from
Sep 4, 2024
Merged

feat(NODE-6309): Mark range API as stable #4190

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0092727
allowed changes
baileympearson Aug 28, 2024
9f34c05
Merge branch 'main' into NODE-6309
baileympearson Sep 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 3 additions & 7 deletions src/client-side-encryption/client_encryption.ts
View file
Open in desktop
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
2 changes: 1 addition & 1 deletion test/spec/client-side-encryption/tests/legacy/fle2v2-Rangev2-Compact.yml
View file
Open in desktop
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