Added support for let in operations (#900)

JAVA-4366

Author: rozza

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

@@ -19,6 +19,7 @@
 import com.mongodb.lang.Nullable;
 import org.bson.BsonString;
 import org.bson.BsonValue;
+import org.bson.conversions.Bson;
 
 /**
  * The options to apply to a bulk write.
@@ -29,6 +30,7 @@ public final class BulkWriteOptions {
     private boolean ordered = true;
     private Boolean bypassDocumentValidation;
     private BsonValue comment;
+    private Bson variables;
 
     /**
      * If true, then when a write fails, return without performing the remaining
@@ -117,12 +119,41 @@ public BulkWriteOptions comment(@Nullable final BsonValue comment) {
         return this;
     }
 
+    /**
+     * Add top-level variables to the operation
+     *
+     * @return the top level variables if set or null.
+     * @mongodb.server.release 5.0
+     * @since 4.6
+     */
+    @Nullable
+    public Bson getLet() {
+        return variables;
+    }
+
+    /**
+     * Add top-level variables for the operation
+     *
+     * <p>Allows for improved command readability by separating the variables from the query text.
+     * The value of let will be passed to all update and delete, but not insert, commands.
+     *
+     * @param variables for the operation or null
+     * @return this
+     * @mongodb.server.release 5.0
+     * @since 4.6
+     */
+    public BulkWriteOptions let(@Nullable final Bson variables) {
+        this.variables = variables;
+        return this;
+    }
+
     @Override
     public String toString() {
         return "BulkWriteOptions{"
                 + "ordered=" + ordered
                 + ", bypassDocumentValidation=" + bypassDocumentValidation
                 + ", comment=" + comment
+                + ", let=" + variables
                 + '}';
     }
 }

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

@@ -33,6 +33,7 @@ public class DeleteOptions {
     private String hintString;
     private Collation collation;
     private BsonValue comment;
+    private Bson variables;
 
     /**
      * Returns the collation options
@@ -150,13 +151,44 @@ public DeleteOptions comment(@Nullable final BsonValue comment) {
         return this;
     }
 
+    /**
+     * Add top-level variables to the operation
+     *
+     * <p>The value of let will be passed to all update and delete, but not insert, commands.
+     *
+     * @return the top level variables if set or null.
+     * @mongodb.server.release 5.0
+     * @since 4.6
+     */
+    @Nullable
+    public Bson getLet() {
+        return variables;
+    }
+
+    /**
+     * Add top-level variables for the operation
+     *
+     * <p>Allows for improved command readability by separating the variables from the query text.
+     * <p>For bulk operations use: {@link BulkWriteOptions#let(Bson)}
+     *
+     * @param variables for the operation or null
+     * @return this
+     * @mongodb.server.release 5.0
+     * @since 4.6
+     */
+    public DeleteOptions let(final Bson variables) {
+        this.variables = variables;
+        return this;
+    }
+
     @Override
     public String toString() {
         return "DeleteOptions{"
                 + "collation=" + collation
                 + ", hint=" + hint
                 + ", hintString='" + hintString + '\''
                 + ", comment=" + comment
+                + ", let=" + variables
                 + '}';
     }
 }

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

