mongo 2.12.4 → 2.14.0.rc1

data/lib/mongo/cluster/topology.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# 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.
@@ -62,12 +62,29 @@ module Mongo
       # @param [ Monitoring ] monitoring The monitoring.
       # @param [ Hash ] options The cluster options.
       #
+      # @option options [ true | false ] :direct_connection Whether to connect
+      #   directly to the specified seed, bypassing topology discovery. Exactly
+      #   one seed must be provided.
+      # @option options [ Symbol ] :connect Deprecated - use :direct_connection
+      #   option instead of this option. The connection method to use. This
+      #   forces the cluster to behave in the specified way instead of
+      #   auto-discovering. One of :direct, :replica_set, :sharded
+      # @option options [ Symbol ] :replica_set The name of the replica set to
+      #   connect to. Servers not in this replica set will be ignored.
+      #
       # @return [ ReplicaSet, Sharded, Single ] The topology.
       #
       # @since 2.0.0
       # @api private
       def initial(cluster, monitoring, options)
-        cls = if options.key?(:connect)
+        cls = if options[:direct_connection]
+          if options[:connect] && options[:connect] && options[:connect].to_sym != :direct
+            raise ArgumentError, "Conflicting topology options: direct_connection=true and connect=#{options[:connect]}"
+          end
+          Single
+        elsif options[:direct_connection] == false && options[:connect] && options[:connect].to_sym == :direct
+          raise ArgumentError, "Conflicting topology options: direct_connection=false and connect=#{options[:connect]}"
+        elsif options.key?(:connect)
           OPTIONS.fetch(options[:connect].to_sym)
         elsif options.key?(:replica_set) || options.key?(:replica_set_name)
           ReplicaSetNoPrimary

data/lib/mongo/cluster/topology/base.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# Copyright (C) 2018-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.

data/lib/mongo/cluster/topology/no_replica_set_options.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# Copyright (C) 2018-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.

data/lib/mongo/cluster/topology/replica_set_no_primary.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# 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.
@@ -73,8 +73,9 @@ module Mongo
         # @return [ true, false ] If a readable server is present.
         #
         # @since 2.4.0
+        # @deprecated
         def has_readable_server?(cluster, server_selector = nil)
-          (server_selector || ServerSelector.primary).candidates(cluster).any?
+          !(server_selector || ServerSelector.primary).try_select_server(cluster).nil?
         end
 
         # Determine if the topology would select a writable server for the
@@ -89,7 +90,7 @@ module Mongo
         #
         # @since 2.4.0
         def has_writable_server?(cluster)
-          cluster.servers.any?{ |server| server.primary? }
+          !ServerSelector.primary.try_select_server(cluster).nil?
         end
 
         # A replica set topology is a replica set.

data/lib/mongo/cluster/topology/replica_set_with_primary.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2018-2019 MongoDB, Inc.
+# Copyright (C) 2018-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.

data/lib/mongo/cluster/topology/sharded.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# 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.
@@ -97,7 +97,7 @@ module Mongo
         #
         # @since 2.0.0
         def servers(servers)
-          servers.select{ |server| server.mongos? }
+          servers.select { |server| server.mongos? }
         end
 
         # A sharded topology is sharded.

data/lib/mongo/cluster/topology/single.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# 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.
@@ -96,7 +96,7 @@ module Mongo
         #
         # @since 2.0.0
         def servers(servers, name = nil)
-          [ servers.detect { |server| !server.unknown? } ]
+          servers.reject { |server| server.unknown? }
         end
 
         # A single topology is not sharded.
@@ -133,7 +133,7 @@ module Mongo
 
         def validate_options(options, cluster)
           if cluster.servers_list.length > 1
-            raise ArgumentError, 'Cannot instantiate a single topology with more than one server in the cluster'
+            raise ArgumentError, "Cannot instantiate a single topology with more than one server in the cluster: #{cluster.servers_list.map(&:address).map(&:seed).join(', ')}"
           end
 
           super(options, cluster)

data/lib/mongo/cluster/topology/unknown.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2015-2019 MongoDB, Inc.
+# Copyright (C) 2015-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.

data/lib/mongo/cluster_time.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2019 MongoDB, Inc.
+# Copyright (C) 2019-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.

data/lib/mongo/collection.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# 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.
@@ -223,6 +223,7 @@ module Mongo
     # @param [ Hash ] opts The options for the create operation.
     #
     # @option options [ Session ] :session The session to use for the operation.
+    # @option opts [ Hash ] :write_concern The write concern options.
     #
     # @return [ Result ] The result of the command.
     #
