mongo 2.1.2 → 2.2.0.rc0

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

@@ -0,0 +1,83 @@
+# 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
+  class Collection
+    class View
+      module Builder
+
+        # Builds a legacy OP_QUERY specification from options.
+        #
+        # @since 2.2.0
+        class OpQuery
+          extend Forwardable
+
+          def_delegators :@view, :cluster, :collection, :database, :filter, :options, :read
+
+          # @return [ BSON::Document ] modifiers The server modifiers.
+          attr_reader :modifiers
+
+          # Create the new legacy query builder.
+          #
+          # @example Create the query builder.
+          #   QueryBuilder.new(view)
+          #
+          # @param [ Collection::View ] view The collection view.
+          #
+          # @since 2.2.2
+          def initialize(view)
+            @view = view
+            @modifiers = Modifiers.map_server_modifiers(options)
+          end
+
+          def specification
+            {
+              :selector  => requires_special_filter? ? special_filter : filter,
+              :read      => read,
+              :options   => query_options,
+              :db_name   => database.name,
+              :coll_name => collection.name
+            }
+          end
+
+          private
+
+          def query_options
+            BSON::Document.new(
+              project: options[:projection],
+              skip: options[:skip],
+              limit: options[:limit],
+              flags: Flags.map_flags(options),
+              batch_size: options[:batch_size]
+            )
+          end
+
+          def requires_special_filter?
+            !modifiers.empty? || cluster.sharded?
+          end
+
+          def read_pref_formatted
+            @read_formatted ||= read.to_mongos
+          end
+
+          def special_filter
+            sel = BSON::Document.new(:$query => filter).merge!(modifiers)
+            sel[:$readPreference] = read_pref_formatted unless read_pref_formatted.nil?
+            sel
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -21,6 +21,21 @@ module Mongo
       # @since 2.0.0
       module Explainable
 
+        # The query planner verbosity constant.
+        #
+        # @since 2.2.0
+        QUERY_PLANNER = 'queryPlanner'.freeze
+
+        # The execution stats verbosity constant.
+        #
+        # @since 2.2.0
+        EXECUTION_STATS = 'executionStats'.freeze
+
+        # The all plans execution verbosity constant.
+        #
+        # @since 2.2.0
+        ALL_PLANS_EXECUTION = 'allPlansExecution'.freeze
+
         # Get the explain plan for the query.
         #
         # @example Get the explain plan for the query.

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

@@ -15,6 +15,10 @@
 module Mongo
   class Collection
     class View
+
+      # Defines behaviour around views being configurable and immutable.
+      #
+      # @since 2.0.0
       module Immutable
 
         # @return [ Hash ] options The additional query options.
@@ -24,18 +28,7 @@ module Mongo
 
         def configure(field, value)
           return options[field] if value.nil?
-          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)
-          new(options.dup).tap do |view|
-            view.send(:flags).push(flag)
-          end
+          new(options.merge(field => value))
         end
       end
     end

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

@@ -37,7 +37,7 @@ module Mongo
         def each
           @cursor = nil
           read_with_retry do
-            server = read.select_server(cluster)
+            server = read.select_server(cluster, false)
             result = send_initial_query(server)
             @cursor = Cursor.new(view, result, server)
           end
@@ -54,7 +54,29 @@ module Mongo
         #
         # @since 2.1.0
         def close_query
-          @cursor.send(:kill_cursors) if @cursor
+          @cursor.send(:kill_cursors) if @cursor && !@cursor.closed?
+        end
+
+        private
+
+        def initial_query_op(server)
+          if server.features.find_command_enabled?
+            initial_command_op
+          else
+            Operation::Read::Query.new(Builder::OpQuery.new(self).specification)
+          end
+        end
+
+        def initial_command_op
+          if explained?
+            Operation::Commands::Command.new(Builder::FindCommand.new(self).explain_specification)
+          else
+            Operation::Commands::Find.new(Builder::FindCommand.new(self).specification)
+          end
+        end
+
+        def send_initial_query(server)
+          initial_query_op(server).execute(server.context)
         end
       end
     end

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

@@ -67,7 +67,7 @@ module Mongo
         def each
           @cursor = nil
           write_with_retry do
-            server = read.select_server(cluster)
+            server = read.select_server(cluster, false)
             result = send_initial_query(server)
             @cursor = Cursor.new(view, result, server)
           end
@@ -107,7 +107,7 @@ module Mongo
           @view = view
           @map = map.freeze
           @reduce = reduce.freeze
-          @options = options.dup
+          @options = options.freeze
         end
 
         # Set or get the jsMode flag for the operation.
@@ -122,7 +122,7 @@ module Mongo
         #
         # @since 2.0.0
         def js_mode(value = nil)
-          configure(:jsMode, value)
+          configure(:js_mode, value)
         end
 
         # Set or get the output location for the operation.
