mongo 2.0.6 → 2.1.0

data/lib/mongo/cluster.rb

@@ -65,9 +65,9 @@ module Mongo
       address = Address.new(host)
       if !addresses.include?(address)
         if addition_allowed?(address)
-          log_debug([ "Adding #{address.to_s} to the cluster." ])
+          log_debug("Adding #{address.to_s} to the cluster.")
           @update_lock.synchronize { @addresses.push(address) }
-          server = Server.new(address, self, event_listeners, options)
+          server = Server.new(address, self, @monitoring, event_listeners, options)
           @update_lock.synchronize { @servers.push(server) }
           server
         end
@@ -76,16 +76,22 @@ module Mongo
 
     # Instantiate the new cluster.
     #
+    # @api private
+    #
     # @example Instantiate the cluster.
-    #   Mongo::Cluster.new(["127.0.0.1:27017"])
+    #   Mongo::Cluster.new(["127.0.0.1:27017"], monitoring)
+    #
+    # @note Cluster should never be directly instantiated outside of a Client.
     #
     # @param [ Array<String> ] seeds The addresses of the configured servers.
+    # @param [ Monitoring ] monitoring The monitoring.
     # @param [ Hash ] options The options.
     #
     # @since 2.0.0
-    def initialize(seeds, options = {})
+    def initialize(seeds, monitoring, options = Options::Redacted.new)
       @addresses = []
       @servers = []
+      @monitoring = monitoring
       @event_listeners = Event::Listeners.new
       @options = options.freeze
       @topology = Topology.initial(seeds, options)
@@ -119,7 +125,7 @@ module Mongo
     #
     # @since 2.0.0
     def next_primary
-      ServerSelector.get({ mode: :primary }, options).select_server(self)
+      ServerSelector.get(ServerSelector::PRIMARY.merge(options)).select_server(self)
     end
 
     # Elect a primary server from the description that has just changed to a
@@ -160,7 +166,7 @@ module Mongo
     #
     # @since 2.0.0
     def remove(host)
-      log_debug([ "#{host} being removed from the cluster." ])
+      log_debug("#{host} being removed from the cluster.")
       address = Address.new(host)
       removed_servers = @servers.select { |s| s.address == address }
       @update_lock.synchronize { @servers = @servers - removed_servers }
@@ -196,6 +202,31 @@ module Mongo
       topology.servers(servers_list.compact).compact
     end
 
+    # Disconnect all servers.
+    #
+    # @example Disconnect the cluster's servers.
+    #   cluster.disconnect!
+    #
+    # @return [ true ] Always true.
+    #
+    # @since 2.1.0
+    def disconnect!
+      @servers.each { |server| server.disconnect! } and true
+    end
+
+    # Reconnect all servers.
+    #
+    # @example Reconnect the cluster's servers.
+    #   cluster.reconnect!
+    #
+    # @return [ true ] Always true.
+    #
+    # @since 2.1.0
+    def reconnect!
+      scan!
+      servers.each { |server| server.reconnect! } and true
+    end
+
     # Add hosts in a description to the cluster.
     #
     # @example Add hosts in a description to the cluster.
@@ -240,7 +271,11 @@ module Mongo
     #
     # @since 2.0.0
     def self.create(client)
-      cluster = Cluster.new(client.cluster.addresses.map(&:to_s), client.options)
+      cluster = Cluster.new(
+        client.cluster.addresses.map(&:to_s),
+        client.instance_variable_get(:@monitoring).dup,
+        client.options
+      )
       client.instance_variable_set(:@cluster, cluster)
     end
 

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

@@ -25,6 +25,8 @@ module Mongo
         include Immutable
         include Iterable
         include Explainable
+        include Loggable
+        include Retryable
 
         # @return [ View ] view The collection view.
         attr_reader :view
@@ -37,6 +39,20 @@ module Mongo
         # Delegate necessary operations to the collection.
         def_delegators :collection, :database
 
+        # Options mapping for an aggregation.
+        #
+        # @since 2.1.0
+        OPTIONS_MAP = {
+          :allow_disk_use => :allowDiskUse,
+          :max_time_ms => :maxTimeMS,
+          :explain => :explain
+        }.freeze
+
+        # The reroute message.
+        #
+        # @since 2.1.0
+        REROUTE = 'Rerouting the Aggregation operation to the primary server.'.freeze
+
         # Set to true if disk usage is allowed during the aggregation.
         #
         # @example Set disk usage flag.
