| Class | Mongo::Operation::MapReduce::Result |
| In: |
lib/mongo/operation/map_reduce/result.rb
|
| Parent: | Operation::Result |
Defines custom behavior of results for a map reduce operation.
@since 2.0.0
Get the cursor id.
@example Get the cursor id.
result.cursor_id
@return [ Integer ] Always 0 because map reduce doesn‘t return a cursor.
@since 2.5.0
If the result was a command then determine if it was considered a success.
@note If the write was unacknowledged, then this will always return
true.
@example Was the command successful?
result.successful?
@return [ true, false ] If the command was successful.
@since 2.0.0
Validate the result by checking for any errors.
@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.
@example Validate the result.
result.validate!
@raise [ Error::OperationFailure ] If an error is in the result.
@return [ Result ] The result if verification passed.
@since 2.0.0