mongo 1.8.6 → 2.15.1

data/lib/mongo/cursor.rb

@@ -1,616 +1,447 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+# Copyright (C) 2014-2020 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.
+
+require 'mongo/cursor/builder'
+
 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.
+  #
+  # +Cursor+ objects are not directly exposed to application code. Rather,
+  # +Collection::View+ exposes the +Enumerable+ interface to the applications,
+  # and the enumerator is backed by a +Cursor+ instance.
+  #
+  # @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 }
+  #
+  # @api private
   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,
-      :full_collection_name, :transformer,
-      :options, :cursor_id, :show_disk_loc,
-      :comment, :read, :tag_sets, :acceptable_latency
-
-    # Create a new cursor.
-    #
-    # Note: cursors are created when executing queries using [Collection#find] and other
-    # similar methods. Application developers shouldn't have to create cursors manually.
-    #
-    # @return [Cursor]
-    #
-    # @core cursors constructor_details
-    def initialize(collection, opts={})
-      @cursor_id  = nil
-      @db         = collection.db
-      @collection = collection
-      @connection = @db.connection
-      @logger     = @connection.logger
-
-      # Query selector
-      @selector   = opts[:selector] || {}
-
-      # Special operators that form part of $query
-      @order      = opts[:order]
-      @explain    = opts[:explain]
-      @hint       = opts[:hint]
-      @snapshot   = opts[:snapshot]
-      @max_scan   = opts.fetch(:max_scan, nil)
-      @return_key = opts.fetch(:return_key, nil)
-      @show_disk_loc = opts.fetch(:show_disk_loc, nil)
-      @comment    = opts[:comment]
-
-      # Wire-protocol settings
-      @fields     = convert_fields_for_query(opts[:fields])
-      @skip       = opts[:skip]     || 0
-      @limit      = opts[:limit]    || 0
-      @tailable   = opts[:tailable] || false
-      @timeout    = opts.fetch(:timeout, true)
-      @options    = 0
-
-      # Use this socket for the query
-      @socket = opts[:socket]
-      @pool   = nil
-
-      @closed       = false
-      @query_run    = false
-
-      @transformer = opts[:transformer]
-      @read =  opts[:read] || @collection.read
-      Mongo::ReadPreference::validate(@read)
-      @tag_sets = opts[:tag_sets] || @collection.tag_sets
-      @acceptable_latency = opts[:acceptable_latency] || @collection.acceptable_latency
-
-      batch_size(opts[:batch_size] || 0)
-
-      @full_collection_name = "#{@collection.db.name}.#{@collection.name}"
-      @cache        = []
-      @returned     = 0
-
-      if(!@timeout)
-        add_option(OP_QUERY_NO_CURSOR_TIMEOUT)
-      end
-      if(@read != :primary)
-        add_option(OP_QUERY_SLAVE_OK)
+    include Retryable
+
+    def_delegators :@view, :collection
+    def_delegators :collection, :client, :database
+    def_delegators :@server, :cluster
+
+    # @return [ Collection::View ] view The collection view.
+    attr_reader :view
+
+    # The resume token tracked by the cursor for change stream resuming
+    #
+    # @return [ BSON::Document | nil ] The cursor resume token.
+    # @api private
+    attr_reader :resume_token
+
+    # Creates a +Cursor+ object.
+    #
+    # @example Instantiate the cursor.
+    #   Mongo::Cursor.new(view, response, 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.
+    # @param [ Hash ] options The cursor options.
+    #
+    # @option options [ true, false ] :disable_retry Whether to disable
+    #   retrying on error when sending getMore operations (deprecated, getMore
+    #   operations are no longer retried)
+    # @option options [ true, false ] :retry_reads Retry reads (following
+    #   the modern mechanism), default is true
+    #
+    # @since 2.0.0
+    def initialize(view, result, server, options = {})
+      @view = view
+      @server = server
+      @initial_result = result
+      @namespace = result.namespace
+      @remaining = limit if limited?
+      @cursor_id = result.cursor_id
+      if @cursor_id.nil?
+        raise ArgumentError, 'Cursor id must be present in the result'
       end
-      if(@tailable)
-        add_option(OP_QUERY_TAILABLE)
-      end
-
-      if @collection.name =~ /^\$cmd/ || @collection.name =~ /^system/
-        @command = true
-      else
-        @command = false
+      @options = options
+      @session = @options[:session]
+      unless closed?
+        register
+        ObjectSpace.define_finalizer(self, self.class.finalize(@cursor_id,
+          cluster,
+          kill_cursors_op_spec,
+          server,
+          @session))
       end
     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
