mongo 2.10.5 → 2.15.1

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

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -45,7 +48,25 @@ module Mongo
         #
         # @since 2.0.0
         def aggregate(pipeline, options = {})
-          Aggregation.new(self, pipeline, options)
+          aggregation = Aggregation.new(self, pipeline, options)
+
+          # Because the $merge and $out pipeline stages write documents to the
+          # collection, it is necessary to clear the cache when they are performed.
+          #
+          # Opt to clear the entire cache rather than one namespace because
+          # the $out and $merge stages do not have to write to the same namespace
+          # on which the aggregation is performed.
+          QueryCache.clear if aggregation.write?
+
+          aggregation
+        end
+
+        # Allows the server to write temporary data to disk while executing
+        # a find operation.
+        #
+        # @return [ View ] The new view.
+        def allow_disk_use
+          configure(:allow_disk_use, true)
         end
 
         # Allows the query to get partial results if some shards are down.
@@ -82,7 +103,7 @@ module Mongo
         # @param [ Integer ] batch_size The size of each batch of results.
         #
         # @return [ Integer, View ] Either the batch_size value or a
-        # new +View+.
+        #   new +View+.
         #
         # @since 2.0.0
         def batch_size(batch_size = nil)
@@ -154,8 +175,8 @@ module Mongo
                                      :db_name => database.name,
                                      :options => {:limit => -1},
                                      :read => read_pref,
-                                     :session => session
-              ).execute(server)
+                                     :session => session,
+              ).execute(server, context: Operation::Context.new(client: client, session: session))
             end.n.to_i
           end
         end
@@ -208,24 +229,56 @@ module Mongo
         #
         # @since 2.6.0
         def estimated_document_count(opts = {})
-          cmd = { count: collection.name }
-          cmd[:maxTimeMS] = opts[:max_time_ms] if opts[:max_time_ms]
-          if read_concern
-            cmd[:readConcern] = Options::Mapper.transform_values_to_strings(
-              read_concern)
+          unless view.filter.empty?
+            raise ArgumentError, "Cannot call estimated_document_count when querying with a filter"
           end
+
+          %i[limit skip].each do |opt|
+            if @options.key?(opt)
+              raise ArgumentError, "Cannot call estimated_document_count when querying with #{opt}"
+            end
+          end
+
           Mongo::Lint.validate_underscore_read_preference(opts[:read])
           read_pref = opts[:read] || read_preference
           selector = ServerSelector.get(read_pref || server_selector)
           with_session(opts) do |session|
+            context = Operation::Context.new(client: client, session: session)
             read_with_retry(session, selector) do |server|
-              Operation::Count.new(
-                selector: cmd,
-                db_name: database.name,
-                read: read_pref,
-                session: session
-              ).execute(server)
-            end.n.to_i
+              if server.description.server_version_gte?('5.0')
+                pipeline = [
+                  {'$collStats' => {'count' => {}}},
+                  {'$group' => {'_id' => 1, 'n' => {'$sum' => '$count'}}},
+                ]
+                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
+                cmd = { count: collection.name }
+                cmd[:maxTimeMS] = opts[:max_time_ms] if opts[:max_time_ms]
+                if read_concern
+                  cmd[:readConcern] = Options::Mapper.transform_values_to_strings(
+                    read_concern)
+                end
+                result = Operation::Count.new(
+                  selector: cmd,
+                  db_name: database.name,
+                  read: read_pref,
+                  session: session,
+                ).execute(server, context: context)
+                result.n.to_i
+              end
+            end
+          end
+        rescue Error::OperationFailure => exc
+          if exc.code == 26
+            # NamespaceNotFound
+            # This should only happen with the aggregation pipeline path
+            # (server 4.9+). Previous servers should return 0 for nonexistent
+            # collections.
+            0
+          else
+            raise
           end
         end
 
@@ -246,6 +299,9 @@ module Mongo
         #
         # @since 2.0.0
         def distinct(field_name, opts = {})
+          if field_name.nil?
+            raise ArgumentError, 'Field name for distinct operation must be not nil'
+          end
           cmd = { :distinct => collection.name,
                   :key => field_name.to_s,
                   :query => filter }
@@ -265,8 +321,8 @@ module Mongo
                                         :db_name => database.name,
                                         :options => {:limit => -1},
                                         :read => read_pref,
-                                        :session => session
-                                       }).execute(server)
+                                        :session => session,
+                                       }).execute(server, context: Operation::Context.new(client: client, session: session))
             end.first['values']
           end
         end
@@ -580,10 +636,10 @@ module Mongo
         end
 
         def server_selector