@@ -49,7 +65,7 @@ module Mongo
         #
         # @since 2.0.0
         def allow_disk_use(value = nil)
-          configure(:allowDiskUse, value)
+          configure(__method__, value)
         end
 
         # Initialize the aggregation for the provided collection view, pipeline
@@ -89,11 +105,28 @@ module Mongo
             :selector => {
               :aggregate => collection.name,
               :pipeline => pipeline,
-              :cursor => view.batch_size ? { :batchSize => view.batch_size } : {}
-            }.merge!(options)
+              :cursor => cursor,
+            }.merge!(agg_options)
           }
         end
 
+        def agg_options
+          @agg_options ||= options.each.reduce({}) do |opts, (key, value)|
+            OPTIONS_MAP[key] ? opts.merge!(OPTIONS_MAP[key] => value) : opts
+          end
+        end
+
+        def cursor
+          if options[:use_cursor] == true || options[:use_cursor].nil?
+            batch_size_doc
+          end
+        end
+
+        def batch_size_doc
+          (value = options[:batch_size] || view.batch_size) ?
+              { :batchSize => value } : {}
+        end
+
         def explain_options
           { :explain => true }
         end
@@ -106,14 +139,20 @@ module Mongo
           Operation::Aggregate.new(aggregate_spec)
         end
 
+        def valid_server?(server)
+          server.standalone? || server.mongos? || server.primary? || secondary_ok?
+        end
+
+        def secondary_ok?
+          pipeline.none? { |op| op.key?('$out') || op.key?(:$out) }
+        end
+
         def send_initial_query(server)
-          begin
-            initial_query_op.execute(server.context)
-          rescue Mongo::Error::NeedPrimaryServer
-            warn 'Rerouting the Aggregation operation to the primary server.'
-            server = ServerSelector.get(mode: :primary).select_server(cluster)
-            initial_query_op.execute(server.context)
+          unless valid_server?(server)
+            log_warn(REROUTE)
+            server = cluster.next_primary
           end
+          initial_query_op.execute(server.context)
         end
       end
     end

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

@@ -22,14 +22,14 @@ module Mongo
 
         private
 
-        # @api private
-        #
-        # @note In the including class, the method #immutable needs to be
-        #   implemented in order to define how a new class of that type needs to
-        #   be instantiated.
         def configure(field, value)
           return options[field] if value.nil?
-          new(options.merge(field => value))
+          new(options.merge(field => value, :modifiers => @modifiers))
+        end
+
+        def configure_modifier(field, value)
+          return @modifiers[Readable::SPECIAL_FIELDS[field]] if value.nil?
+          new(options.merge(:modifiers => @modifiers.merge(Readable::SPECIAL_FIELDS[field] => value)))
         end
 
         def configure_flag(flag)

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

@@ -35,12 +35,26 @@ module Mongo
         #
         # @yieldparam [ Hash ] Each matching document.
         def each
-          server = read.select_server(cluster)
-          cursor = Cursor.new(view, send_initial_query(server), server).to_enum
-          cursor.each do |doc|
+          @cursor = nil
+          read_with_retry do
+            server = read.select_server(cluster)
+            result = send_initial_query(server)
+            @cursor = Cursor.new(view, result, server)
+          end
+          @cursor.each do |doc|
             yield doc
           end if block_given?
-          cursor
+          @cursor.to_enum
+        end
+
+        # Stop the iteration by sending a KillCursors command to the server.
+        #
+        # @example Stop the iteration.
+        #   view.close_query
+        #
+        # @since 2.1.0
+        def close_query
+          @cursor.send(:kill_cursors) if @cursor
         end
       end
     end

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

@@ -24,7 +24,18 @@ module Mongo
         extend Forwardable
         include Enumerable
         include Immutable
-        include Iterable
+        include Loggable
+        include Retryable
+
+        # The inline option.
+        #
+        # @since 2.1.0
+        INLINE = 'inline'.freeze
+
+        # Reroute message.
+        #
+        # @since 2.1.0
+        REROUTE = 'Rerouting the MapReduce operation to the primary server.'.freeze
 
         # @return [ View ] view The collection view.
         attr_reader :view
@@ -41,6 +52,31 @@ module Mongo
         # Delegate necessary operations to the collection.
         def_delegators :collection, :database
 