+    # @api private
+    attr_reader :server
 
-    # Get the next document specified the cursor options.
+    # Finalize the cursor for garbage collection. Schedules this cursor to be included
+    # in a killCursors operation executed by the Cluster's CursorReaper.
     #
-    # @return [Hash, Nil] the next document or Nil if no documents remain.
-    def next
-      if @cache.length == 0
-        if @query_run && (@options & OP_QUERY_EXHAUST != 0)
-          close
-          return nil
-        else
-          refresh
-        end
-      end
-      doc = @cache.shift
-
-      if doc && doc['$err']
-        err = doc['$err']
-
-        # 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, doc['code'], doc)
-        end
-
-        raise OperationFailure.new(err, doc['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!
-      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 Finalize the cursor.
+    #   Cursor.finalize(id, cluster, op, server)
     #
-    # @param [Boolean] whether of not to take notice of skip and limit
+    # @param [ Integer ] cursor_id The cursor's id.
+    # @param [ Mongo::Cluster ] cluster The cluster associated with this cursor and its server.
+    # @param [ Hash ] op_spec The killCursors operation specification.
+    # @param [ Mongo::Server ] server The server to send the killCursors operation to.
     #
-    # @return [Integer] the number of objects in the result set for this query.
+    # @return [ Proc ] The Finalizer.
     #
-    # @raise [OperationFailure] on a database error.
-    def count(skip_and_limit = false)
-      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
+    # @since 2.3.0
+    def self.finalize(cursor_id, cluster, op_spec, server, session)
+      proc do
+        cluster.schedule_kill_cursor(cursor_id, op_spec, server)
+        session.end_session if session && session.implicit?
       end
-
-      command.merge!(BSON::OrderedHash["fields", @fields])
-
-      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.
+    # Get a human-readable string representation of +Cursor+.
     #
-    # @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)
+    # @example Inspect the cursor.
+    #   cursor.inspect
     #
-    # @raise [InvalidOperation] if this cursor has already been used.
+    # @return [ String ] A string representation of a +Cursor+ instance.
     #
-    # @raise [InvalidSortValueError] if the specified order is invalid.
-    def sort(order, direction=nil)
-      check_modifiable
-      order = [[order, direction]] unless direction.nil?
-      @order = order
-      self
+    # @since 2.0.0
+    def inspect
+      "#<Mongo::Cursor:0x#{object_id} @view=#{@view.inspect}>"
     end
 
-    # Limit the number of results to be returned by this cursor.
+    # Iterate through documents returned from the query.
     #
-    # This method overrides any limit specified in the Collection#find method,
-    # and only the last limit applied has an effect.
+    # A cursor may be iterated at most once. Incomplete iteration is also
+    # allowed. Attempting to iterate the cursor more than once raises
+    # InvalidCursorOperation.
     #
-    # @return [Integer] the current number_to_return if no parameter is given.
+    # @example Iterate over the documents in the cursor.
+    #   cursor.each do |doc|
+    #     ...
+    #   end
     #
-    # @raise [InvalidOperation] if this cursor has already been used.
+    # @return [ Enumerator ] The enumerator.
     #
-    # @core limit limit-instance_method
-    def limit(number_to_return=nil)
-      return @limit unless number_to_return
-      check_modifiable
-      @limit = number_to_return
-      self
-    end
+    # @since 2.0.0
+    def each
 
-    # 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
+      # If we already iterated past the first batch (i.e., called get_more
+      # at least once), the cursor on the server side has advanced past
+      # the first batch and restarting iteration from the beginning by
+      # returning initial result would miss documents in the second batch
+      # and subsequent batches up to wherever the cursor is. Detect this
+      # condition and abort the iteration.
+      #
+      # In a future driver version, each would either continue from the
+      # end of previous iteration or would always restart from the
+      # beginning.
+      if @get_more_called
+        raise Error::InvalidCursorOperation, 'Cannot restart iteration of a cursor which issued a getMore'
+      end
 
-      @skip = number_to_skip
-      self
+      # To maintain compatibility with pre-2.10 driver versions, reset
+      # the documents array each time a new iteration is started.
+      @documents = nil
+
+      if block_given?
+        # StopIteration raised by try_next ends this loop.
+        loop do
+          document = try_next
+          yield document if document
+        end
+        self
+      else
+        documents = []
+        # StopIteration raised by try_next ends this loop.
+        loop do
+          document = try_next
+          documents << document if document
+        end
+        documents
+      end
     end
 
-    # Set the batch size for server responses.
+    # Return one document from the query, if one is available.
     #
-    # Note that the batch size will take effect only on queries
-    # where the number to be returned is greater than 100.
+    # This method will wait up to max_await_time_ms milliseconds
+    # for changes from the server, and if no changes are received
+    # it will return nil. If there are no more documents to return
+    # from the server, or if we have exhausted the cursor, it will
+    # raise a StopIteration exception.
     #
-    # 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.
+    # @note This method is experimental and subject to change.
     #
-    # @param [Integer] size either 0 or some integer greater than 1. If 0,
-    #   the server will determine the batch size.
+    # @return [ BSON::Document | nil ] A document.
     #
-    # @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
+    # @raise [ StopIteration ] Raised on the calls after the cursor had been
+    #   completely iterated.
+    #
+    # @api private
+    def try_next
+      if @documents.nil?
+        # Since published versions of Mongoid have a copy of old driver cursor
+        # code, our dup call in #process isn't invoked when Mongoid query
+        # cache is active. Work around that by also calling dup here on
+        # the result of #process which might come out of Mongoid's code.
+        @documents = process(@initial_result).dup
+        # the documents here can be an empty array, hence
+        # we may end up issuing a getMore in the first try_next call
       end
 
-      self
-    end
+      if @documents.empty?
+        # On empty batches, we cache the batch resume token
+        cache_batch_resume_token
 
-    # 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.
-    #
-    # @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']
-    #   end
-    def each
-      if block_given? || !defined?(Enumerator)
-        while doc = self.next
-          yield doc
+        unless closed?
+          if exhausted?
+            close
+            @fully_iterated = true
+            raise StopIteration
+          end
+          @documents = get_more
+        else
+          @fully_iterated = true
+          raise StopIteration
         end
       else
-        Enumerator.new do |yielder|
-          while doc = self.next
-            yielder.yield doc
-          end
+        # cursor is closed here
+        # keep documents as an empty array
+      end
+
+      # If there is at least one document, cache its _id
+      if @documents[0]
+        cache_resume_token(@documents[0])
+      end
+
+      # Cache the batch resume token if we are iterating
+      # over the last document, or if the batch is empty
+      if @documents.size <= 1
+        cache_batch_resume_token
+        if closed?
+          @fully_iterated = true
         end
       end
+
+      return @documents.shift
     end
-    # Receive all the documents from this cursor as an array of hashes.
-    #
-    # Notes:
+
+    # Get the batch size.
     #
-    # 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.
+    # @example Get the batch size.
+    #   cursor.batch_size
     #
-    # 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 [ Integer ] The batch size.
     #
-    # @return [Array] an array of documents.
-    def to_a
-      super
+    # @since 2.2.0
+    def batch_size
+      @view.batch_size && @view.batch_size > 0 ? @view.batch_size : limit
     end
 
-    # Get the explain plan for this cursor.
+    # Is the cursor closed?
     #
-    # @return [Hash] a document containing the explain plan for this cursor.
+    # @example Is the cursor closed?
+    #   cursor.closed?
     #
-    # @core explain explain-instance_method
-    def explain
-      c = Cursor.new(@collection,
-        query_options_hash.merge(:limit => -@limit.abs, :explain => true))
-      explanation = c.next_document
-      c.close
-
-      explanation
+    # @return [ true, false ] If the cursor is closed.
+    #
+    # @since 2.2.0
+    def closed?
+      # @cursor_id should in principle never be nil
+      @cursor_id.nil? || @cursor_id == 0
     end
 
-    # Close the cursor.
+    # Closes this cursor, freeing any associated resources on the client and
+    # the server.
     #
-    # 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.
+    # @return [ nil ] Always nil.
     #
-    # Note also: Collection#find takes an optional block argument which can be used to
-    # ensure that your cursors get closed.
-    #
-    # @return [True]
+    # @raise [ Error::OperationFailure ] If the server cursor close fails.
+    # @raise [ Error::SocketError | Error::SocketTimeoutError ] When there is a network error.
     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
-        )
+      return if closed?
+
+      unregister
+      read_with_one_retry do
+        kill_cursors_operation.execute(@server, context: Operation::Context.new(client: client, session: @session))
       end
+
+      nil
+    ensure
+      end_session
       @cursor_id = 0
-      @closed    = true
     end
 
-    # Is this cursor closed?
+    # Get the parsed collection name.
     #
-    # @return [Boolean]
-    def closed?
-      @closed
-    end
-
-    # Returns an integer indicating which query options have been selected.
+    # @example Get the parsed collection name.
+    #   cursor.coll_name
     #
-    # @return [Integer]
+    # @return [ String ] The collection name.
     #
-    # @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
+    # @since 2.2.0
+    def collection_name
+      # In most cases, this will be equivalent to the name of the collection
+      # object in the driver. However, in some cases (e.g. when connected
+      # to an Atlas Data Lake), the namespace returned by the find command
+      # may be different, which is why we want to use the collection name based
+      # on the namespace in the command result.
+      if @namespace
+        # Often, the namespace will be in the format "database.collection".
+        # However, sometimes the collection name will contain periods, which
+        # is why this method joins all the namespace components after the first.
+        ns_components = @namespace.split('.')
+        ns_components[1...ns_components.length].join('.')
+      else
+        collection.name
+      end
     end
 
-    # Add an option to the query options bitfield.
+    # Get the cursor id.
     #
-    # @param opt a valid query option
+    # @example Get the cursor id.
+    #   cursor.id
     #
-    # @raise InvalidOperation if this method is run after the cursor has bee
-    #   iterated for the first time.
+    # @note A cursor id of 0 means the cursor was closed on the server.
     #
-    # @return [Integer] the current value of the options bitfield for this cursor.
+    # @return [ Integer ] The cursor id.
     #
-    # @see http://www.mongodb.org/display/DOCS/Mongo+Wire+Protocol#MongoWireProtocol-Mongo::Constants::OPQUERY
-    def add_option(opt)
-      check_modifiable
-
-      @options |= opt
-      @options
+    # @since 2.2.0
+    def id
+      @cursor_id
     end
 
-    # Remove an option from the query options bitfield.
-    #
-    # @param opt a valid query option
+    # Get the number of documents to return. Used on 3.0 and lower server
+    # versions.
     #
-    # @raise InvalidOperation if this method is run after the cursor has bee
-    #   iterated for the first time.
+    # @example Get the number to return.
+    #   cursor.to_return
     #
-    # @return [Integer] the current value of the options bitfield for this cursor.
+    # @return [ Integer ] The number of documents to return.
     #
-    # @see http://www.mongodb.org/display/DOCS/Mongo+Wire+Protocol#MongoWireProtocol-Mongo::Constants::OPQUERY
-    def remove_option(opt)
-      check_modifiable
-
-      @options &= ~opt
-      @options
+    # @since 2.2.0
+    def to_return
+      use_limit? ? @remaining : (batch_size || 0)
     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 ]
