mongo 2.16.0 → 2.17.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 803953b133578a0014b611609e6b334196ebe25484ee4db3fc3299cf1911445f
-  data.tar.gz: 368a07676afa5d71f41e86b9a288b4691f99b0549d041d87d6c4a8cf771d6ff5
+  metadata.gz: 1a38f748fe8350d12ecfd23a30e794b65addcfbf8f5303504f5f85999e2c2b0d
+  data.tar.gz: 876f431a9bfc558ecad0006a32b6ed90b6a94d05ac553a52fbc8b5d3b2b80a55
 SHA512:
-  metadata.gz: dd6d240f340e8ea904028bf7d3a9cc2ef6ee6d0e54d181a45c2e083f8e71dc29fab942d265425f5eeb98c0e5f81786f8d0ade460e90ffe2da7af69038f22155f
-  data.tar.gz: 4474efb5b33f984b4900bd702f05d1c012b5827b09b33281da60c9e07f3c416953292d2d2e9b463ed3c015f8a5e607de9da9aafcf8452b9568373dae49dbd880
+  metadata.gz: 256181a9c42fee1b029c899ab56a1a1f5b5283d4071913fc5777ad185f5349a00dc1fa36ac60b9b203a15f1d0857511c551f417f78864a04899e973e8da14b96
+  data.tar.gz: 1272cc35779781fe390276007c831e653b64087e1f34b0459e12d8dfea7099dd39be4e06cef347e36fa7222064ba2f267a5be4a48120d6017f4424876123195b

data/README.md

@@ -5,7 +5,7 @@ MongoDB Ruby Driver
 
 The officially supported Ruby driver for [MongoDB](https://www.mongodb.org/).
 
-The Ruby driver supports Ruby 2.4-3.0 and JRuby 9.2.
+The Ruby driver supports Ruby 2.5-3.0 and JRuby 9.2.
 
 
 Documentation

data/lib/mongo/auth/aws/request.rb

@@ -153,7 +153,6 @@ module Mongo
             'x-mongodb-gs2-cb-flag' => 'n',
             'x-mongodb-server-nonce' => Base64.encode64(server_nonce).gsub("\n", ''),
           }
-          # Hash#compact is available as of Ruby 2.4
           if session_token
             headers['x-amz-security-token'] = session_token
           end

data/lib/mongo/client.rb

@@ -887,6 +887,7 @@ module Mongo
     #
     #   See https://docs.mongodb.com/manual/reference/command/listDatabases/
     #   for more information and usage.
+    # @option opts [ Session ] :session The session to use.
     #
     # @return [ Array<String> ] The names of the databases.
     #
@@ -910,6 +911,7 @@ module Mongo
     #
     #   See https://docs.mongodb.com/manual/reference/command/listDatabases/
     #   for more information and usage.
+    # @option opts [ Session ] :session The session to use.
     #
     # @return [ Array<Hash> ] The info for each database.
     #
@@ -930,6 +932,8 @@ module Mongo
     # @param [ Hash ] filter The filter criteria for getting a list of databases.
     # @param [ Hash ] opts The command options.
     #
+    # @option opts [ Session ] :session The session to use.
+    #
     # @return [ Array<Mongo::Database> ] The list of database objects.
     #
     # @since 2.5.0

data/lib/mongo/cluster/reapers/cursor_reaper.rb

@@ -44,6 +44,7 @@ module Mongo
         @to_kill = {}
         @active_cursor_ids = Set.new
         @mutex = Mutex.new
+        @kill_spec_queue = Queue.new
       end
 
       attr_reader :cluster
@@ -51,17 +52,10 @@ module Mongo
       # Schedule a kill cursors operation to be eventually executed.
       #
       # @param [ Cursor::KillSpec ] kill_spec The kill specification.
-      # @param [ Mongo::Server ] server The server to send the kill cursors
-      #   operation to.
       #
       # @api private