-          if options[:session] && options[:session].in_transaction?
+          @server_selector ||= if options[:session] && options[:session].in_transaction?
             ServerSelector.get(read_preference || client.server_selector)
           else
-            @server_selector ||= ServerSelector.get(read_preference || collection.server_selector)
+            ServerSelector.get(read_preference || collection.server_selector)
           end
         end
 
@@ -601,21 +657,21 @@ module Mongo
                   :read_concern => read_concern,
                   :session => session,
                 }.merge!(options))
-          cmd.execute(server).cursor_ids.map do |cursor_id|
-            result = if server.features.find_command_enabled?
+          cmd.execute(server, context: Operation::Context.new(client: client, session: session)).cursor_ids.map do |cursor_id|
+            result = if server.with_connection { |connection| connection.features }.find_command_enabled?
               Operation::GetMore.new({
                 :selector => {:getMore => BSON::Int64.new(cursor_id),
                              :collection => collection.name},
                 :db_name => database.name,
                 :session => session,
-              }).execute(server)
+              }).execute(server, context: Operation::Context.new(client: client, session: session))
              else
               Operation::GetMore.new({
                 :to_return => 0,
                 :cursor_id => BSON::Int64.new(cursor_id),
                 :db_name => database.name,
                 :coll_name => collection.name
-              }).execute(server)
+              }).execute(server, context: Operation::Context.new(client: client, session: session))
             end
             Cursor.new(self, result, server, session: session)
           end

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

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -39,31 +42,38 @@ module Mongo
         # @option opts [ Hash ] :projection The fields to include or exclude in the returned doc.
         # @option opts [ Hash ] :sort The key and direction pairs by which the result set
         #   will be sorted.
-        # @option opts [ Hash ] :write_concern The write concern options.
-        #   Defaults to the collection's write concern.
         # @option opts [ Hash ] :collation The collation to use.
         # @option opts [ Session ] :session The session to use.
+        # @option opts [ 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_").
         #
         # @return [ BSON::Document, nil ] The document, if found.
         #
         # @since 2.0.0
         def find_one_and_delete(opts = {})
+          QueryCache.clear_namespace(collection.namespace)
+
           cmd = { :findAndModify => collection.name, :query => filter, :remove => true }
           cmd[:fields] = projection if projection
           cmd[:sort] = sort if sort
           cmd[:maxTimeMS] = max_time_ms if max_time_ms
+          if opts[:bypass_document_validation]
+            cmd[:bypassDocumentValidation] = true
+          end
 
           with_session(opts) do |session|
             applied_write_concern = applied_write_concern(session)
             cmd[:writeConcern] = applied_write_concern.options if applied_write_concern
             write_with_retry(session, applied_write_concern) do |server, txn_num|
               apply_collation!(cmd, server, opts)
+              apply_hint!(cmd, server, opts.merge(write_concern: applied_write_concern))
+
               Operation::Command.new(
                   :selector => cmd,
                   :db_name => database.name,
                   :session => session,
-                  :txn_num => txn_num
-              ).execute(server)
+                  :txn_num => txn_num,
+              ).execute(server, context: Operation::Context.new(client: client, session: session))
             end
           end.first['value']
         end
@@ -83,9 +93,9 @@ module Mongo
         # @option opts [ true, false ] :upsert Whether to upsert if the document doesn't exist.
         # @option opts [ true, false ] :bypass_document_validation Whether or
         #   not to skip document level validation.
-        # @option opts [ Hash ] :write_concern The write concern options.
-        #   Defaults to the collection's write concern.
         # @option opts [ Hash ] :collation The collation to use.
+        # @option opts [ 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_").
         #
         # @return [ BSON::Document ] The document.
         #
@@ -111,17 +121,19 @@ module Mongo
         # @option opts [ true, false ] :upsert Whether to upsert if the document doesn't exist.
         # @option opts [ true, false ] :bypass_document_validation Whether or
         #   not to skip document level validation.
-        # @option opts [ Hash ] :write_concern The write concern options.
-        #   Defaults to the collection's write concern.
         # @option opts [ Hash ] :collation The collation to use.
         # @option opts [ Array ] :array_filters A set of filters specifying to which array elements
         # an update should apply.
         # @option opts [ Session ] :session The session to use.
+        # @option opts [ 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_").
         #
         # @return [ BSON::Document ] The document.
         #
         # @since 2.0.0
         def find_one_and_update(document, opts = {})
+          QueryCache.clear_namespace(collection.namespace)
+
           cmd = { :findAndModify => collection.name, :query => filter }
           cmd[:update] = document
           cmd[:fields] = projection if projection