+    # Execute a getMore command and return the batch of documents
+    # obtained from the server.
+    #
+    # @return [ Array<BSON::Document> ] The batch of documents
+    #
+    # @api private
+    def get_more
+      @get_more_called = true
+
+      # Modern retryable reads specification prohibits retrying getMores.
+      # Legacy retryable read logic used to retry getMores, but since
+      # doing so may result in silent data loss, the driver no longer retries
+      # getMore operations in any circumstance.
+      # https://github.com/mongodb/specifications/blob/master/source/retryable-reads/retryable-reads.rst#qa
+      process(get_more_operation.execute(@server, context: Operation::Context.new(client: client, session: @session)))
     end
 
-    # Clean output for inspect.
-    def inspect
-      "<Mongo::Cursor:0x#{object_id.to_s(16)} namespace='#{@db.name}.#{@collection.name}' " +
-        "@selector=#{@selector.inspect} @cursor_id=#{@cursor_id}>"
+    # @api private
+    def fully_iterated?
+      !!@fully_iterated
     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.each_with_object({}) { |field, hash| hash[field] = 1 }
-        when Hash
-          return fields
-      end
+    def exhausted?
+      limited? ? @remaining <= 0 : false
     end
 
-    # Return the number of documents remaining for this cursor.
-    def num_remaining
-      if @cache.length == 0
-        if @query_run && (@options & OP_QUERY_EXHAUST != 0)
-          close
-          return 0
-        else
-          refresh
-        end
+    def cache_resume_token(doc)
+      if doc[:_id] && doc[:_id].is_a?(Hash)
+        @resume_token = doc[:_id] && doc[:_id].dup.freeze
       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