-      def schedule_kill_cursor(kill_spec, server)
-        @mutex.synchronize do
-          if @active_cursor_ids.include?(kill_spec.cursor_id)
-            @to_kill[server.address.seed] ||= Set.new
-            @to_kill[server.address.seed] << kill_spec
-          end
-        end
+      def schedule_kill_cursor(kill_spec)
+        @kill_spec_queue << kill_spec
       end
 
       # Register a cursor id as active.
@@ -110,6 +104,24 @@ module Mongo
         end
       end
 
+      # Read and decode scheduled kill cursors operations.
+      #
+      # This method mutates instance variables without locking, so is is not
+      # thread safe. Generally, it should not be called itself, this is a helper
+      # for `kill_cursor` method.
+      #
+      # @api private
+      def read_scheduled_kill_specs
+        while kill_spec = @kill_spec_queue.pop(true)
+          if @active_cursor_ids.include?(kill_spec.cursor_id)
+            @to_kill[kill_spec.server_address] ||= Set.new
+            @to_kill[kill_spec.server_address] << kill_spec
+          end
+        end
+      rescue ThreadError
+        # Empty queue, nothing to do.
+      end
+
       # Execute all pending kill cursors operations.
       #
       # @example Execute pending kill cursors operations.
@@ -122,14 +134,14 @@ module Mongo
         # TODO optimize this to batch kill cursor operations for the same
         # server/database/collection instead of killing each cursor
         # individually.
-
         loop do
-          server_address_str = nil
+          server_address = nil
 
           kill_spec = @mutex.synchronize do
+            read_scheduled_kill_specs
             # Find a server that has any cursors scheduled for destruction.
-            server_address_str, specs =
-              @to_kill.detect { |server_address_str, specs| specs.any? }
+            server_address, specs =
+              @to_kill.detect { |_, specs| specs.any? }
 
             if specs.nil?
               # All servers have empty specs, nothing to do.
@@ -168,7 +180,7 @@ module Mongo
           op = Operation::KillCursors.new(spec)
 
           server = cluster.servers.detect do |server|
-            server.address.seed == server_address_str
+            server.address == server_address
           end
 
           unless server

data/lib/mongo/collection/view/aggregation.rb

@@ -73,6 +73,25 @@ module Mongo
         # @param [ Array<Hash> ] pipeline The pipeline of operations.
         # @param [ Hash ] options The aggregation options.
         #
+        # @option options [ true, false ] :allow_disk_use Set to true if disk
+        #   usage is allowed during the aggregation.
+        # @option options [ Integer ] :batch_size The number of documents to return
+        #   per batch.
+        # @option options [ true, false ] :bypass_document_validation Whether or
+        #   not to skip document level validation.
+        # @option options [ Hash ] :collation The collation to use.
+        # @option options [ String ] :comment Associate a comment with the aggregation.
+        # @option options [ String ] :hint The index to use for the aggregation.
+        # @option options [ Hash ] :let Mapping of variables to use in the pipeline.
+        #   See the server documentation for details.
+        # @option options [ Integer ] :max_time_ms The maximum amount of time in
+        #   milliseconds to allow the aggregation to run.
+        # @option options [ true, false ] :use_cursor Indicates whether the command
+        #   will request that the server provide results using a cursor. Note that
+        #   as of server version 3.6, aggregations always provide results using a
+        #   cursor and this option is therefore not valid.
+        # @option options [ Session ] :session The session to use.
+        #
         # @since 2.0.0
         def initialize(view, pipeline, options = {})
           @view = view
@@ -108,37 +127,63 @@ module Mongo
           @view.send(:server_selector)
         end
 
-        def aggregate_spec(session)
-          Builder::Aggregation.new(pipeline, view, options.merge(session: session)).specification
+        def aggregate_spec(server, session, read_preference)
+          Builder::Aggregation.new(
+            pipeline,
+            view,
+            options.merge(session: session, read_preference: read_preference)
+          ).specification
         end
 
         def new(options)
           Aggregation.new(view, pipeline, options)
         end
 
-        def initial_query_op(session)
-          Operation::Aggregate.new(aggregate_spec(session))
+        def initial_query_op(server, session, read_preference)
+          Operation::Aggregate.new(aggregate_spec(server, session, read_preference))
         end
 
-        def valid_server?(server)
-          if secondary_ok?
-            true
+        # Return effective read preference for the operation.
+        #
+        # If the pipeline contains $merge or $out, and read preference specified
+        # by user is secondary or secondary_preferred, and selected server is below
+        # 5.0, than this method returns primary read preference, because the
+        # aggregation will be routed to primary. Otherwise return the original
+        # read preference.
+        #
+        # See https://github.com/mongodb/specifications/blob/master/source/crud/crud.rst#read-preferences-and-server-selection
+        #
+        # @param [ Server ] server The server on which the operation
+        #   should be executed.
+        # @return [ Hash | nil ] read preference hash that should be sent with
+        #   this command.
+        def effective_read_preference(server)
+          return unless view.read_preference
+          return view.read_preference unless write?
+          return view.read_preference unless [:secondary, :secondary_preferred].include?(view.read_preference[:mode])
+
+          primary_read_preference = {mode: :primary}
+          if server.primary?
+            log_warn("Routing the Aggregation operation to the primary server")
+            primary_read_preference
+          elsif server.mongos? && !server.features.merge_out_on_secondary_enabled?
+            log_warn("Routing the Aggregation operation to the primary server")
+            primary_read_preference
           else
-            description = server.description
-            description.standalone? || description.mongos? || description.primary? || description.load_balancer?
+            view.read_preference
           end
-        end
 
-        def secondary_ok?
-          !write?
         end
 
         def send_initial_query(server, session)
-          unless valid_server?(server)
-            log_warn("Rerouting the Aggregation operation to the primary server - #{server.summary} is not suitable")
-            server = cluster.next_primary(nil, session)
-          end
-          initial_query_op(session).execute(server, context: Operation::Context.new(client: client, session: session))
+          initial_query_op(
+            server,
+            session,
+            effective_read_preference(server)
+          ).execute(
+              server,
+              context: Operation::Context.new(client: client, session: session)
+            )
         end
 
         # Skip, sort, limit, projection are specified as pipeline stages

data/lib/mongo/collection/view/builder/aggregation.rb

@@ -30,16 +30,17 @@ module Mongo
           #
           # @since 2.2.0
           MAPPINGS = BSON::Document.new(
-            :allow_disk_use => 'allowDiskUse',
-            :max_time_ms => 'maxTimeMS',
+            allow_disk_use: 'allowDiskUse',
+            bypass_document_validation: 'bypassDocumentValidation',
+            explain: 'explain',
+            collation: 'collation',
+            comment: 'comment',
+            hint: 'hint',
+            let: 'let',
             # This is intentional; max_await_time_ms is an alias for maxTimeMS
             # used on getMore commands for change streams.
-            :max_await_time_ms => 'maxTimeMS',
-            :explain => 'explain',
-            :bypass_document_validation => 'bypassDocumentValidation',
-            :collation => 'collation',
-            :hint => 'hint',
-            :comment => 'comment'
+            max_await_time_ms: 'maxTimeMS',
+            max_time_ms: 'maxTimeMS',
           ).freeze
 
           def_delegators :@view, :collection, :database, :read, :write_concern
@@ -55,12 +56,9 @@ module Mongo
 
           # Initialize the builder.
           #
-          # @example Initialize the builder.
-          #   Aggregation.new(map, reduce, view, options)
-          #
           # @param [ Array<Hash> ] pipeline The aggregation pipeline.
           # @param [ Collection::View ] view The collection view.
-          # @param [ Hash ] options The map/reduce options.
+          # @param [ Hash ] options The map/reduce and read preference options.
           #
           # @since 2.2.0
           def initialize(pipeline, view, options)
