mongo 1.3.0 → 1.12.5

data/lib/mongo/cursor.rb

@@ -1,12 +1,10 @@
-# encoding: UTF-8
-
-# Copyright (C) 2008-2011 10gen Inc.
+# Copyright (C) 2009-2013 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
+#   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,
@@ -18,12 +16,17 @@ module Mongo
 
   # A cursor over query results. Returned objects are hashes.
   class Cursor
-    include Mongo::Conversions
     include Enumerable
+    include Mongo::Constants
+    include Mongo::Conversions
+    include Mongo::Logging
+    include Mongo::ReadPreference
 
     attr_reader :collection, :selector, :fields,
-      :order, :hint, :snapshot, :timeout,
-      :full_collection_name, :transformer
+      :order, :hint, :snapshot, :timeout, :transformer,
+      :options, :cursor_id, :show_disk_loc,
+      :comment, :compile_regex, :read, :tag_sets,
+      :acceptable_latency
 
     # Create a new cursor.
     #
@@ -31,62 +34,132 @@ module Mongo
     # similar methods. Application developers shouldn't have to create cursors manually.
     #
     # @return [Cursor]
-    #
-    # @core cursors constructor_details
     def initialize(collection, opts={})
-      @cursor_id  = nil
-
+      opts = opts.dup
+      @cursor_id  = opts.delete(:cursor_id)
       @db         = collection.db
       @collection = collection
+      @ns         = opts.delete(:ns)
       @connection = @db.connection
       @logger     = @connection.logger
 
-      @selector   = opts[:selector] || {}
-      @fields     = convert_fields_for_query(opts[:fields])
-      @skip       = opts[:skip]     || 0
-      @limit      = opts[:limit]    || 0
-      @order      = opts[:order]
-      @hint       = opts[:hint]
-      @snapshot   = opts[:snapshot]
-      @timeout    = opts.fetch(:timeout, true)
-      @explain    = opts[:explain]
-      @socket     = opts[:socket]
-      @tailable   = opts[:tailable] || false
-      @closed       = false
-      @query_run    = false
-      @transformer = opts[:transformer]
-      batch_size(opts[:batch_size] || 0)
-
-      @full_collection_name = "#{@collection.db.name}.#{@collection.name}"
-      @cache        = []
-      @returned     = 0
+      # 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.
+    #
+    # 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
+    end
+
+    def full_collection_name
+      @ns || "#{@collection.db.name}.#{@collection.name}"
     end
 
     # Get the next document specified the cursor options.
     #
     # @return [Hash, Nil] the next document or Nil if no documents remain.
-    def next_document
-      refresh if @cache.length == 0
+    def next
+      if @cache.length == 0
+        if @query_run && exhaust?
+          close
+          return nil
+        else
+          refresh
+        end
+      end
       doc = @cache.shift
 
-      if doc && doc['$err']
-        err = doc['$err']
+      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 == "not master"
+        if err.include?("not master")
           @connection.close
-          raise ConnectionFailure, err
+          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, err
+        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?
@@ -95,11 +168,12 @@ module Mongo
         @transformer.call(doc) if doc
       end
     end
-    alias :next :next_document
+    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
@@ -118,12 +192,13 @@ module Mongo
 
     # Get the size of the result set for this query.
     #
-    # @param [Boolean] whether of not to take notice of skip and limit
+    # @param [Boolean] skip_and_limit whether or not to take skip or limit into account.
     #
     # @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
@@ -131,12 +206,17 @@ module Mongo
         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)
+      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, "Count failed: #{response['errmsg']}"
+      raise OperationFailure.new("Count failed: #{response['errmsg']}", response['code'], response)
     end
 
     # Sort this cursor's results.
@@ -144,22 +224,18 @@ module Mongo
     # This method overrides any sort order specified in the Collection#find
     # method, and only the last sort applied has an effect.
     #