+    def cache_batch_resume_token
+      @resume_token = @post_batch_resume_token if @post_batch_resume_token
     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, @options & OP_QUERY_EXHAUST != 0)
-        rescue ConnectionFailure => ex
-          socket.close if socket
-          @pool = nil
-          @connection.unpin_pool
-          @connection.refresh
-          if tries < 3 && !@socket && (!@command || Mongo::Support::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 !@socket && !@command
-          @connection.pin_pool(socket.pool, read_preference)
-        end
-        @returned += @n_received
-        @cache += results
-        @query_run = true
-        close_cursor_if_query_complete
+    def get_more_operation
+      if @server.with_connection { |connection| connection.features }.find_command_enabled?
+        spec = Builder::GetMoreCommand.new(self, @session).specification
+      else
+        spec = Builder::OpGetMore.new(self).specification
       end
+      Operation::GetMore.new(spec)
     end
 
-    def send_get_more
-      message = BSON::ByteBuffer.new([0, 0, 0, 0])
+    def end_session
+      @session.end_session if @session && @session.implicit?
+    end
 
-      # DB name.
-      BSON::BSON_RUBY.serialize_cstr(message, "#{@db.name}.#{@collection.name}")
+    def kill_cursors_operation
+      Operation::KillCursors.new(kill_cursors_op_spec)
+    end
 
-      # 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)
+    def kill_cursors_op_spec
+      if @server.with_connection { |connection| connection.features }.find_command_enabled?
+        Builder::KillCursorsCommand.new(self).specification
       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)
