Class: Mongo::Operation::Find::Result

Inherits:
Result
  • Object
show all
Defined in:
build/ruby-driver-v2.19/lib/mongo/operation/find/result.rb

Overview

Defines custom behavior of results in find command.

Since:

  • 2.2.0

Constant Summary

Constants inherited from Result

Result::CURSOR, Result::CURSOR_ID, Result::FIRST_BATCH, Result::N, Result::NAMESPACE, Result::NEXT_BATCH, Result::OK, Result::RESULT

Instance Attribute Summary

Attributes inherited from Result

#connection_description, #connection_global_id, #replies

Instance Method Summary collapse

Methods inherited from Result

#acknowledged?, #cluster_time, #each, #error, #has_cursor_id?, #initialize, #inspect, #labels, #ok?, #operation_time, #reply, #returned_count, #snapshot_timestamp, #successful?, #topology_version, #validate!, #write_concern_error?, #written_count

Constructor Details

This class inherits a constructor from Mongo::Operation::Result

Instance Method Details

#cursor_id ⇒ Integer

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get the cursor id.

Examples:

Get the cursor id.

result.cursor_id

Returns:

  • (Integer) —

    The cursor id.

Since:

  • 2.2.0



37
38
39
 
# File 'build/ruby-driver-v2.19/lib/mongo/operation/find/result.rb', line 37

def cursor_id
  cursor_document ? cursor_document[CURSOR_ID] : super
end

#documents ⇒ Array<BSON::Document>

Get the documents in the result.

Examples:

Get the documents.

result.documents

Returns:

  • (Array<BSON::Document>) —

    The documents.

Since:

  • 2.2.0



50
51
52
 
# File 'build/ruby-driver-v2.19/lib/mongo/operation/find/result.rb', line 50

def documents
  cursor_document[FIRST_BATCH]
end

#namespace ⇒ String

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

The namespace in which this find command was performed.

Returns:

  • (String) —

    The namespace, usually in the format “database.collection”.

Since:

  • 2.2.0



60
61
62
 
# File 'build/ruby-driver-v2.19/lib/mongo/operation/find/result.rb', line 60

def namespace
  cursor_document['ns']
end