Hidden indexes

JAVA-3717

Author: jstewart148

driver-core/src/main/com/mongodb/client/model/IndexOptions.java

@@ -47,6 +47,7 @@ public class IndexOptions {
     private Bson partialFilterExpression;
     private Collation collation;
     private Bson wildcardProjection;
+    private boolean hidden;
 
     /**
      * Create the index in the background
@@ -491,6 +492,30 @@ public IndexOptions wildcardProjection(final Bson wildcardProjection) {
         return this;
     }
 
+    /**
+     * Gets whether the index should not be used by the query planner when executing operations.
+     *
+     * @return true if the index should not be used by the query planner when executing operations.
+     * @mongodb.server.release 4.4
+     * @since 4.1
+     */
+    public boolean isHidden() {
+        return hidden;
+    }
+
+    /**
+     * Should the index not be used by the query planner when executing operations.
+     *
+     * @param hidden true if the index should be hidden
+     * @return this
+     * @mongodb.server.release 4.4
+     * @since 4.1
+     */
+    public IndexOptions hidden(final boolean hidden) {
+        this.hidden = hidden;
+        return this;
+    }
+
     @Override
     public String toString() {
         return "IndexOptions{"
@@ -513,6 +538,7 @@ public String toString() {
                 + ", partialFilterExpression=" + partialFilterExpression
                 + ", collation=" + collation
                 + ", wildcardProjection=" + wildcardProjection
+                + ", hidden=" + hidden
                 + '}';
     }
 }

driver-core/src/main/com/mongodb/internal/bulk/IndexRequest.java

@@ -56,6 +56,7 @@ public class IndexRequest {
     private BsonDocument partialFilterExpression;
     private Collation collation;
     private BsonDocument wildcardProjection;
+    private boolean hidden;
 
     /**
      * Construct a new instance with the given keys
@@ -536,4 +537,26 @@ public IndexRequest wildcardProjection(final BsonDocument wildcardProjection) {
         this.wildcardProjection = wildcardProjection;
         return this;
     }
+
+    /**
+     * Gets if the index should exist on the target collection but should not be used by the query
+     * planner when executing operations.
+     *
+     * @return true if the index should not be used by the query planner when executing operations.
+     */
+    public boolean isHidden() {
+        return hidden;
+    }
+
+    /**
+     * Should the index exist on the target collection but should not be used by the query
+     * planner when executing operations.
+     *
+     * @param hidden true if the index should be hidden
+     * @return this
+     */
+    public IndexRequest hidden(final boolean hidden) {
+        this.hidden = hidden;
+        return this;
+    }
 }

driver-core/src/main/com/mongodb/internal/operation/CreateIndexesOperation.java

@@ -302,6 +302,9 @@ private BsonDocument getIndex(final IndexRequest request) {
         if (request.getWildcardProjection() != null) {
             index.append("wildcardProjection", request.getWildcardProjection());
         }
+        if (request.isHidden()) {
+            index.append("hidden", BsonBoolean.TRUE);
+        }
         return index;
     }
 

driver-core/src/main/com/mongodb/internal/operation/Operations.java

@@ -479,6 +479,7 @@ CreateIndexesOperation createIndexes(final List<IndexModel> indexes, final Creat
                     .partialFilterExpression(toBsonDocument(model.getOptions().getPartialFilterExpression()))
                     .collation(model.getOptions().getCollation())
                     .wildcardProjection(toBsonDocument(model.getOptions().getWildcardProjection()))
+                    .hidden(model.getOptions().isHidden())
             );
         }
         return new CreateIndexesOperation(namespace, indexRequests, writeConcern)

driver-core/src/test/functional/com/mongodb/internal/operation/CreateIndexesOperationSpecification.groovy

@@ -560,6 +560,30 @@ class CreateIndexesOperationSpecification extends OperationFunctionalSpecificati
         async << [true, false]
     }
 