+        # Iterate through documents returned by the map/reduce.
+        #
+        # @example Iterate through the result of the map/reduce.
+        #   map_reduce.each do |document|
+        #     p document
+        #   end
+        #
+        # @return [ Enumerator ] The enumerator.
+        #
+        # @since 2.0.0
+        #
+        # @yieldparam [ Hash ] Each matching document.
+        def each
+          @cursor = nil
+          write_with_retry do
+            server = read.select_server(cluster)
+            result = send_initial_query(server)
+            @cursor = Cursor.new(view, result, server)
+          end
+          @cursor.each do |doc|
+            yield doc
+          end if block_given?
+          @cursor.to_enum
+        end
+
         # Set or get the finalize function for the operation.
         #
         # @example Set the finalize function.
@@ -147,7 +183,7 @@ module Mongo
         private
 
         def inline?
-          out.nil? || out == { inline: 1 } || out == { 'inline' => 1 }
+          out.nil? || out == { inline: 1 } || out == { INLINE => 1 }
         end
 
         def map_reduce_spec
@@ -158,12 +194,16 @@ module Mongo
               :mapreduce => collection.name,
               :map => map,
               :reduce => reduce,
-              :query => view.selector[:$query] || view.selector,
+              :query => view.modifiers[:$query] || view.selector,
               :out => { inline: 1 }
-            }.merge(options).merge(view.options)
+            }.merge(options).merge(view_options)
           }
         end
 
+        def view_options
+          view.sort ? view.options.merge(:sort => view.sort) : view.options
+        end
+
         def new(options)
           MapReduce.new(view, map, reduce, options)
         end
@@ -172,27 +212,28 @@ module Mongo
           Operation::MapReduce.new(map_reduce_spec)
         end
 
+        def valid_server?(server)
+          server.standalone? || server.mongos? || server.primary? || secondary_ok?
+        end
+
+        def secondary_ok?
+          out.respond_to?(:keys) && out.keys.first.to_s.downcase == INLINE
+        end
+
         def send_initial_query(server)
-          result =
-            begin
-              initial_query_op.execute(server.context)
-            rescue Mongo::Error::NeedPrimaryServer
-              warn 'Rerouting the MapReduce operation to the primary server.'
-              server = ServerSelector.get(mode: :primary).select_server(cluster)
-              initial_query_op.execute(server.context)
-            end
-          if inline?
-            result
-          else
-            send_fetch_query(server)
+          unless valid_server?(server)
+            log_warn(REROUTE)
+            server = cluster.next_primary
           end
+          result = initial_query_op.execute(server.context)
+          inline? ? result : send_fetch_query(server)
         end
 
         def fetch_query_spec
           { :selector  => {},
             :options   => {},
             :db_name   => database.name,
-            :coll_name => out.values.first }
+            :coll_name => out.respond_to?(:keys) ? out.values.first : out }
         end
 
         def fetch_query_op

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

@@ -21,19 +21,32 @@ module Mongo
       # @since 2.0.0
       module Readable
 
-        # Special fields and their getters for the query selector.
+        # Special fields and their option names for the query selector.
         #
         # @since 2.0.0
         SPECIAL_FIELDS = {
-          :$query => :selector,
-          :$readPreference => :read_pref_formatted,
-          :$orderby => :sort,
-          :$hint => :hint,
-          :$comment => :comment,
-          :$snapshot => :snapshot,
-          :$maxScan => :max_scan,
-          :$showDiskLoc => :show_disk_loc,
-          :$explain => :explained?
+          :sort => :$orderby,
+          :hint => :$hint,
+          :comment => :$comment,
+          :snapshot => :$snapshot,
+          :max_scan => :$maxScan,
+          :max_value => :$max,
+          :min_value => :$min,
+          :max_time_ms => :$maxTimeMS,
+          :return_key => :$returnKey,
+          :show_disk_loc => :$showDiskLoc,
+          :explain => :$explain
+        }.freeze
+
+        # Options to cursor flags mapping.
+        #
+        # @since 2.1.0
+        CURSOR_FLAGS_MAP = {
+          :allow_partial_results => [ :partial ],
+          :oplog_replay => [ :oplog_replay ],
+          :no_cursor_timeout => [ :no_cursor_timeout ],
+          :tailable => [ :tailable_cursor ],
+          :tailable_await => [ :await_data, :tailable_cursor]
         }.freeze
 
         # Execute an aggregation on the collection view.
@@ -97,7 +110,7 @@ module Mongo
         #
         # @since 2.0.0
         def comment(comment = nil)