@@ -81,7 +79,7 @@ module Mongo
             spec = {
               selector: aggregation_command,
               db_name: database.name,
-              read: view.read_preference,
+              read: @options[:read_preference] || view.read_preference,
               session: @options[:session],
               collation: @options[:collation],
             }

data/lib/mongo/collection/view/builder/map_reduce.rb

@@ -114,12 +114,15 @@ module Mongo
                 collection.read_concern)
             end
             command.update(view_options)
-            command.update(Utils.slice_hash(options, :collation))
+            command.update(options.slice(:collation))
+
             # Read preference isn't simply passed in the command payload
-            # (it may need to be converted to wire protocol flags)
-            # so remove it here and hopefully it's handled elsewhere.
-            # If not, RUBY-2706.
-            command.delete(:read)
+            # (it may need to be converted to wire protocol flags).
+            # Ideally it should be removed here, however due to Mongoid 7
+            # using this method and requiring :read to be returned from it,
+            # we cannot do this just yet - see RUBY-2932.
+            #command.delete(:read)
+
             command.merge!(Options::Mapper.transform_documents(options, MAPPINGS))
             command
           end

data/lib/mongo/collection/view/change_stream.rb

@@ -298,8 +298,8 @@ module Mongo
           [{ '$changeStream' => change_doc }] + @change_stream_filters
         end
 
-        def aggregate_spec(session)
-          super(session).tap do |spec|
+        def aggregate_spec(server, session, read_preference)
+          super(server, session, read_preference).tap do |spec|
             spec[:selector][:aggregate] = 1 unless for_collection?
           end
         end
@@ -349,7 +349,11 @@ module Mongo
         end
 
         def send_initial_query(server, session)
-          initial_query_op(session).execute(server, context: Operation::Context.new(client: client, session: session))
+          initial_query_op(server, session, view.read_preference)
+            .execute(
+              server,
+              context: Operation::Context.new(client: client, session: session)
+            )
         end
 
         def time_to_bson_timestamp(time)

data/lib/mongo/collection/view/iterable.rb

@@ -114,11 +114,9 @@ module Mongo
 
         def select_cursor(session)
           if respond_to?(:write?, true) && write?
-            server = server_selector.select_server(cluster, nil, session)
+            server = server_selector.select_server(cluster, nil, session, write_aggregation: true)
             result = send_initial_query(server, session)
 
-            # RUBY-2367: This will be updated to allow the query cache to
-            # cache cursors with multi-batch results.
             if use_query_cache?
               CachingCursor.new(view, result, server, session: session)
             else
@@ -161,6 +159,7 @@ module Mongo
             collation: collation,
             sort: sort,
             skip: skip,
+            let: options[:let],
             limit: limit,
             allow_disk_use: options[:allow_disk_use],
             read: read,

data/lib/mongo/collection/view/map_reduce.rb

@@ -115,6 +115,8 @@ module Mongo
           @map_function = map.dup.freeze
           @reduce_function = reduce.dup.freeze
           @options = BSON::Document.new(options).freeze
+
+          client.log_warn('The map_reduce operation is deprecated, please use the aggregation pipeline instead')
         end
 
         # Set or get the jsMode flag for the operation.
@@ -248,7 +250,20 @@ module Mongo
         end
 
         def initial_query_op(session)
-          Operation::MapReduce.new(map_reduce_spec(session))
+          spec = map_reduce_spec(session)
+          # Read preference isn't simply passed in the command payload
+          # (it may need to be converted to wire protocol flags).
+          # Passing it in command payload produces errors on at least
+          # 5.0 mongoses.
+          # In the future map_reduce_command should remove :read
+          # from its return value, however we cannot do this right now
+          # due to Mongoid 7 relying on :read being returned as part of
+          # the command - see RUBY-2932.
+          # Delete :read here for now because it cannot be sent to mongos this way.
+          spec = spec.dup
+          spec[:selector] = spec[:selector].dup
+          spec[:selector].delete(:read)
+          Operation::MapReduce.new(spec)
         end
 
         def valid_server?(server)