+    @IgnoreIf({ !serverVersionAtLeast(4, 4) })
+    def 'should be able to set hidden index'() {
+        given:
+        def operation = new CreateIndexesOperation(getNamespace(), [new IndexRequest(new BsonDocument('field', new BsonInt32(1)))])
+
+        when:
+        execute(operation, async)
+
+        then:
+        getUserCreatedIndexes('hidden').size() == 0
+
+        when:
+        getCollectionHelper().drop(getNamespace())
+        operation = new CreateIndexesOperation(getNamespace(),
+                [new IndexRequest(new BsonDocument('field', new BsonInt32(1))).hidden(true)])
+        execute(operation, async)
+
+        then:
+        getUserCreatedIndexes('hidden').size() == 1
+
+        where:
+        async << [true, false]
+    }
+
     Document getIndex(final String indexName) {
         getIndexes().find {
             it -> it.getString('name') == indexName

driver-core/src/test/unit/com/mongodb/IndexRequestSpecification.groovy

@@ -56,6 +56,7 @@ class IndexRequestSpecification extends Specification {
         request.getPartialFilterExpression() == null
         request.getCollation() == null
         request.getWildcardProjection() == null
+        !request.isHidden()
 
         when:
         def keys = BsonDocument.parse('{ a: 1 }')
@@ -94,6 +95,7 @@ class IndexRequestSpecification extends Specification {
                 .partialFilterExpression(partialFilterExpression)
                 .collation(collation)
                 .wildcardProjection(wildcardProjection)
+                .hidden(true)
 
         then:
         request2.getKeys() == keys
@@ -117,6 +119,7 @@ class IndexRequestSpecification extends Specification {
         request2.getPartialFilterExpression() == partialFilterExpression
         request2.getCollation() == collation
         request2.getWildcardProjection() == wildcardProjection
+        request2.isHidden()
     }
 
 

driver-core/src/test/unit/com/mongodb/client/model/IndexOptionsSpecification.groovy

@@ -47,6 +47,7 @@ class IndexOptionsSpecification extends Specification {
         options.getPartialFilterExpression() == null
         options.getCollation() == null
         options.getWildcardProjection() == null
+        !options.isHidden()
         def wildcardProjection = BsonDocument.parse('{a  : 1}')
 
         when:
@@ -73,6 +74,7 @@ class IndexOptionsSpecification extends Specification {
                 .partialFilterExpression(partialFilterExpression)
                 .collation(collation)
                 .wildcardProjection(wildcardProjection)
+                .hidden(true)
 
         then:
         options.isBackground()
@@ -94,6 +96,7 @@ class IndexOptionsSpecification extends Specification {
         options.getPartialFilterExpression() == partialFilterExpression
         options.getCollation() == collation
         options.getWildcardProjection() == wildcardProjection
+        options.isHidden()
     }
 
     def 'should convert expireAfter'() {

driver-core/src/test/unit/com/mongodb/internal/async/client/AsyncMongoCollectionSpecification.groovy

@@ -1200,6 +1200,7 @@ class AsyncMongoCollectionSpecification extends Specification {
                          .partialFilterExpression(BsonDocument.parse('{status: "active"}'))
                          .collation(collation)
                          .wildcardProjection(new BsonDocument('a', new BsonInt32(1)))
+                         .hidden(true)
                 ], ACKNOWLEDGED)
         indexName = execute(createIndexMethod, session, new Document('key', 1), new IndexOptions()
                 .background(true)
@@ -1220,7 +1221,8 @@ class AsyncMongoCollectionSpecification extends Specification {
                 .storageEngine(BsonDocument.parse('{wiredTiger: {configString: "block_compressor=zlib"}}'))
                 .partialFilterExpression(BsonDocument.parse('{status: "active"}'))
                 .collation(collation)
-                .wildcardProjection(new BsonDocument('a', new BsonInt32(1))))
+                .wildcardProjection(new BsonDocument('a', new BsonInt32(1)))
+                .hidden(true))
         operation = executor.getWriteOperation() as CreateIndexesOperation
 
         then:

driver-sync/src/test/unit/com/mongodb/client/internal/MongoCollectionSpecification.groovy

@@ -1213,6 +1213,7 @@ class MongoCollectionSpecification extends Specification {
                          .partialFilterExpression(BsonDocument.parse('{status: "active"}'))
                          .collation(collation)
                          .wildcardProjection(new BsonDocument('a', new BsonInt32(1)))
+                         .hidden(true)
                 ], ACKNOWLEDGED)
         indexName = execute(createIndexMethod, session, new Document('key', 1), new IndexOptions()
                 .background(true)
@@ -1233,7 +1234,8 @@ class MongoCollectionSpecification extends Specification {
                 .storageEngine(BsonDocument.parse('{wiredTiger: {configString: "block_compressor=zlib"}}'))
                 .partialFilterExpression(BsonDocument.parse('{status: "active"}'))
                 .collation(collation)
-                .wildcardProjection(new BsonDocument('a', new BsonInt32(1))))
+                .wildcardProjection(new BsonDocument('a', new BsonInt32(1)))
+                .hidden(true))
         operation = executor.getWriteOperation() as CreateIndexesOperation
 
         then: