Class: Mongo::Operation::Commands::ParallelScan::Result

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

Overview

Defines custom behaviour of results in a parallel scan.

Since:

  • 2.0.0

Constant Summary collapse

CURSORS =

The name of the cursors field in the result.

Since:

  • 2.0.0

'cursors'.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?, #cursor_id, #each, #initialize, #inspect, #multiple?, #namespace, #ok?, #reply, #returned_count, #successful?, #validate!, #written_count

Constructor Details

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

Instance Method Details

#cursor_ids ⇒ Array<Integer>

Get all the cursor ids from the result.

Examples:

Get the cursor ids.

result.cursor_ids

Returns:

  • (Array<Integer>) —

    The cursor ids.

Since:

  • 2.0.0



39
40
41
 
# File 'lib/mongo/operation/commands/parallel_scan/result.rb', line 39

def cursor_ids
  documents.map{ |doc| doc[CURSOR][CURSOR_ID] }
end

#documents ⇒ Array<BSON::Document>

Get the documents from parallel scan.

Examples:

Get the documents.

result.documents

Returns:

  • (Array<BSON::Document>) —

    The documents.

Since:

  • 2.0.0



51
52
53
 
# File 'lib/mongo/operation/commands/parallel_scan/result.rb', line 51

def documents
  reply.documents[0][CURSORS]
end