@@ -187,21 +187,7 @@ module Mongo
         end
 
         def map_reduce_spec
-          {
-            :db_name => database.name,
-            :read => read,
-            :selector => {
-              :mapreduce => collection.name,
-              :map => map,
-              :reduce => reduce,
-              :query => view.modifiers[:$query] || view.selector,
-              :out => { inline: 1 }
-            }.merge(options).merge(view_options)
-          }
-        end
-
-        def view_options
-          view.sort ? view.options.merge(:sort => view.sort) : view.options
+          Builder::MapReduce.new(map, reduce, view, options).specification
         end
 
         def new(options)
@@ -209,7 +195,7 @@ module Mongo
         end
 
         def initial_query_op
-          Operation::MapReduce.new(map_reduce_spec)
+          Operation::Commands::MapReduce.new(map_reduce_spec)
         end
 
         def valid_server?(server)
@@ -223,25 +209,30 @@ module Mongo
         def send_initial_query(server)
           unless valid_server?(server)
             log_warn(REROUTE)
-            server = cluster.next_primary
+            server = cluster.next_primary(false)
           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.respond_to?(:keys) ? out.values.first : out }
+          Builder::MapReduce.new(map, reduce, view, options).query_specification
         end
 
-        def fetch_query_op
-          Operation::Read::Query.new(fetch_query_spec)
+        def find_command_spec
+          Builder::MapReduce.new(map, reduce, view, options).command_specification
+        end
+
+        def fetch_query_op(server)
+          if server.features.find_command_enabled?
+            Operation::Commands::Find.new(find_command_spec)
+          else
+            Operation::Read::Query.new(fetch_query_spec)
+          end
         end
 
         def send_fetch_query(server)
-          fetch_query_op.execute(server.context)
+          fetch_query_op(server).execute(server.context)
         end
       end
     end

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

@@ -21,33 +21,15 @@ module Mongo
       # @since 2.0.0
       module Readable
 
-        # Special fields and their option names for the query selector.
+        # The query modifier constant.
         #
-        # @since 2.0.0
-        SPECIAL_FIELDS = {
-          :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.2.0
+        QUERY = '$query'.freeze
+
+        # The modifiers option constant.
         #
-        # @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
+        # @since 2.2.0
+        MODIFIERS = 'modifiers'.freeze
 
         # Execute an aggregation on the collection view.
         #
@@ -75,7 +57,19 @@ module Mongo
         #
         # @since 2.0.0
         def allow_partial_results
-          configure_flag(:partial)
+          configure(:allow_partial_results, true)
+        end
+
+        # Tell the query's cursor to stay open and wait for data.
+        #
+        # @example Await data on the cursor.
+        #   view.await_data
+        #
+        # @return [ View ] The new view.
+        #
+        # @since 2.0.0
+        def await_data
+          configure(:await_data, true)
         end
 
         # The number of documents returned in each batch of results from MongoDB.
@@ -110,7 +104,7 @@ module Mongo
         #
         # @since 2.0.0
         def comment(comment = nil)
-          configure_modifier(:comment, comment)
+          configure(:comment, comment)
         end
 
         # Get a count of matching documents in the collection.
@@ -132,11 +126,12 @@ module Mongo
         #
         # @since 2.0.0
         def count(options = {})
-          cmd = { :count => collection.name, :query => selector }
+          cmd = { :count => collection.name, :query => filter }
           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]
+          cmd[:readConcern] = collection.read_concern if collection.read_concern
           read_with_retry do
             database.command(cmd, options).n.to_i
           end
@@ -160,8 +155,9 @@ module Mongo
         def distinct(field_name, options={})
           cmd = { :distinct => collection.name,
                   :key => field_name.to_s,
-                  :query => selector }
+                  :query => filter }
           cmd[:maxTimeMS] = options[:max_time_ms] if options[:max_time_ms]
+          cmd[:readConcern] = collection.read_concern if collection.read_concern
           read_with_retry do
             database.command(cmd, options).first['values']
           end
@@ -178,7 +174,7 @@ module Mongo
         #
         # @since 2.0.0
         def hint(hint = nil)
-          configure_modifier(:hint, hint)
+          configure(:hint, hint)
         end
 
         # The max number of docs to return from the query.
@@ -222,7 +218,7 @@ module Mongo
         #
         # @since 2.0.0
         def max_scan(value = nil)
-          configure_modifier(:max_scan, value)
+          configure(:max_scan, value)
         end
 
         # Set the maximum value to search.
@@ -236,7 +232,7 @@ module Mongo
         #
         # @since 2.1.0
         def max_value(value = nil)
-          configure_modifier(:max_value, value)
+          configure(:max_value, value)
         end
 
         # Set the minimum value to search.
@@ -250,7 +246,7 @@ module Mongo
         #
         # @since 2.1.0
         def min_value(value = nil)
