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

Class: Mongo::Error::ParserPrivate

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.

Class for parsing the various forms that errors can come in from MongoDB command responses.

The errors can be reported by the server in a number of ways:

• ok:0 response indicates failure. In newer servers, code, codeName and errmsg fields should be set. In older servers some may not be set.
• ok:1 response with a write concern error (writeConcernError top-level field). This indicates that the node responding successfully executed the request, but not enough other nodes successfully executed the request to satisfy the write concern.
• ok:1 response with writeErrors top-level field. This can be obtained in a bulk write but also in a non-bulk write. In a non-bulk write there should be exactly one error in the writeErrors list. The case of multiple errors is handled by BulkWrite::Result.
• ok:1 response with writeConcernErrors top-level field. This can only be obtained in a bulk write and is handled by BulkWrite::Result, not by this class.

Note that writeErrors do not have codeName fields - they just provide codes and messages. writeConcernErrors may similarly not provide code names.

Constant Summary

Constants included from SdamErrorDetection

SdamErrorDetection::NODE_RECOVERING_CODES, SdamErrorDetection::NODE_SHUTTING_DOWN_CODES, SdamErrorDetection::NOT_MASTER_CODES

Instance Attribute Summary collapse

• #code ⇒ Integer readonly private
  The error code parsed from the document.
• #code_name ⇒ String readonly private
  The error code name parsed from the document.
• #document ⇒ BSON::Document readonly private
  The returned document.
• #labels ⇒ Array readonly private
  The set of labels associated with the error.
• #message ⇒ String readonly private
  The full error message to be used in the raised exception.
• #replies ⇒ ArrayProtocol::Message readonly private
  The message replies.
• #server_message ⇒ String readonly private
  The server-returned error message parsed from the response.
• #wtimeout ⇒ Object readonly private

Class Method Summarycollapse

• .build_message(code: nil, code_name: nil, message: nil) ⇒ Object private

Instance Method Summarycollapse

• #initialize(document, replies = nil, options = nil) ⇒ Parser constructor private
  Create the new parser with the returned document.
• #write_concern_error? ⇒ true | false
  Whether the document includes a write concern error.
• #write_concern_error_code ⇒ Integer | nil
  The error code for the write concern error, if a write concern error is present and has a code.
• #write_concern_error_code_name ⇒ String | nil
  The code name for the write concern error, if a write concern error is present and has a code name.
• #write_concern_error_document ⇒ Hash | nil
  Returns the write concern error document as it was reported by the server, if any.
• #write_concern_error_labels ⇒ Array | nil private
  write concern error, if there is a write concern error present.

Methods included from SdamErrorDetection

#node_recovering?, #node_shutting_down?, #not_master?

Constructor Details

#initialize(document, replies = nil, options = nil) ⇒ Parser

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.

Create the new parser with the returned document.

In legacy mode, the code and codeName fields of the document are not examined because the status (ok: 1) is not part of the document and there is no way to distinguish successful from failed responses using the document itself, and a successful response may legitimately have { code: 123, codeName: ‘foo’ } as the contents of a user-inserted document. The legacy server versions do not fill out code nor codeName thus not reading them does not lose information.

| 122 123 124 125 126 127 128 129 130 131 | # File 'lib/mongo/error/parser.rb', line 122 def initialize(document, = nil, options = nil) @document = document || {} @replies = @options = if options options.dup else {} end.freeze parse! end | | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

Instance Attribute Details

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

Returns The error code parsed from the document.

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

Returns The error code name parsed from the document.

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

Returns The returned document.

#labels ⇒ Array

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.

Returns The set of labels associated with the error.

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

Returns The full error message to be used in the raised exception.

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.

Returns The message replies.

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

Returns The server-returned error message parsed from the response.

#wtimeout ⇒ Object

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.

Class Method Details

.build_message(code: nil, code_name: nil, message: nil) ⇒ Object

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.

Instance Method Details

#write_concern_error? ⇒ true | false

Returns Whether the document includes a write concern error. A failure may have a top level error and a write concern error or either one of the two.

#write_concern_error_code ⇒ Integer | nil

Returns The error code for the write concern error, if a write concern error is present and has a code.

#write_concern_error_code_name ⇒ String | nil

Returns The code name for the write concern error, if a write concern error is present and has a code name.

#write_concern_error_document ⇒ Hash | nil

Returns the write concern error document as it was reported by the server, if any.

#write_concern_error_labels ⇒ Array | 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.

write concern error, if there is a write concern error present.