mongo 2.0.6 → 2.1.0.beta

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

@@ -37,6 +37,15 @@ 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
+                      }
+
         # Set to true if disk usage is allowed during the aggregation.
         #
         # @example Set disk usage flag.
@@ -49,7 +58,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 +98,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
@@ -110,7 +136,9 @@ module Mongo
           begin
             initial_query_op.execute(server.context)
           rescue Mongo::Error::NeedPrimaryServer
-            warn 'Rerouting the Aggregation operation to the primary server.'
+            log_warn([
+              'Rerouting the Aggregation operation to the primary server.'
+            ])
             server = ServerSelector.get(mode: :primary).select_server(cluster)
             initial_query_op.execute(server.context)
           end

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

@@ -36,7 +36,8 @@ 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
+          initial_query = send_initial_query(server)
+          cursor = Cursor.new(view, initial_query, server).to_enum
           cursor.each do |doc|
             yield doc
           end if block_given?

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

@@ -177,7 +177,9 @@ module Mongo
             begin
               initial_query_op.execute(server.context)
             rescue Mongo::Error::NeedPrimaryServer
-              warn 'Rerouting the MapReduce operation to the primary server.'
+              log_warn([
+                'Rerouting the MapReduce operation to the primary server.'
+              ])
               server = ServerSelector.get(mode: :primary).select_server(cluster)
               initial_query_op.execute(server.context)
             end

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

@@ -32,10 +32,22 @@ module Mongo
           :$comment => :comment,
           :$snapshot => :snapshot,
           :$maxScan => :max_scan,
+          :$maxTimeMS => :max_time_ms,
           :$showDiskLoc => :show_disk_loc,
           :$explain => :explained?
         }.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.
         #
         # @example Aggregate documents.
@@ -53,6 +65,35 @@ module Mongo
           Aggregation.new(self, pipeline, options)
         end
 
+        # Execute a parallel scan on the collection view.
+        # Returns a list of up to cursor_count cursors that can be iterated concurrently.
+        # As long as the collection is not modified during scanning, each document appears once
+        # in one of the cursors' result sets.
+        #
+        # @example Execute a parallel collection scan.
+        #   view.parallel_scan(2)
+        #
+        # @param [ Integer ] cursor_count The max number of cursors to return.
+        #
+        # @return [ Array<Cursor> ] An array of cursors.
+        #
+        # @since 2.1
+        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
+
         # Allows the query to get partial results if some shards are down.
         #
         # @example Allow partial results.
@@ -111,6 +152,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,6 +164,7 @@ module Mongo
           cmd[:skip] = options[:skip] if options[:skip]
           cmd[:hint] = options[:hint] if options[:hint]
           cmd[:limit] = options[:limit] if options[:limit]
+          cmd[:maxTimeMS] = options[:max_time_ms] if options[:max_time_ms]
           database.command(cmd, options).n
         end
 
@@ -132,18 +176,19 @@ 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]
+          database.command(cmd, options).first['values']
         end
 
         # The index that MongoDB will be forced to use for the query.
@@ -249,7 +294,7 @@ module Mongo
         # @since 2.0.0
         def read(value = nil)
           return default_read if value.nil?
-          configure(:read, value)
+          configure(:read, value.is_a?(Hash) ? ServerSelector.get(value) : value)
         end
 
         # Set whether the disk location should be shown for each document.
@@ -312,6 +357,34 @@ module Mongo
           configure(: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)