data/lib/mongo/collection/view/readable.rb

@@ -34,6 +34,25 @@ module Mongo
         # @param [ Array<Hash> ] pipeline The aggregation pipeline.
         # @param [ Hash ] options The aggregation options.
         #
+        # @option options [ true, false ] :allow_disk_use Set to true if disk
+        #   usage is allowed during the aggregation.
+        # @option options [ Integer ] :batch_size The number of documents to return
+        #   per batch.
+        # @option options [ true, false ] :bypass_document_validation Whether or
+        #   not to skip document level validation.
+        # @option options [ Hash ] :collation The collation to use.
+        # @option options [ String ] :comment Associate a comment with the aggregation.
+        # @option options [ String ] :hint The index to use for the aggregation.
+        # @option options [ Hash ] :let Mapping of variables to use in the pipeline.
+        #   See the server documentation for details.
+        # @option options [ Integer ] :max_time_ms The maximum amount of time in
+        #   milliseconds to allow the aggregation to run.
+        # @option options [ true, false ] :use_cursor Indicates whether the command
+        #   will request that the server provide results using a cursor. Note that
+        #   as of server version 3.6, aggregations always provide results using a
+        #   cursor and this option is therefore not valid.
+        # @option options [ Session ] :session The session to use.
+        #
         # @return [ Aggregation ] The aggregation object.
         #
         # @since 2.0.0
@@ -242,7 +261,11 @@ module Mongo
                   {'$collStats' => {'count' => {}}},
                   {'$group' => {'_id' => 1, 'n' => {'$sum' => '$count'}}},
                 ]
-                spec = Builder::Aggregation.new(pipeline, self, options.merge(session: session)).specification
+                spec = Builder::Aggregation.new(
+                  pipeline,
+                  self,
+                  options.merge(session: session)
+                ).specification
                 result = Operation::Aggregate.new(spec).execute(server, context: context)
                 result.documents.first.fetch('n')
               else

data/lib/mongo/collection/view/writable.rb

@@ -48,6 +48,8 @@ module Mongo
         #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
         # @option opts [ Hash ] :write_concern The write concern options.
         #   Can be :w => Integer, :fsync => Boolean, :j => Boolean.
+        # @option options [ Hash ] :let Mapping of variables to use in the command.
+        #   See the server documentation for details.
         #
         # @return [ BSON::Document, nil ] The document, if found.
         #
@@ -75,6 +77,7 @@ module Mongo
               bypassDocumentValidation: opts[:bypass_document_validation],
               hint: opts[:hint],
               collation: opts[:collation] || opts['collation'] || collation,
+              let: opts[:let]
             }.compact
 
             write_with_retry(session, write_concern) do |server, txn_num|
@@ -109,6 +112,8 @@ module Mongo
         #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
         # @option opts [ Hash ] :write_concern The write concern options.
         #   Can be :w => Integer, :fsync => Boolean, :j => Boolean.
+        # @option options [ Hash ] :let Mapping of variables to use in the command.
+        #   See the server documentation for details.
         #
         # @return [ BSON::Document ] The document.
         #
@@ -142,6 +147,8 @@ module Mongo
         #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
         # @option opts [ Hash ] :write_concern The write concern options.
         #   Can be :w => Integer, :fsync => Boolean, :j => Boolean.
+        # @option options [ Hash ] :let Mapping of variables to use in the command.
+        #   See the server documentation for details.
         #
         # @return [ BSON::Document ] The document.
         #
@@ -172,6 +179,7 @@ module Mongo
               bypassDocumentValidation: opts[:bypass_document_validation],
               hint: opts[:hint],
               collation: opts[:collation] || opts['collation'] || collation,
