Class: Mongo::Operation::GetMore::Result Private

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

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Defines custom behavior of results for the get more command.

Since:

  • 2.2.0

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_description, #replies

Instance Method Summary collapse

Methods inherited from Result

#acknowledged?, #cluster_time, #each, #error, #initialize, #inspect, #labels, #namespace, #ok?, #operation_time, #reply, #returned_count, #successful?, #topology_version, #validate!, #write_concern_error?, #written_count

Constructor Details

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

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.

Get the cursor id.

Examples:

Get the cursor id.

result.cursor_id

Returns:

  • (Integer) —

    The cursor id.

Since:

  • 2.2.0



32
33
34
 
# File 'lib/mongo/operation/get_more/result.rb', line 32

def cursor_id
  cursor_document ? cursor_document[CURSOR_ID] : super
end

#documents ⇒ Array<BSON::Document>

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 documents in the result.

Examples:

Get the documents.

result.documents

Returns:

  • (Array<BSON::Document>) —

    The documents.

Since:

  • 2.2.0



53
54
55
 
# File 'lib/mongo/operation/get_more/result.rb', line 53

def documents
  cursor_document[NEXT_BATCH]
end

#post_batch_resume_token ⇒ BSON::Document | nil

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 post batch resume token for the result

Returns:

  • (BSON::Document | nil) —

    The post batch resume token

Since:

  • 2.2.0



41
42
43
 
# File 'lib/mongo/operation/get_more/result.rb', line 41

def post_batch_resume_token
  cursor_document ? cursor_document['postBatchResumeToken'] : nil
end