+          configure(: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(:max_time_ms, max)
+        end
+
         private
 
         def default_read(read = nil)
@@ -319,15 +392,17 @@ module Mongo
         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?
-        end
-
-        def primary?
-          read.name == :primary
+          modifiers || sort || hint || comment || max_time_ms || max_scan ||
+              show_disk_loc || snapshot || explained? || cluster.sharded?
         end
 
         def query_options
@@ -349,7 +424,7 @@ module Mongo
 
         def special_selector
           SPECIAL_FIELDS.reduce({}) do |hash, (key, method)|
-            value = send(method)
+            value = send(method) || (options[:modifiers] && options[:modifiers][key])
             hash[key] = value if value
             hash
           end

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

@@ -34,10 +34,11 @@ module Mongo
           cmd = { :findandmodify => collection.name, :query => selector, :remove => true }
           cmd[:fields] = projection if projection
           cmd[:sort] = sort if sort
+          cmd[:maxTimeMS] = max_time_ms if max_time_ms
           database.command(cmd).first['value']
         end
 
-        # Finds a single document and replace it.
+        # Finds a single document and replaces it.
         #
         # @example Find a document and replace it, returning the original.
         #   view.find_one_and_replace({ name: 'test' }, :return_document => :before)
@@ -45,7 +46,7 @@ module Mongo
         # @example Find a document and replace it, returning the new document.
         #   view.find_one_and_replace({ name: 'test' }, :return_document => :after)
         #
-        # @param [ BSON::Document ] replacement The updates.
+        # @param [ BSON::Document ] replacement The replacement.
         # @param [ Hash ] opts The options.
         #
         # @option opts [ Symbol ] :return_document Either :before or :after.
@@ -79,6 +80,7 @@ module Mongo
           cmd[:sort] = sort if sort
           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
           value = database.command(cmd).first['value']
           value unless value.nil? || value.empty?
         end
@@ -112,7 +114,7 @@ module Mongo
         # @example Replace a single document.
         #   collection_view.replace_one({ name: 'test' })
         #
-        # @param [ Hash ] document The document to replace.
+        # @param [ Hash ] replacement The replacement document.
         # @param [ Hash ] opts The options.
         #
         # @option opts [ true, false ] :upsert Whether to upsert if the
@@ -121,14 +123,16 @@ module Mongo
         # @return [ Result ] The response from the database.
         #
         # @since 2.0.0
-        def replace_one(document, opts = {})
-          update(document, false, opts)
+        def replace_one(replacement, opts = {})
+          update(replacement, false, opts)
         end
 
         # Update documents in the collection.
         #
         # @example Update multiple documents in the collection.
         #   collection_view.update_many('$set' => { name: 'test' })
+        #
+        # @param [ Hash ] spec The update statement.
         # @param [ Hash ] opts The options.
         #
         # @option opts [ true, false ] :upsert Whether to upsert if the
@@ -145,6 +149,8 @@ module Mongo
         #
         # @example Update a single document in the collection.
         #   collection_view.update_one('$set' => { name: 'test' })
+        #
+        # @param [ Hash ] spec The update statement.
         # @param [ Hash ] opts The options.
         #
         # @option opts [ true, false ] :upsert Whether to upsert if the

data/lib/mongo/cursor.rb

@@ -97,12 +97,16 @@ module Mongo
     end
 
     def get_more_operation
-      Operation::Read::GetMore.new({
+      Operation::Read::GetMore.new(get_more_spec)
+    end
+
+    def get_more_spec
+      {
         :to_return => to_return,
         :cursor_id => @cursor_id,
         :db_name   => database.name,
         :coll_name => @coll_name || collection.name
-      })
+      }
     end
 
     def kill_cursors
@@ -110,7 +114,11 @@ module Mongo
     end
 
     def kill_cursors_operation
-      Operation::KillCursors.new({ :cursor_ids => [ @cursor_id ]})
+      Operation::KillCursors.new(kill_cursors_spec)
+    end
+
+    def kill_cursors_spec
+      { :cursor_ids => [ @cursor_id ]}
     end
 
     def limited?

data/lib/mongo/dbref.rb

@@ -0,0 +1,113 @@
+# Copyright (C) 2015 MongoDB, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the 'License');
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an 'AS IS' BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Mongo
+
+  # Represents a DBRef document in the database.
+  #
+  # @since 2.1.0
+  class DBRef
+    include BSON::JSON
+
+    # The constant for the collection reference field.
+    #
+    # @since 2.1.0
+    COLLECTION = '$ref'.freeze
+
+    # The constant for the id field.
+    #
+    # @since 2.1.0
+    ID = '$id'.freeze
+
+    # The constant for the database field.
+    #
+    # @since 2.1.0
+    DATABASE = '$db'.freeze
+
+    # @return [ String ] collection The collection name.
+    attr_reader :collection
+
+    # @return [ BSON::ObjectId ] id The referenced document id.
+    attr_reader :id
+
+    # @return [ String ] database The database name.
+    attr_reader :database
+
+    # Get the DBRef as a JSON document
+    #
+    # @example Get the DBRef as a JSON hash.
+    #   dbref.as_json
+    #
+    # @return [ Hash ] The max key as a JSON hash.
+    #
+    # @since 2.1.0
+    def as_json(*args)
+      document = { '$ref' => collection, '$id' => id }
+      document.merge!('$db' => database) if database
+      document
+    end
+
+    # Instantiate a new DBRef.
+    #
+    # @example Create the DBRef.
+    #   Mongo::DBRef.new('users', id, 'database')
+    #
+    # @param [ String ] collection The collection name.
+    # @param [ BSON::ObjectId ] id The object id.
+    # @param [ String ] database The database name.
+    #
+    # @since 2.1.0
+    def initialize(collection, id, database = nil)
+      @collection = collection
+      @id = id
+      @database = database
+    end
+
+    # Converts the DBRef to raw BSON.
+    #
+    # @example Convert the DBRef to raw BSON.
+    #   dbref.to_bson
+    #
+    # @param [ String ] encoded The encoded BSON to append to.
+    #
+    # @return [ String ] The raw BSON.
+    #
+    # @since 2.1.0
+    def to_bson(encoded = ''.force_encoding(BSON::BINARY))
+      as_json.to_bson(encoded)
+    end
+
+    module ClassMethods
+
+      # Deserialize the hash from BSON, converting to a DBRef if appropriate.
+      #
+      # @param [ IO ] bson The bson representing a hash.
+      #
+      # @return [ Hash, DBRef ] The decoded hash or DBRef.
+      #
+      # @see http://bsonspec.org/#/specification
+      #
+      # @since 2.0.0
+      def from_bson(bson)
+        decoded = super
+        if ref = decoded['$ref']
+          decoded = DBRef.new(ref, decoded['$id'], decoded['$db'])
+        end
+        decoded
+      end
+    end
+  end
+
+  ::Hash.send(:extend, DBRef::ClassMethods)
+end