+              let: opts[:let],
             }.compact
 
             write_with_retry(session, write_concern) do |server, txn_num|
@@ -200,6 +208,8 @@ module Mongo
         #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
         # @option opts [ Hash ] :write_concern The write concern options.
         #   Can be :w => Integer, :fsync => Boolean, :j => Boolean.
+        # @option options [ Hash ] :let Mapping of variables to use in the command.
+        #   See the server documentation for details.
         #
         # @return [ Result ] The response from the database.
         #
@@ -232,6 +242,7 @@ module Mongo
                 write_concern: write_concern,
                 bypass_document_validation: !!opts[:bypass_document_validation],
                 session: session,
+                let: opts[:let],
               ).execute(server, context: Operation::Context.new(client: client, session: session))
             end
           end
@@ -250,6 +261,8 @@ module Mongo
         #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
         # @option opts [ Hash ] :write_concern The write concern options.
         #   Can be :w => Integer, :fsync => Boolean, :j => Boolean.
+        # @option options [ Hash ] :let Mapping of variables to use in the command.
+        #   See the server documentation for details.
         #
         # @return [ Result ] The response from the database.
         #
@@ -283,6 +296,7 @@ module Mongo
                 bypass_document_validation: !!opts[:bypass_document_validation],
                 session: session,
                 txn_num: txn_num,
+                let: opts[:let],
               ).execute(server, context: Operation::Context.new(client: client, session: session))
             end
           end
@@ -306,6 +320,8 @@ module Mongo
         #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
         # @option opts [ Hash ] :write_concern The write concern options.
         #   Can be :w => Integer, :fsync => Boolean, :j => Boolean.
+        # @option options [ Hash ] :let Mapping of variables to use in the command.
+        #   See the server documentation for details.
         #
         # @return [ Result ] The response from the database.
         #
@@ -343,6 +359,7 @@ module Mongo
                 bypass_document_validation: !!opts[:bypass_document_validation],
                 session: session,
                 txn_num: txn_num,
+                let: opts[:let]
               ).execute(server, context: Operation::Context.new(client: client, session: session))
             end
           end
@@ -368,6 +385,8 @@ module Mongo
         #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
         # @option opts [ Hash ] :write_concern The write concern options.
         #   Can be :w => Integer, :fsync => Boolean, :j => Boolean.
+        # @option options [ Hash ] :let Mapping of variables to use in the command.
+        #   See the server documentation for details.
         #
         # @return [ Result ] The response from the database.
         #
@@ -405,6 +424,7 @@ module Mongo
                 write_concern: write_concern,
                 bypass_document_validation: !!opts[:bypass_document_validation],
                 session: session,
+                let: opts[:let],
               ).execute(server, context: Operation::Context.new(client: client, session: session))
             end
           end
@@ -430,6 +450,8 @@ module Mongo
         #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
         # @option opts [ Hash ] :write_concern The write concern options.
         #   Can be :w => Integer, :fsync => Boolean, :j => Boolean.
+        # @option options [ Hash ] :let Mapping of variables to use in the command.
+        #   See the server documentation for details.
         #
         # @return [ Result ] The response from the database.
         #
@@ -467,6 +489,7 @@ module Mongo
                 bypass_document_validation: !!opts[:bypass_document_validation],
                 session: session,
                 txn_num: txn_num,
+                let: opts[:let],
               ).execute(server, context: Operation::Context.new(client: client, session: session))
             end
           end

data/lib/mongo/collection.rb

@@ -253,7 +253,7 @@ module Mongo
       options = Hash[self.options.reject do |key, value|
         %w(read read_preference read_concern).include?(key.to_s)
       end]
-      options.update(Utils.slice_hash(opts, *TIME_SERIES_OPTIONS.keys))
+      options.update(opts.slice(*TIME_SERIES_OPTIONS.keys))
       # Converting Ruby spelled time series options to server style.
       TIME_SERIES_OPTIONS.each do |ruby_key, server_key|
         if options.key?(ruby_key)
