Class: Mongo::Operation::GetMore::Result
| Relationships & Source Files | |
| Super Chains via Extension / Inclusion / Inheritance | |
|
Class Chain:
self,
::Mongo::Operation::Result,
Forwardable
|
|
|
Instance Chain:
self,
::Mongo::Operation::Result,
Enumerable
|
|
| Inherits: |
Mongo::Operation::Result
|
| Defined in: | lib/mongo/operation/get_more/result.rb |
Overview
Defines custom behavior of results for the get more command.
Constant Summary
::Mongo::Operation::Result - Inherited
CURSOR, CURSOR_ID, FIRST_BATCH, N, NAMESPACE, NEXT_BATCH, OK, RESULT
Class Method Summary
::Mongo::Operation::Result - Inherited
| .new | Initialize a new result. |
Instance Attribute Summary
::Mongo::Operation::Result - Inherited
| #acknowledged? | Is the result acknowledged? |
| #connection, #connection_description, #connection_global_id, #context, | |
| #has_cursor_id? | Whether the result contains cursor_id. |
| #ok? | Check the first document’s ok field. |
| #replies, | |
| #successful? | If the result was a command then determine if it was considered a success. |
| #write_concern_error? | Whether the operation failed with a write concern error. |
| #query_failure? | |
Instance Method Summary
-
#cursor_id ⇒ Integer
Internal use only
Internal use only
Get the cursor id.
-
#documents ⇒ Array<BSON::Document>
Get the documents in the result.
-
#post_batch_resume_token ⇒ BSON::Document | nil
Internal use only
Internal use only
Get the post batch resume token for the result.
- #cursor_document private
- #first_document private
::Mongo::Operation::Result - Inherited
| #cluster_time | Get the cluster time reported in the server response. |
| #cursor_id | Get the cursor id if the response is acknowledged. |
| #documents | Get the documents in the result. |
| #each | Iterate over the documents in the replies. |
| #error | The exception instance (of Error::OperationFailure::Family) that would be raised during processing of this result. |
| #inspect | Get the pretty formatted inspection of the result. |
| #labels | Gets the set of error labels associated with the result. |
| #n | Alias for Result#written_count. |
| #namespace | Get the namespace of the cursor. |
| #operation_time | Get the operation time reported in the server response. |
| #reply | Get the reply from the result. |
| #returned_count | Get the number of documents returned by the server in this batch. |
| #snapshot_timestamp, #topology_version, | |
| #validate! | Validate the result by checking for any errors. |
| #written_count | Get the number of documents written by the server. |
| #aggregate_returned_count, #aggregate_written_count, #first_document, #operation_failure_class, #parser, | |
| #raise_operation_failure | Raises a Mongo::OperationFailure exception corresponding to the error information in this result. |
Instance Method Details
#cursor_document (private)
#cursor_id ⇒ Integer
Get the cursor id.
# File 'lib/mongo/operation/get_more/result.rb', line 37
def cursor_id cursor_document ? cursor_document[CURSOR_ID] : super end
#documents ⇒ Array<BSON::Document>
Get the documents in the result.
# File 'lib/mongo/operation/get_more/result.rb', line 59
def documents cursor_document[NEXT_BATCH] end
#first_document (private)
# File 'lib/mongo/operation/get_more/result.rb', line 69
def first_document @first_document ||= reply.documents[0] end
#post_batch_resume_token ⇒ BSON::Document | nil
Get the post batch resume token for the result
# File 'lib/mongo/operation/get_more/result.rb', line 46
def post_batch_resume_token cursor_document ? cursor_document['postBatchResumeToken'] : nil end