-    # @param [Symbol, Array] key_or_list either 1) a key to sort by or 2) 
-    #   an array of [key, direction] pairs to sort by. Direction should
-    #   be specified as Mongo::ASCENDING (or :ascending / :asc) or Mongo::DESCENDING (or :descending / :desc)
+    # @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(key_or_list, direction=nil)
+    def sort(order, direction=nil)
       check_modifiable
-
-      if !direction.nil?
-        order = [[key_or_list, direction]]
-      else
-        order = key_or_list
-      end
-
+      order = [[order, direction]] unless direction.nil?
       @order = order
       self
     end
@@ -172,12 +248,14 @@ module Mongo
     # @return [Integer] the current number_to_return if no parameter is given.
     #
     # @raise [InvalidOperation] if this cursor has already been used.
-    #
-    # @core limit limit-instance_method
     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
@@ -199,28 +277,57 @@ module Mongo
       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=0)
+    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 = size > @limit ? @limit : size
+        @batch_size = @limit != 0 && size > @limit ? @limit : size
       end
 
       self
     end
 
     # Iterate over each document in this cursor, yielding it to the given
-    # block.
+    # block, if provided. An Enumerator is returned if no block is given.
     #
     # Iterating over an entire cursor will close it.
     #
@@ -231,14 +338,18 @@ module Mongo
     #     puts doc['user']
     #   end
     def each
-      #num_returned = 0
-      #while has_next? && (@limit <= 0 || num_returned < @limit)
-      while doc = next_document
-        yield doc #next_document
-        #num_returned += 1
+      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:
@@ -258,10 +369,10 @@ module Mongo
     # Get the explain plan for this cursor.
     #
     # @return [Hash] a document containing the explain plan for this cursor.
-    #
-    # @core explain explain-instance_method
     def explain
-      c = Cursor.new(@collection, query_options_hash.merge(:limit => -@limit.abs, :explain => true))
+      check_command_cursor
+      c = Cursor.new(@collection,
+        query_options_hash.merge(:limit => -@limit.abs, :explain => true))
       explanation = c.next_document
       c.close
 
@@ -283,8 +394,12 @@ module Mongo
         message = BSON::ByteBuffer.new([0, 0, 0, 0])
         message.put_int(1)
         message.put_long(@cursor_id)
-        @logger.debug("MONGODB cursor.close #{@cursor_id}") if @logger
-        @connection.send_message(Mongo::Constants::OP_KILL_CURSORS, message, nil)
+        log(:debug, "Cursor#close #{@cursor_id}")
+        @connection.send_message(
+          Mongo::Constants::OP_KILL_CURSORS,
+          message,
+          :pool => @pool
+        )
       end
       @cursor_id = 0
       @closed    = true
@@ -293,7 +408,9 @@ module Mongo
     # Is this cursor closed?
     #
     # @return [Boolean]
-    def closed?; @closed; end
+    def closed?
+      @closed
+    end
 
     # Returns an integer indicating which query options have been selected.
     #
@@ -302,31 +419,76 @@ module Mongo
     # @see http://www.mongodb.org/display/DOCS/Mongo+Wire+Protocol#MongoWireProtocol-Mongo::Constants::OPQUERY
     # The MongoDB wire protocol.
     def query_opts