-          configure(:comment, comment)
+          configure_modifier(:comment, comment)
         end
 
         # Get a count of matching documents in the collection.
@@ -111,6 +124,8 @@ module Mongo
         # @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_time_ms [ Integer ] The maximum amount of time to allow the
+        #   command to run.
         # @option options :read [ Hash ] The read preference for this command.
         #
         # @return [ Integer ] The document count.
@@ -121,7 +136,10 @@ module Mongo
           cmd[:skip] = options[:skip] if options[:skip]
           cmd[:hint] = options[:hint] if options[:hint]
           cmd[:limit] = options[:limit] if options[:limit]
-          database.command(cmd, options).n
+          cmd[:maxTimeMS] = options[:max_time_ms] if options[:max_time_ms]
+          read_with_retry do
+            database.command(cmd, options).n
+          end
         end
 
         # Get a list of distinct values for a specific field.
@@ -132,18 +150,21 @@ module Mongo
         # @param [ String, Symbol ] field_name The name of the field.
         # @param [ Hash ] options Options for the distinct command.
         #
+        # @option options :max_time_ms [ Integer ] The maximum amount of time to allow the
+        #   command to run.
         # @option options :read [ Hash ] The read preference for this command.
         #
         # @return [ Array<Object> ] The list of distinct values.
         #
         # @since 2.0.0
         def distinct(field_name, options={})
-          database.command({
-            :distinct => collection.name,
-            :key => field_name.to_s,
-            :query => selector },
-            options
-          ).documents.first['values']
+          cmd = { :distinct => collection.name,
+                  :key => field_name.to_s,
+                  :query => selector }
+          cmd[:maxTimeMS] = options[:max_time_ms] if options[:max_time_ms]
+          read_with_retry do
+            database.command(cmd, options).first['values']
+          end
         end
 
         # The index that MongoDB will be forced to use for the query.
@@ -157,7 +178,7 @@ module Mongo
         #
         # @since 2.0.0
         def hint(hint = nil)
-          configure(:hint, hint)
+          configure_modifier(:hint, hint)
         end
 
         # The max number of docs to return from the query.
@@ -201,7 +222,35 @@ module Mongo
         #
         # @since 2.0.0
         def max_scan(value = nil)
-          configure(:max_scan, value)
+          configure_modifier(:max_scan, value)
+        end
+
+        # Set the maximum value to search.
+        #
+        # @example Set the max value.
+        #   view.max_value(_id: 1)
+        #
+        # @param [ Hash ] value The max field and value.
+        #
+        # @return [ Hash, View ] The value or a new +View+.
+        #
+        # @since 2.1.0
+        def max_value(value = nil)
+          configure_modifier(:max_value, value)
+        end
+
+        # Set the minimum value to search.
+        #
+        # @example Set the min value.
+        #   view.min_value(_id: 1)
+        #
+        # @param [ Hash ] value The min field and value.
+        #
+        # @return [ Hash, View ] The value or a new +View+.
+        #
+        # @since 2.1.0
+        def min_value(value = nil)
+          configure_modifier(:min_value, value)
         end
 
         # The server normally times out idle cursors after an inactivity period
@@ -249,7 +298,22 @@ module Mongo
         # @since 2.0.0
         def read(value = nil)
           return default_read if value.nil?
-          configure(:read, value)
+          selector = value.is_a?(Hash) ? ServerSelector.get(client.options.merge(value)) : value
+          configure(:read, selector)
+        end
+
+        # Set whether to return only the indexed field or fields.
+        #
+        # @example Set the return key value.
+        #   view.return_key(true)
+        #
+        # @param [ true, false ] value The return key value.
+        #
+        # @return [ true, false, View ] The value or a new +View+.
+        #
+        # @since 2.1.0
+        def return_key(value = nil)
+          configure_modifier(:return_key, value)
         end
 
         # Set whether the disk location should be shown for each document.
@@ -264,7 +328,7 @@ module Mongo
         #
         # @since 2.0.0
         def show_disk_loc(value = nil)
-          configure(:show_disk_loc, value)
+          configure_modifier(:show_disk_loc, value)
         end
 
         # The number of docs to skip before returning results.
@@ -294,7 +358,7 @@ module Mongo
         #
         # @since 2.0.0
         def snapshot(value = nil)
-          configure(:snapshot, value)
+          configure_modifier(:snapshot, value)
         end
 
         # The key and direction pairs by which the result set will be sorted.