-          configure_modifier(:min_value, value)
+          configure(:min_value, value)
         end
 
         # The server normally times out idle cursors after an inactivity period
@@ -263,7 +259,7 @@ module Mongo
         #
         # @since 2.0.0
         def no_cursor_timeout
-          configure_flag(:no_cursor_timeout)
+          configure(:no_cursor_timeout, true)
         end
 
         # The fields to include or exclude from each doc in the result set.
@@ -313,7 +309,7 @@ module Mongo
         #
         # @since 2.1.0
         def return_key(value = nil)
-          configure_modifier(:return_key, value)
+          configure(:return_key, value)
         end
 
         # Set whether the disk location should be shown for each document.
@@ -328,8 +324,9 @@ module Mongo
         #
         # @since 2.0.0
         def show_disk_loc(value = nil)
-          configure_modifier(:show_disk_loc, value)
+          configure(:show_disk_loc, value)
         end
+        alias :show_record_id :show_disk_loc
 
         # The number of docs to skip before returning results.
         #
@@ -358,7 +355,7 @@ module Mongo
         #
         # @since 2.0.0
         def snapshot(value = nil)
-          configure_modifier(:snapshot, value)
+          configure(:snapshot, value)
         end
 
         # The key and direction pairs by which the result set will be sorted.
@@ -373,7 +370,7 @@ module Mongo
         #
         # @since 2.0.0
         def sort(spec = nil)
-          configure_modifier(:sort, spec)
+          configure(:sort, spec)
         end
 
         # “meta” operators that let you modify the output or behavior of a query.
@@ -387,8 +384,23 @@ module Mongo
         #
         # @since 2.1.0
         def modifiers(doc = nil)
-          return @modifiers if doc.nil?
-          new(options.merge(:modifiers => doc))
+          return Builder::Modifiers.map_server_modifiers(options) if doc.nil?
+          new(options.merge(Builder::Modifiers.map_driver_options(doc)))
+        end
+
+        # A cumulative time limit in milliseconds for processing get more operations
+        # on a cursor.
+        #
+        # @example Set the max await time ms value.
+        #   view.max_await_time_ms(500)
+        #
+        # @param [ Integer ] max The max time in milliseconds.
+        #
+        # @return [ Integer, View ] Either the max await time ms value or a new +View+.
+        #
+        # @since 2.1.0
+        def max_await_time_ms(max = nil)
+          configure(:max_await_time_ms, max)
         end
 
         # A cumulative time limit in milliseconds for processing operations on a cursor.
@@ -402,7 +414,7 @@ module Mongo
         #
         # @since 2.1.0
         def max_time_ms(max = nil)
-          configure_modifier(:max_time_ms, max)
+          configure(:max_time_ms, max)
         end
 
         private
@@ -411,85 +423,31 @@ module Mongo
           options[:read] || read_preference
         end
 
-        def flags
-          @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 parallel_scan(cursor_count)
-          server = read.select_server(cluster)
-          Operation::ParallelScan.new(
+          server = read.select_server(cluster, false)
+          Operation::Commands::ParallelScan.new(
             :coll_name => collection.name,
             :db_name => database.name,
-            :cursor_count => cursor_count
+            :cursor_count => cursor_count,
+            :read_concern => collection.read_concern
           ).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)
+            result = if server.features.find_command_enabled?
+              Operation::Commands::GetMore.new({
+                  :selector => { :getMore => cursor_id, :collection => collection.name },
+                  :db_name  => database.name
+                }).execute(server.context)
+            else
+              Operation::Read::GetMore.new({
+                  :to_return => 0,
+                  :cursor_id => cursor_id,
+                  :db_name   => database.name,
+                  :coll_name => collection.name
+                }).execute(server.context)
+            end
             Cursor.new(self, result, server)
           end
         end
 
-        def setup(sel, opts)
-          setup_options(opts)
-          setup_selector(sel)
-        end
-
-        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 => limit,
-            :flags => flags,
-            :batch_size => batch_size
-          }
-        end
-
-        def requires_special_selector?
-          !modifiers.empty? || cluster.sharded?
-        end
-
-        def query_spec
-          sel = requires_special_selector? ? special_selector : selector
-          { :selector  => sel,
-            :read      => read,
-            :options   => query_options,
-            :db_name   => database.name,
-            :coll_name => collection.name }
-        end
-
-        def read_pref_formatted
-          @read_formatted ||= read.to_mongos
-        end
-
-        def special_selector
-          sel = BSON::Document.new(:$query => selector).merge!(modifiers)
-          sel[:$readPreference] = read_pref_formatted unless read_pref_formatted.nil?
-          sel
-        end
-
         def validate_doc!(doc)
           raise Error::InvalidDocument.new unless doc.respond_to?(:keys)
         end