Skip to content

Support Range Indexes as GA. #1465

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

Merged
merged 16 commits into from
Aug 19, 2024
Merged

Support Range Indexes as GA. #1465

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
e5c75c1
Make trimFactor and sparsity optional.
vbabanin Jul 31, 2024
cc9da8a
Add and update QE V2 tests.
vbabanin Aug 1, 2024
fb7265b
Merge branch 'master' into JAVA-5537
vbabanin Aug 1, 2024
a68dea1
Update Javadoc.
vbabanin Aug 2, 2024
9aa2afb
Merge branch 'master' into JAVA-5537
vbabanin Aug 3, 2024
51b200d
Update compact tests.
vbabanin Aug 7, 2024
a77b481
Update compact tests.
vbabanin Aug 8, 2024
6552f4c
Add compact tests.
vbabanin Aug 8, 2024
7da108e
Update version of mongocrypt.
vbabanin Aug 8, 2024
abe5257
Update legacy Json test runner.
vbabanin Aug 8, 2024
00de93b
Fix static check issues.
vbabanin Aug 8, 2024
57a9900
Remove Beta annotation from Range algorithm methods.
vbabanin Aug 9, 2024
1c59759
Remove unused imports.
vbabanin Aug 9, 2024
ea4ad41
Update driver-sync/src/test/functional/com/mongodb/client/AbstractCli…
vbabanin Aug 14, 2024
c27d160
Remove redundant code.
vbabanin Aug 14, 2024
adceeed
Rename method setTrimFactor.
vbabanin Aug 15, 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
2 changes: 1 addition & 1 deletion build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ ext {
zstdVersion = '1.5.5-3'
awsSdkV2Version = '2.18.9'
awsSdkV1Version = '1.12.337'
mongoCryptVersion = '1.11.0-SNAPSHOT'
mongoCryptVersion = '1.11.0'
projectReactorVersion = '2022.0.0'
junitBomVersion = '5.10.2'
logbackVersion = '1.3.14'
Expand Down
6 changes: 0 additions & 6 deletions driver-core/src/main/com/mongodb/client/model/vault/EncryptOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,6 @@ public EncryptOptions(final String algorithm) {
* <li>Unindexed</li>
* <li>Range</li>
* </ul>
* Note: The Range algorithm is unstable. It is subject to breaking changes.
*
* @return the encryption algorithm
*/
Expand Down Expand Up @@ -118,7 +117,6 @@ public EncryptOptions keyAltName(final String keyAltName) {
* The contention factor.
*
* <p>It is an error to set contentionFactor when algorithm is not "Indexed" or "Range".
* <p>Note: The Range algorithm is unstable. It is subject to breaking changes.</p>
* @param contentionFactor the contention factor, which must be {@code >= 0} or null.
* @return this
* @since 4.7
Expand Down Expand Up @@ -147,7 +145,6 @@ public Long getContentionFactor() {
*
* <p>Currently, we support only "equality" or "range" queryType.</p>
* <p>It is an error to set queryType when the algorithm is not "Indexed" or "Range".</p>
* <p>Note: The Range algorithm is unstable. It is subject to breaking changes.</p>
* @param queryType the query type
* @return this
* @since 4.7
Expand All @@ -162,7 +159,6 @@ public EncryptOptions queryType(@Nullable final String queryType) {
* Gets the QueryType.
*
* <p>Currently, we support only "equality" or "range" queryType.</p>
* <p>Note: The Range algorithm is unstable. It is subject to breaking changes.
* @see #queryType(String)
* @return the queryType or null
* @since 4.7
Expand All @@ -177,14 +173,12 @@ public String getQueryType() {
* The RangeOptions
*
* <p>It is an error to set RangeOptions when the algorithm is not "Range".
* <p>Note: The Range algorithm is unstable. It is subject to breaking changes.
* @param rangeOptions the range options
* @return this
* @since 4.9
* @mongodb.server.release 8.0
* @mongodb.driver.manual /core/queryable-encryption/ queryable encryption
*/
@Beta(Reason.SERVER)
public EncryptOptions rangeOptions(@Nullable final RangeOptions rangeOptions) {
this.rangeOptions = rangeOptions;
return this;
Expand Down
18 changes: 10 additions & 8 deletions driver-core/src/main/com/mongodb/client/model/vault/RangeOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@

package com.mongodb.client.model.vault;

import com.mongodb.annotations.Beta;
import com.mongodb.annotations.Reason;
import com.mongodb.lang.Nullable;
import org.bson.BsonValue;

Expand All @@ -29,12 +27,10 @@
*
* <p>For {@code double} and {@code decimal128}, {@code min}/{@code max}/{@code precision} must all be set, or all be unset.
*
* <p>Note: The "Range" algorithm is unstable. It is subject to breaking changes.
* @since 4.9
* @mongodb.server.release 6.2
* @mongodb.driver.manual /core/queryable-encryption/ queryable encryption
*/
@Beta(Reason.SERVER)
public class RangeOptions {

private BsonValue min;
Expand Down Expand Up @@ -81,18 +77,21 @@ public RangeOptions max(@Nullable final BsonValue max) {
* @return the trim factor value if set
* @since 5.2
*/
@Nullable
public Integer getTrimFactor() {
Comment on lines +80 to 81
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's weird that this method was not @Nullable previously, as there was nothing that prevented it from returning null.

return trimFactor;
}

/**
* Set the number of top-level edges stored per record by setting a trim factor, reducing write conflicts during simultaneous inserts
* and optimizing queries by excluding seldom-used high-level edges.
* Set the number of top-level edges stored per record.
* <p>
* The trim factor may be used to tune performance.
*
* @param trimFactor the trim factor
* @return this
* @since 5.2
*/
public RangeOptions setTrimFactor(final Integer trimFactor) {
public RangeOptions trimFactor(@Nullable final Integer trimFactor) {
this.trimFactor = trimFactor;
return this;
}
Expand All @@ -106,7 +105,10 @@ public BsonValue getMax() {
}

/**
* Set the Queryable Encryption range hypergraph sparsity factor
* Set the Queryable Encryption range hypergraph sparsity factor.
* <p>
* Sparsity may be used to tune performance.
*
* @param sparsity the sparsity
* @return this
*/
Expand Down
1 change: 0 additions & 1 deletion driver-core/src/test/resources/client-side-encryption/legacy/fle2v2-BypassQueryAnalysis.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
"runOn": [
{
"minServerVersion": "7.0.0",
"serverless": "forbid",
"topology": [
"replicaset",
"sharded",
Expand Down
6 changes: 4 additions & 2 deletions driver-core/src/test/resources/client-side-encryption/legacy/fle2v2-Compact.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
"runOn": [
{
"minServerVersion": "7.0.0",
"serverless": "forbid",
"topology": [
"replicaset",
"sharded",
Expand Down Expand Up @@ -131,6 +130,9 @@
"command": {
"compactStructuredEncryptionData": "default"
}
},
"result": {
"ok": 1
}
}
],
Expand Down Expand Up @@ -228,4 +230,4 @@
]
}
]
}
}
32 changes: 32 additions & 0 deletions ...e/src/test/resources/client-side-encryption/legacy/fle2v2-CreateCollection-OldServer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,38 @@
"result": {
"errorContains": "Driver support of Queryable Encryption is incompatible with server. Upgrade server to use Queryable Encryption."
}
},
{
"name": "assertCollectionNotExists",
"object": "testRunner",
"arguments": {
"database": "default",
"collection": "enxcol_.encryptedCollection.esc"
}
},
{
"name": "assertCollectionNotExists",
"object": "testRunner",
"arguments": {
"database": "default",
"collection": "enxcol_.encryptedCollection.ecc"
}
},
{
"name": "assertCollectionNotExists",
"object": "testRunner",
"arguments": {
"database": "default",
"collection": "enxcol_.encryptedCollection.ecoc"
}
},
{
"name": "assertCollectionNotExists",
"object": "testRunner",
"arguments": {
"database": "default",
"collection": "encryptedCollection"
}
}
]
}
Expand Down
19 changes: 0 additions & 19 deletions driver-core/src/test/resources/client-side-encryption/legacy/fle2v2-CreateCollection.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
"runOn": [
{
"minServerVersion": "7.0.0",
"serverless": "forbid",
"topology": [
"replicaset",
"sharded",
Expand Down Expand Up @@ -158,9 +157,6 @@
"command": {
"create": "encryptedCollection",
"encryptedFields": {
"escCollection": null,
"ecocCollection": null,
"eccCollection": null,
"fields": [
{
"path": "firstName",
Expand Down Expand Up @@ -343,9 +339,6 @@
"command": {
"create": "encryptedCollection",
"encryptedFields": {
"escCollection": null,
"ecocCollection": null,
"eccCollection": null,
"fields": [
{
"path": "firstName",
Expand Down Expand Up @@ -851,9 +844,6 @@
"command": {
"create": "encryptedCollection",
"encryptedFields": {
"escCollection": null,
"ecocCollection": null,
"eccCollection": null,
"fields": [
{
"path": "firstName",
Expand Down Expand Up @@ -1048,9 +1038,6 @@
"command": {
"create": "encryptedCollection",
"encryptedFields": {
"escCollection": null,
"ecocCollection": null,
"eccCollection": null,
"fields": [
{
"path": "firstName",
Expand Down Expand Up @@ -1367,9 +1354,6 @@
"command": {
"create": "encryptedCollection",
"encryptedFields": {
"escCollection": null,
"ecocCollection": null,
"eccCollection": null,
"fields": [
{
"path": "firstName",
Expand Down Expand Up @@ -1635,9 +1619,6 @@
"command": {
"create": "encryptedCollection",
"encryptedFields": {
"escCollection": null,
"ecocCollection": null,
"eccCollection": null,
"fields": [
{
"path": "firstName",
Expand Down
1 change: 0 additions & 1 deletion driver-core/src/test/resources/client-side-encryption/legacy/fle2v2-DecryptExistingData.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
"runOn": [
{
"minServerVersion": "7.0.0",
"serverless": "forbid",
"topology": [
"replicaset",
"sharded",
Expand Down
1 change: 0 additions & 1 deletion driver-core/src/test/resources/client-side-encryption/legacy/fle2v2-Delete.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
"runOn": [
{
"minServerVersion": "7.0.0",
"serverless": "forbid",
"topology": [
"replicaset",
"sharded",
Expand Down
1 change: 0 additions & 1 deletion ...resources/client-side-encryption/legacy/fle2v2-EncryptedFields-vs-EncryptedFieldsMap.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
"runOn": [
{
"minServerVersion": "7.0.0",
"serverless": "forbid",
"topology": [
"replicaset",
"sharded",
Expand Down
1 change: 0 additions & 1 deletion ...rc/test/resources/client-side-encryption/legacy/fle2v2-EncryptedFields-vs-jsonSchema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
"runOn": [
{
"minServerVersion": "7.0.0",
"serverless": "forbid",
"topology": [
"replicaset",
"sharded",
Expand Down
1 change: 0 additions & 1 deletion .../src/test/resources/client-side-encryption/legacy/fle2v2-EncryptedFieldsMap-defaults.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
"runOn": [
{
"minServerVersion": "7.0.0",
"serverless": "forbid",
"topology": [
"replicaset",
"sharded",
Expand Down
1 change: 0 additions & 1 deletion driver-core/src/test/resources/client-side-encryption/legacy/fle2v2-FindOneAndUpdate.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
"runOn": [
{
"minServerVersion": "7.0.0",
"serverless": "forbid",
"topology": [
"replicaset",
"sharded",
Expand Down
1 change: 0 additions & 1 deletion driver-core/src/test/resources/client-side-encryption/legacy/fle2v2-InsertFind-Indexed.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
"runOn": [
{
"minServerVersion": "7.0.0",
"serverless": "forbid",
"topology": [
"replicaset",
"sharded",
Expand Down
1 change: 0 additions & 1 deletion ...er-core/src/test/resources/client-side-encryption/legacy/fle2v2-InsertFind-Unindexed.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
"runOn": [
{
"minServerVersion": "7.0.0",
"serverless": "forbid",
"topology": [
"replicaset",
"sharded",
Expand Down
5 changes: 2 additions & 3 deletions driver-core/src/test/resources/client-side-encryption/legacy/fle2v2-MissingKey.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
"runOn": [
{
"minServerVersion": "7.0.0",
"serverless": "forbid",
"topology": [
"replicaset",
"sharded",
Expand Down Expand Up @@ -55,7 +54,7 @@
"key_vault_data": [],
"tests": [
{
"description": "FLE2 encrypt fails with mising key",
"description": "FLE2 encrypt fails with missing key",
"clientOptions": {
"autoEncryptOpts": {
"kmsProviders": {
Expand Down Expand Up @@ -86,7 +85,7 @@
]
},
{
"description": "FLE2 decrypt fails with mising key",
"description": "FLE2 decrypt fails with missing key",
"clientOptions": {
"autoEncryptOpts": {
"kmsProviders": {
Expand Down
1 change: 0 additions & 1 deletion driver-core/src/test/resources/client-side-encryption/legacy/fle2v2-NoEncryption.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
"runOn": [
{
"minServerVersion": "7.0.0",
"serverless": "forbid",
"topology": [
"replicaset",
"sharded",
Expand Down
Loading