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

Class: Mongo::Operation::ListCollections::Result

Inherits:

Result

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

Defined in:

lib/mongo/operation/list_collections/result.rb

Overview

Defines custom behavior of results when using the listCollections command.

Constant Summary

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

• #cursor_id ⇒ Integer private
  Get the cursor id for the result.
• #documents ⇒ ArrayBSON::Document
  Get the documents for the listCollections result.
• #namespace ⇒ String private
  Get the namespace for the cursor.
• #validate! ⇒ Result private
  Validate the result.

Methods inherited from Result

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

Instance Method Details

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

Note:

Even though the wire protocol has a cursor_id field for all messages of type reply, it is always zero when using the listCollections command and must be retrieved from the cursor document itself.

Get the cursor id for the result.

#documents ⇒ ArrayBSON::Document

Get the documents for the listCollections result. It is the ‘firstBatch’

field in the 'cursor' field of the first document returned.

#namespace ⇒ String

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 namespace for the cursor.

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

Validate the result. In the case where an unauthorized client tries to run the command we need to generate the proper error.