@@ -129,7 +141,9 @@ module Mongo
           cmd[:new] = !!(opts[:return_document] && opts[:return_document] == :after)
           cmd[:upsert] = opts[:upsert] if opts[:upsert]
           cmd[:maxTimeMS] = max_time_ms if max_time_ms
-          cmd[:bypassDocumentValidation] = !!opts[:bypass_document_validation]
+          if opts[:bypass_document_validation]
+            cmd[:bypassDocumentValidation] = true
+          end
 
           value = with_session(opts) do |session|
             applied_write_concern = applied_write_concern(opts[:session])
@@ -137,12 +151,14 @@ module Mongo
             write_with_retry(session, applied_write_concern) do |server, txn_num|
               apply_collation!(cmd, server, opts)
               apply_array_filters!(cmd, server, opts)
+              apply_hint!(cmd, server, opts.merge(write_concern: applied_write_concern))
+
               Operation::Command.new(
                   :selector => cmd,
                   :db_name => database.name,
                   :session => session,
-                  :txn_num => txn_num
-              ).execute(server)
+                  :txn_num => txn_num,
+              ).execute(server, context: Operation::Context.new(client: client, session: session))
             end
           end.first['value']
           value unless value.nil? || value.empty?
@@ -157,23 +173,36 @@ module Mongo
         #
         # @option opts [ Hash ] :collation The collation to use.
         # @option opts [ Session ] :session The session to use.
+        # @option opts [ 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 opts [ Hash ] :write_concern The write concern options.
+        #   Can be :w => Integer, :fsync => Boolean, :j => Boolean.
         #
         # @return [ Result ] The response from the database.
         #
         # @since 2.0.0
         def delete_many(opts = {})
+          QueryCache.clear_namespace(collection.namespace)
+
           delete_doc = { Operation::Q => filter, Operation::LIMIT => 0 }
           with_session(opts) do |session|
-            write_concern = write_concern_with_session(session)
+            write_concern = if opts[:write_concern]
+              WriteConcern.get(opts[:write_concern])
+            else
+              write_concern_with_session(session)
+            end
             nro_write_with_retry(session, write_concern) do |server|
               apply_collation!(delete_doc, server, opts)
+              apply_hint!(delete_doc, server, opts.merge(write_concern: write_concern))
+
               Operation::Delete.new(
                   :deletes => [ delete_doc ],
                   :db_name => collection.database.name,
                   :coll_name => collection.name,
                   :write_concern => write_concern,
-                  :session => session
-              ).execute(server)
+                  :bypass_document_validation => !!opts[:bypass_document_validation],
+                  :session => session,
+              ).execute(server, context: Operation::Context.new(client: client, session: session))
             end
           end
         end
@@ -187,24 +216,37 @@ module Mongo
         #
         # @option opts [ Hash ] :collation The collation to use.
         # @option opts [ Session ] :session The session to use.
+        # @option opts [ 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 opts [ Hash ] :write_concern The write concern options.
+        #   Can be :w => Integer, :fsync => Boolean, :j => Boolean.
         #
         # @return [ Result ] The response from the database.
         #
         # @since 2.0.0
         def delete_one(opts = {})
+          QueryCache.clear_namespace(collection.namespace)
+
           delete_doc = { Operation::Q => filter, Operation::LIMIT => 1 }
           with_session(opts) do |session|
-            write_concern = write_concern_with_session(session)
+            write_concern = if opts[:write_concern]
+              WriteConcern.get(opts[:write_concern])
+            else
+              write_concern_with_session(session)
+            end
             write_with_retry(session, write_concern) do |server, txn_num|
               apply_collation!(delete_doc, server, opts)
+              apply_hint!(delete_doc, server, opts.merge(write_concern: write_concern))
+
               Operation::Delete.new(
                   :deletes => [ delete_doc ],
                   :db_name => collection.database.name,
                   :coll_name => collection.name,
                   :write_concern => write_concern,
+                  :bypass_document_validation => !!opts[:bypass_document_validation],
                   :session => session,
-                  :txn_num => txn_num
-              ).execute(server)
+                  :txn_num => txn_num,
+              ).execute(server, context: Operation::Context.new(client: client, session: session))
             end
           end
         end
@@ -223,11 +265,17 @@ module Mongo
         #   not to skip document level validation.
         # @option opts [ Hash ] :collation The collation to use.
         # @option opts [ Session ] :session The session to use.
+        # @option opts [ 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 opts [ Hash ] :write_concern The write concern options.
+        #   Can be :w => Integer, :fsync => Boolean, :j => Boolean.
         #
         # @return [ Result ] The response from the database.
         #
         # @since 2.0.0
         def replace_one(replacement, opts = {})
