mongo 1.12.5 → 2.0.0

data/lib/mongo/cursor.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2009-2013 MongoDB, Inc.
+# Copyright (C) 2014-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.
@@ -14,729 +14,126 @@
 
 module Mongo
 
-  # A cursor over query results. Returned objects are hashes.
+  # Client-side representation of an iterator over a query result set on
+  # the server.
+  #
+  # A +Cursor+ is not created directly by a user. Rather, +CollectionView+
+  # creates a +Cursor+ in an Enumerable module method.
+  #
+  # @example Get an array of 5 users named Emily.
+  #   users.find({:name => 'Emily'}).limit(5).to_a
+  #
+  # @example Call a block on each user doc.
+  #   users.find.each { |doc| puts doc }
+  #
+  # @note The +Cursor+ API is semipublic.
+  # @api semipublic
   class Cursor
+    extend Forwardable
     include Enumerable
-    include Mongo::Constants
-    include Mongo::Conversions
-    include Mongo::Logging
-    include Mongo::ReadPreference
 
-    attr_reader :collection, :selector, :fields,
-      :order, :hint, :snapshot, :timeout, :transformer,
-      :options, :cursor_id, :show_disk_loc,
-      :comment, :compile_regex, :read, :tag_sets,
-      :acceptable_latency
+    def_delegators :@view, :collection, :limit
+    def_delegators :collection, :client, :database
 
-    # Create a new cursor.
+    # Creates a +Cursor+ object.
     #
-    # Note: cursors are created when executing queries using [Collection#find] and other
-    # similar methods. Application developers shouldn't have to create cursors manually.
+    # @example Instantiate the cursor.
+    #   Mongo::Cursor.new(view, response, server)
     #
-    # @return [Cursor]
-    def initialize(collection, opts={})
-      opts = opts.dup
-      @cursor_id  = opts.delete(:cursor_id)
-      @db         = collection.db
-      @collection = collection
-      @ns         = opts.delete(:ns)
-      @connection = @db.connection
-      @logger     = @connection.logger
-
-      # Query selector
-      @selector   = opts.delete(:selector) || {}
-
-      # Query pre-serialized bson to append
-      @bson    = @selector.delete(:bson)
-
-      # Special operators that form part of $query
-      @order         = opts.delete(:order)
-      @explain       = opts.delete(:explain)
-      @hint          = opts.delete(:hint)
-      @snapshot      = opts.delete(:snapshot)
-      @max_scan      = opts.delete(:max_scan)
-      @return_key    = opts.delete(:return_key)
-      @show_disk_loc = opts.delete(:show_disk_loc)
-      @comment       = opts.delete(:comment)
-      @compile_regex = opts.key?(:compile_regex) ? opts.delete(:compile_regex) : true
-
-      # Wire-protocol settings
-      @fields   = convert_fields_for_query(opts.delete(:fields))
-      @skip     = opts.delete(:skip)     || 0
-      @limit    = opts.delete(:limit)    || 0
-      @tailable = opts.delete(:tailable)
-      @timeout  = opts.key?(:timeout) ? opts.delete(:timeout) : true
-      @options  = 0
-
-      # Use this socket for the query
-      @socket = opts.delete(:socket)
-      @pool   = opts.delete(:pool)
-
-      @closed    = false
-      @query_run = false
-
-      @transformer        = opts.delete(:transformer)
-      @read               = opts.delete(:read)               || @collection.read
-      Mongo::ReadPreference::validate(@read)
-      @tag_sets           = opts.delete(:tag_sets)           || @collection.tag_sets
-      @acceptable_latency = opts.delete(:acceptable_latency) || @collection.acceptable_latency
-
-      batch_size(opts.delete(:batch_size) || 0)
-
-      @cache                = opts.delete(:first_batch) || []
-      @returned             = 0
-
-      if(!@timeout)
-        add_option(OP_QUERY_NO_CURSOR_TIMEOUT)
-      end
-      if(@read != :primary)
-        add_option(OP_QUERY_SLAVE_OK)
-      end
-      if(@tailable)
-        add_option(OP_QUERY_TAILABLE)
-      end
-
-      # If a cursor_id is provided, this is a cursor for a command
-      if @cursor_id
-        @command_cursor = true
-        @query_run      = true
-      end
-
-      if @collection.name =~ /^\$cmd/ || @collection.name =~ /^system/
-        @command = true
-      else
-        @command = false
-      end
-
-      @opts = opts
-    end
-
-    # Guess whether the cursor is alive on the server.
+    # @param [ CollectionView ] view The +CollectionView+ defining the query.
+    # @param [ Operation::Result ] result The result of the first execution.
+    # @param [ Server ] server The server this cursor is locked to.
     #
