mongo-ruby-driver/lib/mongo/cursor.rb

431 lines
14 KiB
Ruby
Raw Normal View History

# encoding: UTF-8
2010-02-19 22:41:36 +00:00
# Copyright (C) 2008-2010 10gen Inc.
2008-11-22 01:00:51 +00:00
#
# 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
2008-11-22 01:00:51 +00:00
#
# http://www.apache.org/licenses/LICENSE-2.0
2008-11-22 01:00:51 +00:00
#
# 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.
2008-11-22 01:00:51 +00:00
module Mongo
2008-11-22 01:00:51 +00:00
# A cursor over query results. Returned objects are hashes.
class Cursor
include Mongo::Conversions
include Enumerable
2008-11-22 01:00:51 +00:00
attr_reader :collection, :selector, :fields,
:order, :hint, :snapshot, :timeout,
:full_collection_name
2009-08-21 15:21:33 +00:00
# Create a new cursor.
#
2010-01-08 21:18:07 +00:00
# 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]
2010-02-08 17:12:18 +00:00
#
# @core cursors constructor_details
def initialize(collection, options={})
@db = collection.db
@collection = collection
@connection = @db.connection
@logger = @connection.logger
2010-10-04 18:37:19 +00:00
@selector = options[:selector] || {}
@fields = convert_fields_for_query(options[:fields])
@skip = options[:skip] || 0
@limit = options[:limit] || 0
@order = options[:order]
@hint = options[:hint]
@snapshot = options[:snapshot]
@timeout = options.has_key?(:timeout) ? options[:timeout] : true
@explain = options[:explain]
@socket = options[:socket]
2010-04-12 17:53:18 +00:00
@tailable = options[:tailable] || false
@closed = false
@query_run = false
2010-09-09 18:12:12 +00:00
batch_size(options[:batch_size] || 0)
@full_collection_name = "#{@collection.db.name}.#{@collection.name}"
2010-09-09 18:12:12 +00:00
@cache = []
@returned = 0
end
2010-01-08 21:18:07 +00:00
# Get the next document specified the cursor options.
#
# @return [Hash, Nil] the next document or Nil if no documents remain.
2009-12-16 19:03:15 +00:00
def next_document
2010-09-09 18:12:12 +00:00
refresh if @cache.length == 0#empty?# num_remaining == 0
2009-12-16 19:03:15 +00:00
doc = @cache.shift
2009-12-16 19:03:15 +00:00
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
2009-12-16 19:03:15 +00:00
# connection. The next request will re-open on master server.
2009-11-23 18:13:14 +00:00
if err == "not master"
@connection.close
raise ConnectionFailure, err
2009-11-23 18:13:14 +00:00
end
2009-11-23 18:13:14 +00:00
raise OperationFailure, err
end
2008-11-22 01:00:51 +00:00
2009-12-16 19:03:15 +00:00
doc
end
2009-08-18 15:26:58 +00:00
# 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
2010-03-19 18:31:31 +00:00
# Determine whether this cursor has any remaining results.
#
# @return [Boolean]
def has_next?
num_remaining > 0
end
2009-12-16 19:03:15 +00:00
# Get the size of the result set for this query.
#
2010-01-08 21:18:07 +00:00
# @return [Integer] the number of objects in the result set for this query. Does
# not take limit and skip into account.
#
# @raise [OperationFailure] on a database error.
def count
2010-05-07 01:25:18 +00:00
command = BSON::OrderedHash["count", @collection.name,
"query", @selector,
"fields", @fields]
response = @db.command(command)
return response['n'].to_i if Mongo::Support.ok?(response)
return 0 if response['errmsg'] == "ns missing"
raise OperationFailure, "Count failed: #{response['errmsg']}"
end
2009-09-17 18:54:30 +00:00
2009-12-16 19:03:15 +00:00
# Sort this cursor's results.
2009-09-17 18:54:30 +00:00
#
# This method overrides any sort order specified in the Collection#find
2009-12-16 19:03:15 +00:00
# method, and only the last sort applied has an effect.
2010-01-08 21:18:07 +00:00
#
# @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)
#
# @raise [InvalidOperation] if this cursor has already been used.
#
# @raise [InvalidSortValueError] if the specified order is invalid.
2009-10-08 14:02:54 +00:00
def sort(key_or_list, direction=nil)
2009-09-17 19:07:18 +00:00
check_modifiable
2009-10-08 14:02:54 +00:00
if !direction.nil?
order = [[key_or_list, direction]]
else
order = key_or_list
end
@order = order
self
end
2010-01-08 21:18:07 +00:00
# Limit the number of results to be returned by this cursor.
2009-09-17 18:54:30 +00:00
#
# This method overrides any limit specified in the Collection#find method,
# and only the last limit applied has an effect.
2010-01-08 21:18:07 +00:00
#
# @return [Integer] the current number_to_return if no parameter is given.
#
# @raise [InvalidOperation] if this cursor has already been used.
2010-02-08 17:12:18 +00:00
#
# @core limit limit-instance_method
def limit(number_to_return=nil)
return @limit unless number_to_return
check_modifiable
raise ArgumentError, "limit requires an integer" unless number_to_return.is_a? Integer
@limit = number_to_return
2009-09-17 19:07:18 +00:00
self
end
# Skips the first +number_to_skip+ results of this cursor.
# Returns the current number_to_skip if no parameter is given.
2009-12-16 19:03:15 +00:00
#
# This method overrides any skip specified in the Collection#find method,
2009-09-17 18:54:30 +00:00
# and only the last skip applied has an effect.
2010-01-08 21:18:07 +00:00
#
# @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
raise ArgumentError, "skip requires an integer" unless number_to_skip.is_a? Integer
@skip = number_to_skip
2009-09-17 19:07:18 +00:00
self
end
2010-09-09 18:12:12 +00:00
# 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.
#
# @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)
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
end
self
end
# Iterate over each document in this cursor, yielding it to the given
# block.
#
# Iterating over an entire cursor will close it.
2010-01-08 21:18:07 +00:00
#
# @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
2010-09-09 18:12:12 +00:00
#num_returned = 0
#while has_next? && (@limit <= 0 || num_returned < @limit)
while doc = next_document
yield doc #next_document
#num_returned += 1
end
end
2008-11-22 01:00:51 +00:00
2010-01-08 21:18:07 +00:00
# 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
2010-01-08 21:18:07 +00:00
# efficient to retrieve documents as you need them by iterating over the cursor.
#
2010-01-08 21:18:07 +00:00
# @return [Array] an array of documents.
def to_a
super
end
2009-01-14 15:42:56 +00:00
2010-01-08 21:18:07 +00:00
# Get the explain plan for this cursor.
#
# @return [Hash] a document containing the explain plan for this cursor.
2010-02-08 17:12:18 +00:00
#
# @core explain explain-instance_method
def explain
2010-09-09 18:22:09 +00:00
c = Cursor.new(@collection, query_options_hash.merge(:limit => -@limit.abs, :explain => true))
2009-12-16 19:03:15 +00:00
explanation = c.next_document
c.close
explanation
end
2008-11-22 01:00:51 +00:00
2010-01-08 21:18:07 +00:00
# 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
2010-01-08 21:18:07 +00:00
# close it manually.
2009-08-21 15:21:33 +00:00
#
2010-01-08 21:18:07 +00:00
# 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
2010-04-05 14:39:55 +00:00
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)
end
@cursor_id = 0
@closed = true
end
2008-11-22 01:00:51 +00:00
2010-01-08 21:18:07 +00:00
# Is this cursor closed?
#
# @return [Boolean]
2009-08-21 15:21:33 +00:00
def closed?; @closed; end
# Returns an integer indicating which query options have been selected.
2010-01-08 21:18:07 +00:00
#
# @return [Integer]
#
# @see http://www.mongodb.org/display/DOCS/Mongo+Wire+Protocol#MongoWireProtocol-Mongo::Constants::OPQUERY
# The MongoDB wire protocol.
def query_opts
2010-07-09 20:15:36 +00:00
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
end
2010-01-08 21:18:07 +00:00
# Get the query options for this Cursor.
#
# @return [Hash]
def query_options_hash
{ :selector => @selector,
2009-12-16 19:03:15 +00:00
:fields => @fields,
:skip => @skip_num,
:limit => @limit_num,
:order => @order,
:hint => @hint,
:snapshot => @snapshot,
:timeout => @timeout }
end
# Clean output for inspect.
def inspect
"<Mongo::Cursor:0x#{object_id.to_s(16)} namespace='#{@db.name}.#{@collection.name}' " +
"@selector=#{@selector.inspect}>"
end
private
2008-11-22 01:00:51 +00:00
2010-01-08 21:18:07 +00:00
# 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
end
2010-09-09 18:12:12 +00:00
# Return the number of documents remaining for this cursor.
def num_remaining
refresh if @cache.length == 0
@cache.length
end
2008-11-22 01:00:51 +00:00
def refresh
2009-12-16 19:03:15 +00:00
return if send_initial_query || @cursor_id.zero?
2010-04-05 14:39:55 +00:00
message = BSON::ByteBuffer.new([0, 0, 0, 0])
# DB name.
BSON::BSON_RUBY.serialize_cstr(message, "#{@db.name}.#{@collection.name}")
# Number of results to return.
2010-09-09 18:53:29 +00:00
if @limit > 0
limit = @limit - @returned
if @batch_size > 0
limit = limit < @batch_size ? limit : @batch_size
2010-09-09 18:12:12 +00:00
end
2010-09-09 18:53:29 +00:00
message.put_int(limit)
2010-09-09 18:12:12 +00:00
else
message.put_int(@batch_size)
end
2009-12-16 19:03:15 +00:00
# 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)
2010-09-09 18:12:12 +00:00
@returned += @n_received
@cache += results
close_cursor_if_query_complete
end
2008-11-22 01:00:51 +00:00
# Run query the first time we request an object from the wire
2009-12-16 19:03:15 +00:00
def send_initial_query
if @query_run
false
else
2009-11-02 20:04:06 +00:00
message = construct_query_message
@logger.debug query_log_message if @logger
results, @n_received, @cursor_id = @connection.receive_message(Mongo::Constants::OP_QUERY, message, nil, @socket)
2010-09-09 18:12:12 +00:00
@returned += @n_received
@cache += results
@query_run = true
close_cursor_if_query_complete
true
2008-11-22 01:00:51 +00:00
end
end
2009-11-02 20:04:06 +00:00
def construct_query_message
2010-04-05 14:39:55 +00:00
message = BSON::ByteBuffer.new
message.put_int(query_opts)
BSON::BSON_RUBY.serialize_cstr(message, "#{@db.name}.#{@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
message
end
2009-11-02 20:04:06 +00:00
def query_log_message
"#{@db.name}['#{@collection.name}'].find(#{@selector.inspect}, #{@fields ? @fields.inspect : '{}'})" +
2010-03-15 15:51:22 +00:00
"#{@skip != 0 ? ('.skip(' + @skip.to_s + ')') : ''}#{@limit != 0 ? ('.limit(' + @limit.to_s + ')') : ''}" +
"#{@order ? ('.sort(' + @order.inspect + ')') : ''}"
2009-11-02 20:04:06 +00:00
end
def construct_query_spec
return @selector if @selector.has_key?('$query')
2010-05-07 01:25:18 +00:00
spec = BSON::OrderedHash.new
spec['$query'] = @selector
2010-04-06 21:56:21 +00:00
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
end
# Returns true if the query contains order, explain, hint, or snapshot.
def query_contains_special_fields?
@order || @explain || @hint || @snapshot
end
def to_s
"DBResponse(flags=#@result_flags, cursor_id=#@cursor_id, start=#@starting_from)"
end
def close_cursor_if_query_complete
2010-09-09 18:53:29 +00:00
if @limit > 0 && @returned >= @limit
2010-09-09 18:12:12 +00:00
close
end
end
def check_modifiable
if @query_run || @closed
raise InvalidOperation, "Cannot modify the query once it has been run or closed."
end
end
2008-11-22 01:00:51 +00:00
end
end