+          QueryCache.clear_namespace(collection.namespace)
+
           update_doc = { Operation::Q => filter,
                          Operation::U => replacement,
                         }
@@ -235,10 +283,16 @@ module Mongo
             update_doc['upsert'] = true
           end
           with_session(opts) do |session|
-            write_concern = write_concern_with_session(session)
+            write_concern = if opts[:write_concern]
+              WriteConcern.get(opts[:write_concern])
+            else
+              write_concern_with_session(session)
+            end
+
             write_with_retry(session, write_concern) do |server, txn_num|
               apply_collation!(update_doc, server, opts)
               apply_array_filters!(update_doc, server, opts)
+              apply_hint!(update_doc, server, opts.merge(write_concern: write_concern))
 
               Operation::Update.new(
                   :updates => [ update_doc ],
@@ -247,8 +301,8 @@ module Mongo
                   :write_concern => write_concern,
                   :bypass_document_validation => !!opts[:bypass_document_validation],
                   :session => session,
-                  :txn_num => txn_num
-              ).execute(server)
+                  :txn_num => txn_num,
+              ).execute(server, context: Operation::Context.new(client: client, session: session))
             end
           end
         end
@@ -269,11 +323,17 @@ module Mongo
         # @option opts [ Array ] :array_filters A set of filters specifying to
         #   which array elements an update should apply.
         # @option opts [ Session ] :session The session to use.
+        # @option opts [ 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 opts [ Hash ] :write_concern The write concern options.
+        #   Can be :w => Integer, :fsync => Boolean, :j => Boolean.
         #
         # @return [ Result ] The response from the database.
         #
         # @since 2.0.0
         def update_many(spec, opts = {})
+          QueryCache.clear_namespace(collection.namespace)
+
           update_doc = { Operation::Q => filter,
                          Operation::U => spec,
                          Operation::MULTI => true,
@@ -282,18 +342,24 @@ module Mongo
             update_doc['upsert'] = true
           end
           with_session(opts) do |session|
-            write_concern = write_concern_with_session(session)
+            write_concern = if opts[:write_concern]
+              WriteConcern.get(opts[:write_concern])
+            else
+              write_concern_with_session(session)
+            end
             nro_write_with_retry(session, write_concern) do |server|
               apply_collation!(update_doc, server, opts)
               apply_array_filters!(update_doc, server, opts)
+              apply_hint!(update_doc, server, opts.merge(write_concern: write_concern))
+
               Operation::Update.new(
                   :updates => [ update_doc ],
                   :db_name => collection.database.name,
                   :coll_name => collection.name,
                   :write_concern => write_concern,
                   :bypass_document_validation => !!opts[:bypass_document_validation],
-                  :session => session
-              ).execute(server)
+                  :session => session,
+              ).execute(server, context: Operation::Context.new(client: client, session: session))
             end
           end
         end
@@ -314,11 +380,17 @@ module Mongo
         # @option opts [ Array ] :array_filters A set of filters specifying to
         #   which array elements an update should apply.
         # @option opts [ Session ] :session The session to use.
+        # @option opts [ 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 opts [ Hash ] :write_concern The write concern options.
+        #   Can be :w => Integer, :fsync => Boolean, :j => Boolean.
         #
         # @return [ Result ] The response from the database.
         #
         # @since 2.0.0
         def update_one(spec, opts = {})
+          QueryCache.clear_namespace(collection.namespace)
+
           update_doc = { Operation::Q => filter,
                          Operation::U => spec,
                          }
@@ -326,10 +398,15 @@ module Mongo
             update_doc['upsert'] = true
           end
           with_session(opts) do |session|
-            write_concern = write_concern_with_session(session)
+            write_concern = if opts[:write_concern]
+              WriteConcern.get(opts[:write_concern])
+            else
+              write_concern_with_session(session)
+            end
             write_with_retry(session, write_concern) do |server, txn_num|
               apply_collation!(update_doc, server, opts)
               apply_array_filters!(update_doc, server, opts)
+              apply_hint!(update_doc, server, opts.merge(write_concern: write_concern))
 
               Operation::Update.new(
                   :updates => [ update_doc ],
@@ -338,14 +415,36 @@ module Mongo
                   :write_concern => write_concern,
                   :bypass_document_validation => !!opts[:bypass_document_validation],
                   :session => session,
-                  :txn_num => txn_num
-              ).execute(server)
+                  :txn_num => txn_num,
+              ).execute(server, context: Operation::Context.new(client: client, session: session))
             end
           end
         end
 
         private
 