-    # Note that this method only checks whether we have
-    # a cursor id. The cursor may still have timed out
-    # on the server. This will be indicated in the next
-    # call to Cursor#next.
-    #
-    # @return [Boolean]
-    def alive?
-      @cursor_id && @cursor_id != 0
+    # @since 2.0.0
+    def initialize(view, result, server)
+      @view = view
+      @server = server
+      @initial_result = result
+      @remaining = limit if limited?
     end
 
-    def full_collection_name
-      @ns || "#{@collection.db.name}.#{@collection.name}"
-    end
-
-    # Get the next document specified the cursor options.
+    # Get a human-readable string representation of +Cursor+.
     #
-    # @return [Hash, Nil] the next document or Nil if no documents remain.
-    def next
-      if @cache.length == 0
-        if @query_run && exhaust?
-          close
-          return nil
-        else
-          refresh
-        end
-      end
-      doc = @cache.shift
-
-      if doc && (err = doc['errmsg'] || doc['$err']) # assignment
-        code = doc['code'] || doc['assertionCode']
-
-        # If the server has stopped being the master (e.g., it's one of a
-        # pair but it has died or something like that) then we close that
-        # connection. The next request will re-open on master server.
-        if err.include?("not master")
-          @connection.close
-          raise ConnectionFailure.new(err, code, doc)
-        end
-
-        # Handle server side operation execution timeout
-        if code == 50
-          raise ExecutionTimeout.new(err, code, doc)
-        end
-
-        raise OperationFailure.new(err, code, doc)
-      elsif doc && (write_concern_error = doc['writeConcernError']) # assignment
-        raise WriteConcernError.new(write_concern_error['errmsg'], write_concern_error['code'], doc)
-      end
-
-      if @transformer.nil?
-        doc
-      else
-        @transformer.call(doc) if doc
-      end
-    end
-    alias :next_document :next
-
-    # Reset this cursor on the server. Cursor options, such as the
-    # query string and the values for skip and limit, are preserved.
-    def rewind!
-      check_command_cursor
-      close
-      @cache.clear
-      @cursor_id  = nil
-      @closed     = false
-      @query_run  = false
-      @n_received = nil
-      true
-    end
-
-    # Determine whether this cursor has any remaining results.
-    #
-    # @return [Boolean]
-    def has_next?
-      num_remaining > 0
-    end
-
-    # Get the size of the result set for this query.
+    # @example Inspect the cursor.
+    #   cursor.inspect
     #
-    # @param [Boolean] skip_and_limit whether or not to take skip or limit into account.
+    # @return [ String ] A string representation of a +Cursor+ instance.
     #