@@ -239,8 +240,13 @@ module Mongo
       operation.delete(:write)
       operation.delete(:write_concern)
       client.send(:with_session, opts) do |session|
+        write_concern = if opts[:write_concern]
+          WriteConcern.get(opts[:write_concern])
+        else
+          self.write_concern
+        end
         server = next_primary(nil, session)
-        if (options[:collation] || options[Operation::COLLATION]) && !server.features.collation_enabled?
+        if (options[:collation] || options[Operation::COLLATION]) && !server.with_connection { |connection| connection.features }.collation_enabled?
           raise Error::UnsupportedCollation
         end
 
@@ -264,12 +270,19 @@ module Mongo
     # @param [ Hash ] opts The options for the drop operation.
     #
     # @option options [ Session ] :session The session to use for the operation.
+    # @option opts [ Hash ] :write_concern The write concern options.
     #
     # @return [ Result ] The result of the command.
     #
     # @since 2.0.0
     def drop(opts = {})
       client.send(:with_session, opts) do |session|
+        temp_write_concern = write_concern
+        write_concern = if opts[:write_concern]
+          WriteConcern.get(opts[:write_concern])
+        else
+          temp_write_concern
+        end
         Operation::Drop.new({
                               selector: { :drop => name },
                               db_name: database.name,
@@ -297,6 +310,10 @@ module Mongo
     # @param [ Hash ] filter The filter to use in the find.
     # @param [ Hash ] options The options for the find.
     #
+    # @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 [ true, false ] :allow_partial_results Allows the query to get partial
     #   results if some shards are down.
     # @option options [ Integer ] :batch_size The number of documents returned in each batch
@@ -400,7 +417,7 @@ module Mongo
       View::ChangeStream.new(View.new(self, {}, options), pipeline, nil, options)
     end
 
-    # Gets the number of matching documents in the collection.
+    # Gets an estimated number of matching documents in the collection.
     #
     # @example Get the count.
     #   collection.count(name: 1)
@@ -429,11 +446,13 @@ module Mongo
       View.new(self, filter || {}, options).count(options)
     end
 
-    # Gets the number of of matching documents in the collection. Unlike the deprecated #count
-    # method, this will return the exact number of documents matching the filter rather than the estimate.
+    # Gets the number of documents matching the query. Unlike the deprecated
+    # #count method, this will return the exact number of documents matching
+    # the filter (or exact number of documents in the collection, if no filter
+    # is provided) rather than an estimate.
     #
-    # @example Get the number of documents in the collection.
-    #   collection_view.count_documents
+    # Use #estimated_document_count to retrieve an estimate of the number
+    # of documents in the collection using the collection metadata.
     #
     # @param [ Hash ] filter A filter for matching documents.
     # @param [ Hash ] options Options for the operation.
@@ -450,19 +469,20 @@ module Mongo
     # @return [ Integer ] The document count.
     #
     # @since 2.6.0
-    def count_documents(filter, options = {})
+    def count_documents(filter = {}, options = {})
       View.new(self, filter, options).count_documents(options)
     end
 
-    # Gets an estimate of the count of documents in a collection using collection metadata.
+    # Gets an estimate of the number of documents in the collection using the
+    # collection metadata.
     #
-    # @example Get the number of documents in the collection.
-    #   collection_view.estimated_document_count
+    # Use #count_documents to retrieve the exact number of documents in the
+    # collection, or to count documents matching a filter.
     #
     # @param [ Hash ] options Options for the operation.
     #
-    # @option opts :max_time_ms [ Integer ] The maximum amount of time to allow the command to
-    #   run.
+    # @option opts :max_time_ms [ Integer ] The maximum amount of time to allow
+    #   the command to run for on the server.
     # @option opts [ Hash ] :read The read preference options.
     #
     # @return [ Integer ] The document count.
@@ -536,20 +556,26 @@ module Mongo
     #
     # @since 2.0.0
     def insert_one(document, opts = {})
+      QueryCache.clear_namespace(namespace)
+
       client.send(: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|
           Operation::Insert.new(
-              :documents => [ document ],
-              :db_name => database.name,
-              :coll_name => name,
-              :write_concern => write_concern,
-              :bypass_document_validation => !!opts[:bypass_document_validation],
-              :options => opts,
-              :id_generator => client.options[:id_generator],
-              :session => session,
-              :txn_num => txn_num
-           ).execute(server, client: client)
+            :documents => [ document ],
+            :db_name => database.name,
+            :coll_name => name,
+            :write_concern => write_concern,
+            :bypass_document_validation => !!opts[:bypass_document_validation],
+            :options => opts,
+            :id_generator => client.options[:id_generator],
+            :session => session,
+            :txn_num => txn_num
+          ).execute(server, client: client)
         end
       end
     end
@@ -568,6 +594,8 @@ module Mongo
     #
     # @since 2.0.0
     def insert_many(documents, options = {})
+      QueryCache.clear_namespace(namespace)
+
       inserts = documents.map{ |doc| { :insert_one => doc }}
       bulk_write(inserts, options)
     end
@@ -605,6 +633,8 @@ module Mongo
     #
     # @option options [ Hash ] :collation The collation to use.
     # @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_").
     #
     # @return [ Result ] The response from the database.
     #
@@ -623,6 +653,8 @@ module Mongo
     #
     # @option options [ Hash ] :collation The collation to use.
     # @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_").
     #
     # @return [ Result ] The response from the database.
     #
@@ -669,6 +701,8 @@ module Mongo
     #   not to skip document level validation.
     # @option options [ Hash ] :collation The collation to use.
     # @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_").
     #
     # @return [ Result ] The response from the database.
     #
@@ -694,6 +728,8 @@ module Mongo
     # @option options [ Array ] :array_filters A set of filters specifying to which array elements
     #   an update should apply.
     # @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_").
     #
     # @return [ Result ] The response from the database.
     #
@@ -719,6 +755,8 @@ module Mongo
     # @option options [ Array ] :array_filters A set of filters specifying to which array elements
     #   an update should apply.
     # @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_").
     #
     # @return [ Result ] The response from the database.
     #
@@ -745,6 +783,8 @@ module Mongo
     #   Defaults to the collection's write concern.
     # @option options [ Hash ] :collation The collation to use.
     # @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_").
     #
     # @return [ BSON::Document, nil ] The document, if found.
     #
@@ -781,6 +821,8 @@ module Mongo
     # @option options [ Array ] :array_filters A set of filters specifying to which array elements
     #   an update should apply.
     # @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_").
     #
     # @return [ BSON::Document ] The document.
     #
@@ -815,6 +857,8 @@ module Mongo
     #   Defaults to the collection's write concern.
     # @option options [ Hash ] :collation The collation to use.
     # @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_").
     #
     # @return [ BSON::Document ] The document.
     #
@@ -834,5 +878,14 @@ module Mongo
     def namespace
       "#{database.name}.#{name}"
     end
+
+    # Whether the collection is a system collection.
+    #
+    # @return [ Boolean ] Whether the system is a system collection.
+    #
+    # @api private
+    def system_collection?
+      name.start_with?('system.')
+    end
   end
 end

data/lib/mongo/collection/view.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# 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 +116,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 :projection [ 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 +205,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

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

@@ -1,4 +1,4 @@
-# Copyright (C) 2014-2019 MongoDB, Inc.
+# 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.
@@ -89,6 +89,16 @@ module Mongo
           self.class.new(view, pipeline, options.merge(explain: true)).first
         end
 
+        # Whether this aggregation will write its result to a database collection.
+        #
+        # @return [ Boolean ] Whether the aggregation will write its result
+        #   to a collection.
+        #
+        # @api private
+        def write?
+          pipeline.any? { |op| op.key?('$out') || op.key?(:$out) || op.key?('$merge') || op.key?(:$merge) }
+        end
+
         private
 
         def server_selector
@@ -108,11 +118,10 @@ module Mongo
         end
 
         def valid_server?(server)
-          server.standalone? || server.mongos? || server.primary? || secondary_ok?
-        end
-
-        def write?
-          pipeline.any? { |op| op.key?('$out') || op.key?(:$out) || op.key?('$merge') || op.key?(:$merge) }
+          description = server.with_connection do |connection|
+            connection.description
+          end
+          description.standalone? || description.mongos? || description.primary? || secondary_ok?
         end
 
         def secondary_ok?
@@ -129,10 +138,25 @@ module Mongo
         end
 
         def validate_collation!(server)
-          if options[:collation] && !server.features.collation_enabled?
+          if options[:collation] && !server.with_connection { |connection| connection.features }.collation_enabled?
             raise Error::UnsupportedCollation.new
           end
         end
+
+        # Skip, sort, limit, projection are specified as pipeline stages
+        # rather than as options.
+        def cache_options
+          {
+            namespace: collection.namespace,
+            selector: pipeline,
+            read_concern: view.read_concern,
+            read_preference: view.read_preference,
+            collation: options[:collation],
+            # Aggregations can read documents from more than one collection,
+            # so they will be cleared on every write operation.
+            multi_collection: true,
+          }
+        end
       end
     end
   end