+        def apply_hint!(doc, server, opts)
+          if hint = opts[:hint]
+            features = server.with_connection do |connection|
+              connection.description.features
+            end
+
+            write_concern = opts[:write_concern]
+            if write_concern && !write_concern.acknowledged?
+              raise Error::UnsupportedOption.hint_error(unacknowledged_write: true)
+            end
+
+            if doc.key?(:findAndModify) &&
+                !features.find_and_modify_option_validation_enabled?
+              raise Error::UnsupportedOption.hint_error
+            elsif !features.update_delete_option_validation_enabled?
+              raise Error::UnsupportedOption.hint_error
+            end
+
+            doc[:hint] = opts[:hint]
+          end
+        end
+
         def apply_array_filters!(doc, server, opts = {})
           if filters = opts[:array_filters] || opts[ARRAY_FILTERS]
             validate_array_filters!(server, filters)
@@ -354,7 +453,7 @@ module Mongo
         end
 
         def validate_array_filters!(server, filters)
-          if filters && !server.features.array_filters_enabled?
+          if filters && !server.with_connection { |connection| connection.features }.array_filters_enabled?
             raise Error::UnsupportedArrayFilters.new
           end
         end

data/lib/mongo/collection/view.rb

@@ -1,4 +1,7 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2014-2020 MongoDB Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -116,27 +119,35 @@ module Mongo
       # @param [ Hash ] filter The query filter.
       # @param [ Hash ] options The additional query options.
       #
-      # @option options :comment [ String ] Associate a comment with the query.
-      # @option options :batch_size [ Integer ] The number of docs to return in
-      #   each response from MongoDB.
-      # @option options :fields [ Hash ] The fields to include or exclude in
-      #   returned docs.
-      # @option options :hint [ Hash ] Override default index selection and force
-      #   MongoDB to use a specific index for the query.
-      # @option options :limit [ Integer ] Max number of docs to return.
-      # @option options :max_scan [ Integer ] Constrain the query to only scan the
-      #   specified number of docs. Use to prevent queries from running too long.
-      #   Deprecated as of MongoDB server version 4.0.
-      # @option options :read [ Symbol ] The read preference to use for the query.
-      #   If none is provided, the collection's default read preference is used.
-      # @option options :show_disk_loc [ true, false ] Return disk location info as
-      #   a field in each doc.
-      # @option options :skip [ Integer ] The number of documents to skip.
-      # @option options :snapshot [ true, false ] Prevents returning a doc more than
-      #   once. Deprecated as of MongoDB server version 4.0.
-      # @option options :sort [ Hash ] The key and direction pairs used to sort the
-      #   results.
+      # @option options [ true, false ] :allow_disk_use When set to true, the
+      #   server can write temporary data to disk while executing the find
+      #   operation. This option is only available on MongoDB server versions
+      #   4.4 and newer.
+      # @option options [ Integer ] :batch_size The number of documents to
+      #   return in each response from MongoDB.
       # @option options [ Hash ] :collation The collation to use.
+      # @option options [ String ] :comment Associate a comment with the query.
+      # @option options [ Hash ] :explain Execute an explain with the provided
+      #   explain options (known options are :verbose and :verbosity) rather
+      #   than a find.
+      # @option options [ Hash ] :hint Override the default index selection and
+      #   force MongoDB to use a specific index for the query.
+      # @option options [ Integer ] :limit Max number of documents to return.
+      # @option options [ Integer ] :max_scan Constrain the query to only scan
+      #   the specified number of documents. Use to prevent queries from
+      #   running for too long. Deprecated as of MongoDB server version 4.0.
+      # @option options [ Hash ] :projection The fields to include or exclude
+      #   in the returned documents.
+      # @option options [ Hash ] :read The read preference to use for the
+      #   query. If none is provided, the collection's default read preference
+      #   is used.
+      # @option options [ true | false ] :show_disk_loc Return disk location
+      #   info as a field in each doc.
+      # @option options [ Integer ] :skip The number of documents to skip.
+      # @option options [ true | false ] :snapshot Prevents returning a
+      #   document more than once. Deprecated as of MongoDB server version 4.0.
+      # @option options [ Hash ] :sort The key and direction pairs used to sort
+      #   the results.
       #
       # @since 2.0.0
       def initialize(collection, filter = {}, options = {})
@@ -197,7 +208,7 @@ module Mongo
       end
 
       def validate_collation!(server, coll)
-        if coll &&!server.features.collation_enabled?
+        if coll && !server.with_connection { |connection| connection.features }.collation_enabled?
           raise Error::UnsupportedCollation.new
         end
       end