-    # @return [Integer] the number of objects in the result set for this query.
-    #
-    # @raise [OperationFailure] on a database error.
-    def count(skip_and_limit = false)
-      check_command_cursor
-      command = BSON::OrderedHash["count",  @collection.name, "query",  @selector]
-
-      if skip_and_limit
-        command.merge!(BSON::OrderedHash["limit", @limit]) if @limit != 0
-        command.merge!(BSON::OrderedHash["skip", @skip]) if @skip != 0
-      end
-
-      if @hint
-        hint = @hint.is_a?(String) ? @hint : generate_index_name(@hint)
-      end
-
-      command.merge!(BSON::OrderedHash["fields", @fields])
-      command.merge!(BSON::OrderedHash["hint", hint]) if hint
-
-      response = @db.command(command, :read => @read, :comment => @comment)
-      return response['n'].to_i if Mongo::Support.ok?(response)
-      return 0 if response['errmsg'] == "ns missing"
-      raise OperationFailure.new("Count failed: #{response['errmsg']}", response['code'], response)
-    end
-
-    # Sort this cursor's results.
-    #
-    # This method overrides any sort order specified in the Collection#find
-    # method, and only the last sort applied has an effect.
-    #
-    # @param [Symbol, Array, Hash, OrderedHash] order either 1) a key to sort by 2)
-    #   an array of [key, direction] pairs to sort by or 3) a hash of
-    #   field => direction pairs to sort by. Direction should be specified as
-    #   Mongo::ASCENDING (or :ascending / :asc) or Mongo::DESCENDING
-    #   (or :descending / :desc)
-    #
-    # @raise [InvalidOperation] if this cursor has already been used.
-    #
-    # @raise [InvalidSortValueError] if the specified order is invalid.
-    def sort(order, direction=nil)
-      check_modifiable
-      order = [[order, direction]] unless direction.nil?
-      @order = order
-      self
-    end
-
-    # Limit the number of results to be returned by this cursor.
-    #
-    # This method overrides any limit specified in the Collection#find method,
-    # and only the last limit applied has an effect.
-    #
-    # @return [Integer] the current number_to_return if no parameter is given.
-    #
-    # @raise [InvalidOperation] if this cursor has already been used.
-    def limit(number_to_return=nil)
-      return @limit unless number_to_return
-      check_modifiable
-
-      if (number_to_return != 0) && exhaust?
-        raise MongoArgumentError, "Limit is incompatible with exhaust option."
-      end
-
-      @limit = number_to_return
-      self
-    end
-
-    # Skips the first +number_to_skip+ results of this cursor.
-    # Returns the current number_to_skip if no parameter is given.
-    #
-    # This method overrides any skip specified in the Collection#find method,
-    # and only the last skip applied has an effect.
-    #
-    # @return [Integer]
-    #
-    # @raise [InvalidOperation] if this cursor has already been used.
-    def skip(number_to_skip=nil)
-      return @skip unless number_to_skip
-      check_modifiable
-
-      @skip = number_to_skip
-      self
-    end
-
-    # Instruct the server to abort queries after they exceed the specified
-    # wall-clock execution time.
-    #
-    # A query that completes in under its time limit will "roll over"
-    # remaining time to the first getmore op (which will then "roll over"
-    # its remaining time to the second getmore op and so on, until the
-    # time limit is hit).
-    #
-    # Cursors returned by successful time-limited queries will still obey
-    # the default cursor idle timeout (unless the "no cursor idle timeout"
-    # flag has been set).
-    #
-    # @note This will only have an effect in MongoDB 2.5+
-    #
-    # @param max_time_ms [Fixnum] max execution time (in milliseconds)
-    #
-    # @return [Fixnum, Cursor] either the current max_time_ms or cursor
-    def max_time_ms(max_time_ms=nil)
-      return @max_time_ms unless max_time_ms
-      check_modifiable
-
-      @max_time_ms = max_time_ms
-      self
-    end
-
-    # Set the batch size for server responses.
-    #
-    # Note that the batch size will take effect only on queries
-    # where the number to be returned is greater than 100.
-    #
-    # This can not override MongoDB's limit on the amount of data it will
-    # return to the client. Depending on server version this can be 4-16mb.
-    #
-    # @param [Integer] size either 0 or some integer greater than 1. If 0,
-    #   the server will determine the batch size.
-    #
-    # @return [Cursor]
-    def batch_size(size=nil)
-      return @batch_size unless size
-      check_modifiable
-      if size < 0 || size == 1
-        raise ArgumentError, "Invalid value for batch_size #{size}; must be 0 or > 1."
-      else
-        @batch_size = @limit != 0 && size > @limit ? @limit : size
-      end
-
-      self
+    # @since 2.0.0
+    def inspect
+      "#<Mongo::Cursor:0x#{object_id} @view=#{@view.inspect}>"
     end
 
-    # Iterate over each document in this cursor, yielding it to the given
-    # block, if provided. An Enumerator is returned if no block is given.
-    #
-    # Iterating over an entire cursor will close it.
+    # Iterate through documents returned from the query.
     #
-    # @yield passes each document to a block for processing.
-    #
-    # @example if 'comments' represents a collection of comments:
-    #   comments.find.each do |doc|
-    #     puts doc['user']
+    # @example Iterate over the documents in the cursor.
+    #   cursor.each do |doc|
+    #     ...
     #   end
-    def each
-      if block_given? || !defined?(Enumerator)
-        while doc = self.next
-          yield doc
-        end
-      else
-        Enumerator.new do |yielder|
-          while doc = self.next
-            yielder.yield doc
-          end
-        end
-      end
-    end
-    # Receive all the documents from this cursor as an array of hashes.
-    #
-    # Notes:
-    #
-    # If you've already started iterating over the cursor, the array returned
-    # by this method contains only the remaining documents. See Cursor#rewind! if you
-    # need to reset the cursor.
-    #
-    # Use of this method is discouraged - in most cases, it's much more
-    # efficient to retrieve documents as you need them by iterating over the cursor.
-    #
-    # @return [Array] an array of documents.
-    def to_a
-      super
-    end
-
-    # Get the explain plan for this cursor.
-    #
-    # @return [Hash] a document containing the explain plan for this cursor.
-    def explain
-      check_command_cursor
-      c = Cursor.new(@collection,
-        query_options_hash.merge(:limit => -@limit.abs, :explain => true))
-      explanation = c.next_document
-      c.close
-
-      explanation
-    end
-
-    # Close the cursor.
-    #
-    # Note: if a cursor is read until exhausted (read until Mongo::Constants::OP_QUERY or
-    # Mongo::Constants::OP_GETMORE returns zero for the cursor id), there is no need to
-    # close it manually.
-    #
-    # Note also: Collection#find takes an optional block argument which can be used to
-    # ensure that your cursors get closed.
     #