-      opts     = 0
-      opts    |= Mongo::Constants::OP_QUERY_NO_CURSOR_TIMEOUT unless @timeout
-      opts    |= Mongo::Constants::OP_QUERY_SLAVE_OK if @connection.slave_ok?
-      opts    |= Mongo::Constants::OP_QUERY_TAILABLE if @tailable
-      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
+      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
-      { :selector => @selector,
+      BSON::OrderedHash[
+        :selector => @selector,
         :fields   => @fields,
         :skip     => @skip,
         :limit    => @limit,
         :order    => @order,
         :hint     => @hint,
         :snapshot => @snapshot,
-        :timeout  => @timeout }
+        :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='#{@db.name}.#{@collection.name}' " +
-        "@selector=#{@selector.inspect}>"
+      "<Mongo::Cursor:0x#{object_id.to_s(16)} namespace='#{full_collection_name}' " +
+        "@selector=#{@selector.inspect} @cursor_id=#{@cursor_id}>"
     end
 
     private
@@ -340,7 +502,10 @@ module Mongo
           {fields => 1}
         when Array
           return nil if fields.length.zero?
-          fields.each_with_object({}) { |field, hash| hash[field] = 1 }
+          fields.inject({}) do |hash, field|
+            field.is_a?(Hash) ? hash.merge!(field) : hash[field] = 1
+            hash
+          end
         when Hash
           return fields
       end
@@ -348,16 +513,77 @@ module Mongo
 
     # Return the number of documents remaining for this cursor.
     def num_remaining
-      refresh if @cache.length == 0
+      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
-      return if send_initial_query || @cursor_id.zero?
+      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, "#{@db.name}.#{@collection.name}")
+      BSON::BSON_RUBY.serialize_cstr(message, full_collection_name)
 
       # Number of results to return.
       if @limit > 0
@@ -372,52 +598,73 @@ module Mongo
 
       # Cursor id.
       message.put_long(@cursor_id)
-      @logger.debug("MONGODB cursor.refresh() for cursor #{@cursor_id}") if @logger
-      results, @n_received, @cursor_id = @connection.receive_message(
-          Mongo::Constants::OP_GET_MORE, message, nil, @socket, @command)
+      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
     end
 
-    # Run query the first time we request an object from the wire
-    # TODO: should we be calling instrument_payload even if logging
-    # is disabled?
-    def send_initial_query
-      if @query_run
-        false
-      else
-        message = construct_query_message
-        @connection.instrument(:find, instrument_payload) do
-          results, @n_received, @cursor_id = @connection.receive_message(
-            Mongo::Constants::OP_QUERY, message, nil, @socket, @command)
-          @returned += @n_received
-          @cache += results
-          @query_run = true
-          close_cursor_if_query_complete
+    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
-        true
+      rescue SystemStackError, NoMemoryError, SystemCallError => ex
+        @connection.close
+        raise ex
       end
+      @pool = socket.pool
+      socket
+    end
+
+    def checkin_socket(sock)
+      @connection.checkin(sock)
     end
 
     def construct_query_message
-      message = BSON::ByteBuffer.new
-      message.put_int(query_opts)
-      BSON::BSON_RUBY.serialize_cstr(message, "#{@db.name}.#{@collection.name}")
+      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)
-      message.put_int(@limit)
-      spec = query_contains_special_fields? ? construct_query_spec : @selector
-      message.put_binary(BSON::BSON_CODER.serialize(spec, false).to_s)
-      message.put_binary(BSON::BSON_CODER.serialize(@fields, false).to_s) if @fields
+      @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
     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[:fields] = @fields if @fields
+      log[:skip]   = @skip   if @skip && (@skip != 0)
+      log[:limit]  = @limit  if @limit && (@limit != 0)
+      log[:order]  = @order  if @order
       log
     end
 
@@ -429,16 +676,25 @@ module Mongo
       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
     end
 
-    # Returns true if the query contains order, explain, hint, or snapshot.
-    def query_contains_special_fields?
-      @order || @explain || @hint || @snapshot
+    def needs_read_pref?
+      @connection.mongos? && @read != :primary
     end
 
-    def to_s
-      "DBResponse(flags=#@result_flags, cursor_id=#@cursor_id, start=#@starting_from)"
+    def query_contains_special_fields?
+      @order || @explain || @hint || @snapshot || @show_disk_loc ||
+        @max_scan || @return_key || @comment || @max_time_ms || needs_read_pref?
     end
 
     def close_cursor_if_query_complete
@@ -447,10 +703,40 @@ module Mongo
       end
     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("_")
+    end
+
+    def pin_pool?(response)
+      ( response && (response['cursor'] || response['cursors']) ) ||
+        ( !@socket && !@command )
+    end
   end
 end