@@ -361,6 +361,8 @@ module Mongo
     # @option options [ Integer ] :skip The number of docs to skip before returning results.
     # @option options [ Hash ] :sort The key and direction pairs by which the result set
     #   will be sorted.
+    # @option options [ Hash ] :let Mapping of variables to use in the command.
+    #   See the server documentation for details.
     #
     # @return [ CollectionView ] The collection view.
     #
@@ -386,6 +388,8 @@ module Mongo
     # @option options [ Hash ] :collation The collation to use.
     # @option options [ String ] :comment Associate a comment with the aggregation.
     # @option options [ String ] :hint The index to use for the aggregation.
+    # @option options [ Hash ] :let Mapping of variables to use in the pipeline.
+    #   See the server documentation for details.
     # @option options [ Integer ] :max_time_ms The maximum amount of time in
     #   milliseconds to allow the aggregation to run.
     # @option options [ true, false ] :use_cursor Indicates whether the command
@@ -666,6 +670,8 @@ module Mongo
     # @option options [ Session ] :session The session to use.
     # @option options [ Hash | String ] :hint The index to use for this operation.
     #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
+    # @option options [ Hash ] :let Mapping of variables to use in the command.
+    #   See the server documentation for details.
     #
     # @return [ Result ] The response from the database.
     #
@@ -686,6 +692,8 @@ module Mongo
     # @option options [ Session ] :session The session to use.
     # @option options [ Hash | String ] :hint The index to use for this operation.
     #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
+    # @option options [ Hash ] :let Mapping of variables to use in the command.
+    #   See the server documentation for details.
     #
     # @return [ Result ] The response from the database.
     #
@@ -734,6 +742,8 @@ module Mongo
     # @option options [ Session ] :session The session to use.
     # @option options [ Hash | String ] :hint The index to use for this operation.
     #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
+    # @option options [ Hash ] :let Mapping of variables to use in the command.
+    #   See the server documentation for details.
     #
     # @return [ Result ] The response from the database.
     #
@@ -761,6 +771,8 @@ module Mongo
     # @option options [ Session ] :session The session to use.
     # @option options [ Hash | String ] :hint The index to use for this operation.
     #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
+    # @option options [ Hash ] :let Mapping of variables to use in the command.
+    #   See the server documentation for details.
     #
     # @return [ Result ] The response from the database.
     #
@@ -788,6 +800,8 @@ module Mongo
     # @option options [ Session ] :session The session to use.
     # @option options [ Hash | String ] :hint The index to use for this operation.
     #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
+    # @option options [ Hash ] :let Mapping of variables to use in the command.
+    #   See the server documentation for details.
     #
     # @return [ Result ] The response from the database.
     #
@@ -816,6 +830,8 @@ module Mongo
     # @option options [ Session ] :session The session to use.
     # @option options [ Hash | String ] :hint The index to use for this operation.
     #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
+    # @option options [ Hash ] :let Mapping of variables to use in the command.
+    #   See the server documentation for details.
     #
     # @return [ BSON::Document, nil ] The document, if found.
     #
@@ -854,6 +870,8 @@ module Mongo
     # @option options [ Session ] :session The session to use.
     # @option options [ Hash | String ] :hint The index to use for this operation.
     #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
+    # @option options [ Hash ] :let Mapping of variables to use in the command.
+    #   See the server documentation for details.
     #
     # @return [ BSON::Document ] The document.
     #
@@ -890,6 +908,8 @@ module Mongo
     # @option options [ Session ] :session The session to use.
     # @option options [ Hash | String ] :hint The index to use for this operation.
     #   May be specified as a Hash (e.g. { _id: 1 }) or a String (e.g. "_id_").
+    # @option options [ Hash ] :let Mapping of variables to use in the command.
+    #   See the server documentation for details.
     #
     # @return [ BSON::Document ] The document.
     #