-    # @return [True]
-    def close
-      if @cursor_id && @cursor_id != 0
-        message = BSON::ByteBuffer.new([0, 0, 0, 0])
-        message.put_int(1)
-        message.put_long(@cursor_id)
-        log(:debug, "Cursor#close #{@cursor_id}")
-        @connection.send_message(
-          Mongo::Constants::OP_KILL_CURSORS,
-          message,
-          :pool => @pool
-        )
-      end
-      @cursor_id = 0
-      @closed    = true
-    end
-
-    # Is this cursor closed?
+    # @return [ Enumerator ] The enumerator.
     #
-    # @return [Boolean]
-    def closed?
-      @closed
-    end
-
-    # Returns an integer indicating which query options have been selected.
-    #
-    # @return [Integer]
-    #
-    # @see http://www.mongodb.org/display/DOCS/Mongo+Wire+Protocol#MongoWireProtocol-Mongo::Constants::OPQUERY
-    # The MongoDB wire protocol.
-    def query_opts
-      warn "The method Cursor#query_opts has been deprecated " +
-        "and will removed in v2.0. Use Cursor#options instead."
-      @options
-    end
-
-    # Add an option to the query options bitfield.
-    #
-    # @param opt a valid query option
-    #
-    # @raise InvalidOperation if this method is run after the cursor has bee
-    #   iterated for the first time.
-    #
-    # @return [Integer] the current value of the options bitfield for this cursor.
-    #
-    # @see http://www.mongodb.org/display/DOCS/Mongo+Wire+Protocol#MongoWireProtocol-Mongo::Constants::OPQUERY
-    def add_option(opt)
-      check_modifiable
-
-      if exhaust?(opt)
-        if @limit != 0
-          raise MongoArgumentError, "Exhaust is incompatible with limit."
-        elsif @connection.mongos?
-          raise MongoArgumentError, "Exhaust is incompatible with mongos."
-        end
+    # @since 2.0.0
+    def each
+      process(@initial_result).each { |doc| yield doc }
+      while more?
+        return kill_cursors if exhausted?
+        get_more.each { |doc| yield doc }
       end
-
-      @options |= opt
-      @options
-    end
-
-    # Remove an option from the query options bitfield.
-    #
-    # @param opt a valid query option
-    #
-    # @raise InvalidOperation if this method is run after the cursor has bee
-    #   iterated for the first time.
-    #
-    # @return [Integer] the current value of the options bitfield for this cursor.
-    #
-    # @see http://www.mongodb.org/display/DOCS/Mongo+Wire+Protocol#MongoWireProtocol-Mongo::Constants::OPQUERY
-    def remove_option(opt)
-      check_modifiable
-
-      @options &= ~opt
-      @options
-    end
-
-    # Get the query options for this Cursor.
-    #
-    # @return [Hash]
-    def query_options_hash
-      BSON::OrderedHash[
-        :selector => @selector,
-        :fields   => @fields,
-        :skip     => @skip,
-        :limit    => @limit,
-        :order    => @order,
-        :hint     => @hint,
-        :snapshot => @snapshot,
-        :timeout  => @timeout,
-        :max_scan => @max_scan,
-        :return_key => @return_key,
-        :show_disk_loc => @show_disk_loc,
-        :comment  => @comment ]
-    end
-
-    # Clean output for inspect.
-    def inspect
-      "<Mongo::Cursor:0x#{object_id.to_s(16)} namespace='#{full_collection_name}' " +
-        "@selector=#{@selector.inspect} @cursor_id=#{@cursor_id}>"
     end
 
     private
 