@@ -309,33 +373,106 @@ module Mongo
         #
         # @since 2.0.0
         def sort(spec = nil)
-          configure(:sort, spec)
+          configure_modifier(:sort, spec)
+        end
+
+        # “meta” operators that let you modify the output or behavior of a query.
+        #
+        # @example Set the modifiers document.
+        #   view.modifiers(:$orderby => Mongo::Index::ASCENDING)
+        #
+        # @param [ Hash ] doc The modifiers document.
+        #
+        # @return [ Hash, View ] Either the modifiers document or a new +View+.
+        #
+        # @since 2.1.0
+        def modifiers(doc = nil)
+          return @modifiers if doc.nil?
+          new(options.merge(:modifiers => doc))
+        end
+
+        # A cumulative time limit in milliseconds for processing operations on a cursor.
+        #
+        # @example Set the max time ms value.
+        #   view.max_time_ms(500)
+        #
+        # @param [ Integer ] max The max time in milliseconds.
+        #
+        # @return [ Integer, View ] Either the max time ms value or a new +View+.
+        #
+        # @since 2.1.0
+        def max_time_ms(max = nil)
+          configure_modifier(:max_time_ms, max)
         end
 
         private
 
-        def default_read(read = nil)
+        def default_read
           options[:read] || read_preference
         end
 
         def flags
-          @flags ||= (!primary? ? [ :slave_ok ] : [])
+          @flags ||= CURSOR_FLAGS_MAP.each.reduce([]) do |flags, (key, value)|
+            if options[key] || (options[:cursor_type] && options[:cursor_type] == key)
+              flags.push(*value)
+            end
+            flags
+          end
         end
 
-        def has_special_fields?
-          sort || hint || comment || max_scan || show_disk_loc || snapshot || explained? || cluster.sharded?
+        def parallel_scan(cursor_count)
+          server = read.select_server(cluster)
+          Operation::ParallelScan.new(
+            :coll_name => collection.name,
+            :db_name => database.name,
+            :cursor_count => cursor_count
+          ).execute(server.context).cursor_ids.map do |cursor_id|
+            result = Operation::Read::GetMore.new({ :to_return => 0,
+                                                    :cursor_id => cursor_id,
+                                                    :db_name   => database.name,
+                                                    :coll_name => collection.name
+              }).execute(server.context)
+            Cursor.new(self, result, server)
+          end
+        end
+
+        def setup(sel, opts)
+          setup_options(opts)
+          setup_selector(sel)
         end
 
-        def primary?
-          read.name == :primary
+        def setup_options(opts)
+          @options = opts ? opts.dup : {}
+          @modifiers = @options[:modifiers] ? @options.delete(:modifiers).dup : BSON::Document.new
+          @options.keys.each { |k| @modifiers.merge!(SPECIAL_FIELDS[k] => @options.delete(k)) if SPECIAL_FIELDS[k] }
+          @options.freeze
+        end
+
+        def setup_selector(sel)
+          @selector = sel ? sel.dup : {}
+          if @selector[:$query] || @selector['$query']
+            @selector.keys.each { |k| @modifiers.merge!(k => @selector.delete(k)) if k[0] == '$' }
+          end
+          @modifiers.freeze
+          @selector.freeze
         end
 
         def query_options
-          { :project => projection, :skip => skip, :limit => to_return, :flags => flags }
+          {
+            :project => projection,
+            :skip => skip,
+            :limit => limit,
+            :flags => flags,
+            :batch_size => batch_size
+          }
+        end
+
+        def requires_special_selector?
+          !modifiers.empty? || cluster.sharded?
         end
 
         def query_spec
-          sel = has_special_fields? ? special_selector : selector
+          sel = requires_special_selector? ? special_selector : selector
           { :selector  => sel,
             :read      => read,
             :options   => query_options,
@@ -344,19 +481,13 @@ module Mongo
         end
 
         def read_pref_formatted
-          read.to_mongos
+          @read_formatted ||= read.to_mongos
         end
 
         def special_selector
-          SPECIAL_FIELDS.reduce({}) do |hash, (key, method)|
-            value = send(method)
-            hash[key] = value if value
-            hash
-          end
-        end
-
-        def to_return
-          [ limit || batch_size, batch_size || limit ].min
+          sel = BSON::Document.new(:$query => selector).merge!(modifiers)
+          sel[:$readPreference] = read_pref_formatted unless read_pref_formatted.nil?
+          sel
         end
 
         def validate_doc!(doc)