-      ensure
-        socket.checkin
+        Builder::OpKillCursors.new(self).specification
       end
-
-      @returned += @n_received
-      @cache += results
-      close_cursor_if_query_complete
     end
 
-    def checkout_socket_from_connection
-      begin
-        if @pool
-          socket = @pool.checkout
-        elsif @command && !Mongo::Support::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 limited?
+      limit ? limit > 0 : false
     end
 
-    def checkin_socket(sock)
-      @connection.checkin(sock)
-    end
+    def process(result)
+      @remaining -= result.returned_count if limited?
+      # #process is called for the first batch of results. In this case
+      # the @cursor_id may be zero (all results fit in the first batch).
+      # Thus we need to check both @cursor_id and the cursor_id of the result
+      # prior to calling unregister here.
+      unregister if !closed? && result.cursor_id == 0
+      @cursor_id = result.cursor_id
 
-    def construct_query_message
-      message = BSON::ByteBuffer.new("", @connection.max_message_size)
-      message.put_int(@options)
-      BSON::BSON_RUBY.serialize_cstr(message, "#{@db.name}.#{@collection.name}")
-      message.put_int(@skip)
-      @batch_size > 1 ? message.put_int(@batch_size) : message.put_int(@limit)
-      spec = query_contains_special_fields? ? construct_query_spec : @selector
-      message.put_binary(BSON::BSON_CODER.serialize(spec, false, false, @connection.max_bson_size).to_s)
-      message.put_binary(BSON::BSON_CODER.serialize(@fields, false, false, @connection.max_bson_size).to_s) if @fields
-      message
-    end
+      if result.respond_to?(:post_batch_resume_token)
+        @post_batch_resume_token = result.post_batch_resume_token
+      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
-    end
+      end_session if closed?
 
-    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
-      if needs_read_pref?
-        read_pref = Mongo::ReadPreference::mongos(@read, @tag_sets)
-        spec['$readPreference'] = read_pref if read_pref
-      end
-      spec
+      # Since our iteration code mutates the documents array by calling #shift
+      # on it, duplicate the documents here to permit restarting iteration
+      # from the beginning of the cursor as long as get_more was not called
+      result.documents.dup
     end
 
-    def needs_read_pref?
-      @connection.mongos? && @read != :primary
+    def use_limit?
+      limited? && batch_size >= @remaining
     end
 
-    def query_contains_special_fields?
-      @order || @explain || @hint || @snapshot || @show_disk_loc ||
-        @max_scan || @return_key || @comment || needs_read_pref?
+    def limit
+      @view.send(:limit)
     end
 
-    def close_cursor_if_query_complete
-      if @limit > 0 && @returned >= @limit
-        close
-      end
+    def register
+      cluster.register_cursor(@cursor_id)
     end
 
-    def check_modifiable
-      if @query_run || @closed
-        raise InvalidOperation, "Cannot modify the query once it has been run or closed."
-      end
+    def unregister
+      cluster.unregister_cursor(@cursor_id)
     end
   end
 end