Class: Mongo::Operation::Explain::Result

Inherits:

Operation::Result

• Object
• Operation::Result
• Mongo::Operation::Explain::Result

Defined in:

lib/mongo/operation/explain/result.rb

Overview

Defines custom behavior of results in find command with explain.

Since:

• 2.5.0

Instance Method Summary

• #cursor_id ⇒ 0 private

  Get the cursor id.

• #documents ⇒ Array<BSON::Document>

  Get the documents in the result.

Instance Method Details

#cursor_id ⇒ 0

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:

• (0) —

  Always 0 because explain doesn't return a cursor.

Since:

• 2.5.0

# File 'lib/mongo/operation/explain/result.rb', line 34

def cursor_id
  0
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.5.0

# File 'lib/mongo/operation/explain/result.rb', line 47

def documents
  reply.documents
end