-    # Convert the +:fields+ parameter from a single field name or an array
-    # of fields names to a hash, with the field names for keys and '1' for each
-    # value.
-    def convert_fields_for_query(fields)
-      case fields
-        when String, Symbol
-          {fields => 1}
-        when Array
-          return nil if fields.length.zero?
-          fields.inject({}) do |hash, field|
-            field.is_a?(Hash) ? hash.merge!(field) : hash[field] = 1
-            hash
-          end
-        when Hash
-          return fields
-      end
-    end
-
-    # Return the number of documents remaining for this cursor.
-    def num_remaining
-      if @cache.length == 0
-        if @query_run && exhaust?
-          close
-          return 0
-        else
-          refresh
-        end
-      end
-
-      @cache.length
-    end
-
-    # Refresh the documents in @cache. This means either
-    # sending the initial query or sending a GET_MORE operation.
-    def refresh
-      if !@query_run
-        send_initial_query
-      elsif !@cursor_id.zero?
-        send_get_more
-      end
-    end
-
-    # Sends initial query -- which is always a read unless it is a command
-    #
-    # Upon ConnectionFailure, tries query 3 times if socket was not provided
-    # and the query is either not a command or is a secondary_ok command.
-    #
-    # Pins pools upon successful read and unpins pool upon ConnectionFailure
-    #
-    def send_initial_query
-      tries = 0
-      instrument(:find, instrument_payload) do
-        begin
-          message = construct_query_message
-          socket = @socket || checkout_socket_from_connection
-          results, @n_received, @cursor_id = @connection.receive_message(
-            Mongo::Constants::OP_QUERY, message, nil, socket, @command,
-            nil, exhaust?, compile_regex?)
-        rescue ConnectionFailure => ex
-          socket.close if socket
-          @pool = nil
-          @connection.unpin_pool
-          @connection.refresh
-          if tries < 3 && !@socket && (!@command || Mongo::ReadPreference::secondary_ok?(@selector))
-            tries += 1
-            retry
-          else
-            raise ex
-          end
-        rescue OperationFailure, OperationTimeout => ex
-          raise ex
-        ensure
-          socket.checkin unless @socket || socket.nil?
-        end
-
-        if pin_pool?(results.first)
-          @connection.pin_pool(socket.pool, read_preference)
-        end
-
-        @returned += @n_received
-        @cache += results
-        @query_run = true
-        close_cursor_if_query_complete
-      end
-    end
-
-    def send_get_more
-      message = BSON::ByteBuffer.new([0, 0, 0, 0])
-
-      # DB name.
-      BSON::BSON_RUBY.serialize_cstr(message, full_collection_name)
-
-      # Number of results to return.
-      if @limit > 0
-        limit = @limit - @returned
-        if @batch_size > 0
-          limit = limit < @batch_size ? limit : @batch_size
-        end
-        message.put_int(limit)
-      else
-        message.put_int(@batch_size)
-      end
-
-      # Cursor id.
-      message.put_long(@cursor_id)
-      log(:debug, "cursor.refresh() for cursor #{@cursor_id}") if @logger
-
-      socket = @pool.checkout
-
-      begin
-        results, @n_received, @cursor_id = @connection.receive_message(
-          Mongo::Constants::OP_GET_MORE, message, nil, socket, @command,
-          nil, exhaust?, compile_regex?)
-      ensure
-        socket.checkin
-      end
-
-      @returned += @n_received
-      @cache += results
-      close_cursor_if_query_complete
+    def batch_size
+      @view.batch_size && @view.batch_size > 0 ? @view.batch_size : limit
     end
 
-    def checkout_socket_from_connection
-      begin
-        if @pool
-          socket = @pool.checkout
-        elsif @command && !Mongo::ReadPreference::secondary_ok?(@selector)
-          socket = @connection.checkout_reader({:mode => :primary})
-        else
-          socket = @connection.checkout_reader(read_preference)
-        end
-      rescue SystemStackError, NoMemoryError, SystemCallError => ex
-        @connection.close
-        raise ex
-      end
-      @pool = socket.pool
-      socket
+    def exhausted?
+      limited? ? @remaining <= 0 : false
     end
 
-    def checkin_socket(sock)
-      @connection.checkin(sock)
+    def get_more
+      process(get_more_operation.execute(@server.context))
     end
 
