Result — Documentation by YARD 0.9.37 (original) (raw)

Class: Mongo::Operation::MapReduce::Result

Inherits:

Result

• Object
• Result
• Mongo::Operation::MapReduce::Result show all

Defined in:

lib/mongo/operation/map_reduce/result.rb

Overview

Defines custom behavior of results for a map reduce operation.

Constant Summarycollapse

COUNTS =

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

The counts field for the map/reduce.

'counts'.freeze

RESULTS =

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

The field name for a result without a cursor.

'results'.freeze

TIME =

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

The time the operation took constant.

'timeMillis'.freeze

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, #connection_description, #connection_global_id, #context, #replies

Instance Method Summarycollapse

• #counts ⇒ Hash
  Gets the map/reduce counts from the reply.
• #cursor_id ⇒ Integer private
  Get the cursor id.
• #documents ⇒ ArrayBSON::Document
  Get the documents from the map/reduce.
• #returned_count ⇒ Integer
  Get the number of documents returned by the server in this batch.
• #successful? ⇒ true, false
  If the result was a command then determine if it was considered a success.
• #time ⇒ Integer
  Get the execution time of the map/reduce.
• #validate! ⇒ Result private
  Validate the result by checking for any errors.

Methods inherited from Result

#acknowledged?, #cluster_time, #each, #error, #has_cursor_id?, #initialize, #inspect, #labels, #namespace, #ok?, #operation_time, #reply, #snapshot_timestamp, #topology_version, #write_concern_error?, #written_count

Instance Method Details

#counts ⇒ Hash

Gets the map/reduce counts from the reply.

#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.

#documents ⇒ ArrayBSON::Document

Get the documents from the map/reduce.

| 68 69 70 | # File 'lib/mongo/operation/map_reduce/result.rb', line 68 def documents reply.documents[0][RESULTS] || reply.documents[0][RESULT] end | | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

#returned_count ⇒ Integer

Get the number of documents returned by the server in this batch.

Map/Reduce operation returns documents inline without using cursors; as such, the standard Mongo::Reply#returned_count does not work correctly for Map/Reduce.

Note that the Map/Reduce operation is limited to max BSON document size (16 MB) in its inline result set.

#successful? ⇒ true, false

Note:

If the write was unacknowledged, then this will always return true.

If the result was a command then determine if it was considered a success.

#time ⇒ Integer

Get the execution time of the map/reduce.

#validate! ⇒ Result

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.

Note:

This only checks for errors with writes since authentication is handled at the connection level and any authentication errors would be raised there, before a Result is ever created.

Validate the result by checking for any errors.