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

Inherits:
Result
  • Object
show all
Defined in:
lib/mongo/operation/map_reduce/result.rb

Overview

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

Defines custom behaviour of results for a map reduce operation.

Since:

  • 2.0.0

Constant Summary collapse

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.

Since:

  • 2.0.0

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

Since:

  • 2.0.0

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

Since:

  • 2.0.0

'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

#replies

Instance Method Summary collapse

Methods inherited from Result

#acknowledged?, #cluster_time, #each, #initialize, #inspect, #multiple?, #namespace, #ok?, #operation_time, #reply, #returned_count, #written_count

Constructor Details

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

Instance Method Details

#countsHash

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.

Gets the map/reduce counts from the reply.

Examples:

Get the counts.

result.counts

Returns:

  • (Hash)

    A hash of the result counts.

Since:

  • 2.0.0



47
48
49
# File 'lib/mongo/operation/map_reduce/result.rb', line 47

def counts
  reply.documents[0][COUNTS]
end

#cursor_idInteger

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)

    Always 0 because map reduce doesn't return a cursor.

Since:

  • 2.5.0



117
118
119
# File 'lib/mongo/operation/map_reduce/result.rb', line 117

def cursor_id
  0
end

#documentsArray<BSON::Document>

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 documents from the map/reduce.

Examples:

Get the documents.

result.documents

Returns:

  • (Array<BSON::Document>)

    The documents.

Since:

  • 2.0.0



59
60
61
# File 'lib/mongo/operation/map_reduce/result.rb', line 59

def documents
  reply.documents[0][RESULTS] || reply.documents[0][RESULT]
end

#successful?true, false

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:

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.

Examples:

Was the command successful?

result.successful?

Returns:

  • (true, false)

    If the command was successful.

Since:

  • 2.0.0



75
76
77
# File 'lib/mongo/operation/map_reduce/result.rb', line 75

def successful?
  !documents.nil?
end

#timeInteger

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 execution time of the map/reduce.

Examples:

Get the execution time.

result.time

Returns:

  • (Integer)

    The executing time in milliseconds.

Since:

  • 2.0.0



87
88
89
# File 'lib/mongo/operation/map_reduce/result.rb', line 87

def time
  reply.documents[0][TIME]
end

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

Examples:

Validate the result.

result.validate!

Returns:

  • (Result)

    The result if verification passed.

Raises:

Since:

  • 2.0.0



105
106
107
# File 'lib/mongo/operation/map_reduce/result.rb', line 105

def validate!
  documents.nil? ? raise_operation_failure : self
end