Class Mongo::Operation::ListCollections::Result
In: lib/mongo/operation/list_collections/result.rb
Parent: Operation::Result

Defines custom behavior of results when using the listCollections command.

@since 2.0.0

Methods

Public Instance methods

Get the cursor id for the result.

@example Get the cursor id.

  result.cursor_id

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

@return [ Integer ] The cursor id.

@since 2.0.0

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

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

@example Get the documents.

  result.documents

@return [ Array<BSON::Document> ] The documents.

@since 2.0.0

Get the namespace for the cursor.

@example Get the namespace.

  result.namespace

@return [ String ] The namespace.

@since 2.0.0

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

@example Validate the result.

  result.validate!

@return [ Result ] Self if successful.

@since 2.0.0

[Validate]