-    def construct_query_message
-      message = BSON::ByteBuffer.new("", @connection.max_bson_size + MongoClient::COMMAND_HEADROOM)
-      message.put_int(@options)
-      BSON::BSON_RUBY.serialize_cstr(message, full_collection_name)
-      message.put_int(@skip)
-      @batch_size > 1 ? message.put_int(@batch_size) : message.put_int(@limit)
-      if query_contains_special_fields? && @bson # costs two serialize calls
-        query_message = BSON::BSON_CODER.serialize(@selector, false, false, @connection.max_bson_size + MongoClient::APPEND_HEADROOM)
-        query_message.grow(@bson)
-        query_spec = construct_query_spec
-        query_spec.delete('$query')
-        query_message.grow(BSON::BSON_CODER.serialize(query_spec, false, false, @connection.max_bson_size))
-      else # costs only one serialize call
-        spec = query_contains_special_fields? ? construct_query_spec : @selector
-        spec.merge!(@opts)
-        query_message = BSON::BSON_CODER.serialize(spec, false, false, @connection.max_bson_size + MongoClient::APPEND_HEADROOM)
-        query_message.grow(@bson) if @bson
-      end
-      message.put_binary(query_message.to_s)
-      message.put_binary(BSON::BSON_CODER.serialize(@fields, false, false, @connection.max_bson_size).to_s) if @fields
-      message
+    def get_more_operation
+      Operation::Read::GetMore.new({
+        :to_return => to_return,
+        :cursor_id => @cursor_id,
+        :db_name   => database.name,
+        :coll_name => @coll_name || collection.name
+      })
     end
 
-    def instrument_payload
-      log = { :database => @db.name, :collection => @collection.name, :selector => selector }
-      log[:fields] = @fields if @fields
-      log[:skip]   = @skip   if @skip && (@skip != 0)
-      log[:limit]  = @limit  if @limit && (@limit != 0)
-      log[:order]  = @order  if @order
-      log
+    def kill_cursors
+      kill_cursors_operation.execute(@server.context)
     end
 
-    def construct_query_spec
-      return @selector if @selector.has_key?('$query')
-      spec = BSON::OrderedHash.new
-      spec['$query']    = @selector
-      spec['$orderby']  = Mongo::Support.format_order_clause(@order) if @order
-      spec['$hint']     = @hint if @hint && @hint.length > 0
-      spec['$explain']  = true if @explain
-      spec['$snapshot'] = true if @snapshot
-      spec['$maxScan']  = @max_scan if @max_scan
-      spec['$returnKey']   = true if @return_key
-      spec['$showDiskLoc'] = true if @show_disk_loc
-      spec['$comment']  = @comment if @comment
-      spec['$maxTimeMS'] = @max_time_ms if @max_time_ms
-      if needs_read_pref?
-        read_pref = Mongo::ReadPreference::mongos(@read, @tag_sets)
-        spec['$readPreference'] = read_pref if read_pref
-      end
-      spec
+    def kill_cursors_operation
+      Operation::KillCursors.new({ :cursor_ids => [ @cursor_id ]})
     end
 
-    def needs_read_pref?
-      @connection.mongos? && @read != :primary
+    def limited?
+      limit ? limit > 0 : false
     end
 
-    def query_contains_special_fields?
-      @order || @explain || @hint || @snapshot || @show_disk_loc ||
-        @max_scan || @return_key || @comment || @max_time_ms || needs_read_pref?
+    def more?
+      @cursor_id != 0
     end
 
-    def close_cursor_if_query_complete
-      if @limit > 0 && @returned >= @limit
-        close
-      end
+    def process(result)
+      @remaining -= result.returned_count if limited?
+      @cursor_id = result.cursor_id
+      @coll_name ||= result.namespace.sub("#{database.name}.", '') if result.namespace
+      result.documents
     end
 
-    # Check whether the exhaust option is set
-    #
-    # @return [true, false] The state of the exhaust flag.
-    def exhaust?(opts = options)
-      !(opts & OP_QUERY_EXHAUST).zero?
-    end
-
-    def check_modifiable
-      if @query_run || @closed
-        raise InvalidOperation, "Cannot modify the query once it has been run or closed."
-      end
-    end
-
-    def check_command_cursor
-      if @command_cursor
-        raise InvalidOperation, "Cannot call #{caller.first} on command cursors"
-      end
-    end
-
-    def compile_regex?
-      @compile_regex
-    end
-
-    def generate_index_name(spec)
-      indexes = []
-      spec.each_pair do |field, type|
-        indexes.push("#{field}_#{type}")
-      end
-      indexes.join("_")
+    def to_return
+      use_limit? ? @remaining : (batch_size || 0)
     end
 
-    def pin_pool?(response)
-      ( response && (response['cursor'] || response['cursors']) ) ||
-        ( !@socket && !@command )
+    def use_limit?
+      limited? && batch_size >= @remaining
     end
   end
 end