@@ -40,6 +40,7 @@ public class FindOneAndDeleteOptions {
     private Bson hint;
     private String hintString;
     private BsonValue comment;
+    private Bson variables;
 
     /**
      * Gets a document describing the fields to return for all matching documents.
@@ -226,6 +227,33 @@ public FindOneAndDeleteOptions comment(@Nullable final BsonValue comment) {
         return this;
     }
 
+    /**
+     * Add top-level variables to the operation
+     *
+     * @return the top level variables if set or null.
+     * @mongodb.server.release 5.0
+     * @since 4.6
+     */
+    @Nullable
+    public Bson getLet() {
+        return variables;
+    }
+
+    /**
+     * Add top-level variables for the operation
+     *
+     * <p>Allows for improved command readability by separating the variables from the query text.
+     *
+     * @param variables for the operation or null
+     * @return this
+     * @mongodb.server.release 5.0
+     * @since 4.6
+     */
+    public FindOneAndDeleteOptions let(final Bson variables) {
+        this.variables = variables;
+        return this;
+    }
+
     @Override
     public String toString() {
         return "FindOneAndDeleteOptions{"
@@ -236,6 +264,7 @@ public String toString() {
                 + ", hint=" + hint
                 + ", hintString='" + hintString + '\''
                 + ", comment=" + comment
+                + ", let=" + variables
                 + '}';
     }
 }

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

@@ -43,6 +43,7 @@ public class FindOneAndReplaceOptions {
     private Bson hint;
     private String hintString;
     private BsonValue comment;
+    private Bson variables;
 
     /**
      * Gets a document describing the fields to return for all matching documents.
@@ -288,6 +289,33 @@ public FindOneAndReplaceOptions comment(@Nullable final BsonValue comment) {
         return this;
     }
 
+    /**
+     * Add top-level variables to the operation
+     *
+     * @return the top level variables if set or null.
+     * @mongodb.server.release 5.0
+     * @since 4.6
+     */
+    @Nullable
+    public Bson getLet() {
+        return variables;
+    }
+
+    /**
+     * Add top-level variables for the operation
+     *
+     * <p>Allows for improved command readability by separating the variables from the query text.
+     *
+     * @param variables for the operation or null
+     * @return this
+     * @mongodb.server.release 5.0
+     * @since 4.6
+     */
+    public FindOneAndReplaceOptions let(final Bson variables) {
+        this.variables = variables;
+        return this;
+    }
+
     @Override
     public String toString() {
         return "FindOneAndReplaceOptions{"
@@ -301,6 +329,7 @@ public String toString() {
                 + ", hint=" + hint
                 + ", hintString" + hintString
                 + ", comment=" + comment
+                + ", let=" + variables
                 + '}';
     }
 }

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

@@ -45,6 +45,7 @@ public class FindOneAndUpdateOptions {
     private Bson hint;
     private String hintString;
     private BsonValue comment;
+    private Bson variables;
 
     /**
      * Gets a document describing the fields to return for all matching documents.
@@ -314,6 +315,33 @@ public FindOneAndUpdateOptions comment(@Nullable final BsonValue comment) {
         return this;
     }
 
+    /**
+     * Add top-level variables to the operation
+     *
+     * @return the top level variables if set or null.
+     * @mongodb.server.release 5.0
+     * @since 4.6
+     */
+    @Nullable
+    public Bson getLet() {
+        return variables;
+    }
+
+    /**
+     * Add top-level variables for the operation
+     *
+     * <p>Allows for improved command readability by separating the variables from the query text.
+     *
+     * @param variables for the operation or null
+     * @return this
+     * @mongodb.server.release 5.0
+     * @since 4.6
+     */
+    public FindOneAndUpdateOptions let(final Bson variables) {
+        this.variables = variables;
+        return this;
+    }
+
     @Override
     public String toString() {
         return "FindOneAndUpdateOptions{"
@@ -328,6 +356,7 @@ public String toString() {
                 + ", hint=" + hint
                 + ", hintString=" + hintString
                 + ", comment=" + comment
+                + ", let=" + variables
                 + '}';
     }
 }

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

@@ -36,6 +36,7 @@ public class ReplaceOptions {
     private Bson hint;
     private String hintString;
     private BsonValue comment;
+    private Bson variables;
 
     /**
      * Returns true if a new document should be inserted if there are no matches to the query filter.  The default is false.
@@ -190,6 +191,35 @@ public ReplaceOptions comment(@Nullable final BsonValue comment) {
         this.comment = comment;
         return this;
     }
+    /**
+     * Add top-level variables to the operation
+     *
+     * <p>The value of let will be passed to all update and delete, but not insert, commands.
+     *
+     * @return the top level variables if set or null.
+     * @mongodb.server.release 5.0
+     * @since 4.6
+     */
+    @Nullable
+    public Bson getLet() {
+        return variables;
+    }
+
+    /**
+     * Add top-level variables for the operation
+     *
+     * <p>Allows for improved command readability by separating the variables from the query text.
+     * <p>For bulk operations use: {@link BulkWriteOptions#let(Bson)}
+     *
+     * @param variables for the operation or null
+     * @return this
+     * @mongodb.server.release 5.0
+     * @since 4.6
+     */
+    public ReplaceOptions let(final Bson variables) {
+        this.variables = variables;
+        return this;
+    }
 
     @Override
     public String toString() {
@@ -200,6 +230,7 @@ public String toString() {
                 + ", hint=" + hint
                 + ", hintString=" + hintString
                 + ", comment=" + comment
+                + ", let=" + variables
                 + '}';
     }
 }

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

@@ -39,6 +39,7 @@ public class UpdateOptions {
     private Bson hint;
     private String hintString;
     private BsonValue comment;
+    private Bson variables;
 
     /**
      * Returns true if a new document should be inserted if there are no matches to the query filter.  The default is false.
@@ -225,6 +226,36 @@ public UpdateOptions comment(@Nullable final BsonValue comment) {
         return this;
     }
 
+    /**
+     * Add top-level variables to the operation
+     *
+     * <p>The value of let will be passed to all update and delete, but not insert, commands.
+     *
+     * @return the top level variables if set or null.
+     * @mongodb.server.release 5.0
+     * @since 4.6
+     */
+    @Nullable
+    public Bson getLet() {
+        return variables;
+    }
+
+    /**
+     * Add top-level variables for the operation
+     *
+     * <p>Allows for improved command readability by separating the variables from the query text.
+     * <p>For bulk operations use: {@link BulkWriteOptions#let(Bson)}
+     *
+     * @param variables for the operation or null
+     * @return this
+     * @mongodb.server.release 5.0
+     * @since 4.6
+     */
+    public UpdateOptions let(final Bson variables) {
+        this.variables = variables;
+        return this;
+    }
+
     @Override
     public String toString() {
         return "UpdateOptions{"
@@ -235,6 +266,7 @@ public String toString() {
                 + ", hint=" + hint
                 + ", hintString=" + hintString
                 + ", comment=" + comment
+                + ", let=" + variables
                 + '}';
     }
 }