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

Module: Mongo::Error::OperationFailure::Family

Overview

Implements the behavior for an OperationFailure error. Other errors (e.g. ServerTimeoutError) may also implement this, so that they may be recognized and treated as OperationFailure errors.

Constant Summarycollapse

CHANGE_STREAM_RESUME_ERRORS =

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

Error codes and code names that should result in a failing getMore command on a change stream NOT being resumed.

[ {code_name: 'HostUnreachable', code: 6}, {code_name: 'HostNotFound', code: 7}, {code_name: 'NetworkTimeout', code: 89}, {code_name: 'ShutdownInProgress', code: 91}, {code_name: 'PrimarySteppedDown', code: 189}, {code_name: 'ExceededTimeLimit', code: 262}, {code_name: 'SocketException', code: 9001}, {code_name: 'NotMaster', code: 10107}, {code_name: 'InterruptedAtShutdown', code: 11600}, {code_name: 'InterruptedDueToReplStateChange', code: 11602}, {code_name: 'NotPrimaryNoSecondaryOk', code: 13435}, {code_name: 'NotMasterOrSecondary', code: 13436},

{code_name: 'StaleShardVersion', code: 63}, {code_name: 'FailedToSatisfyReadPreference', code: 133}, {code_name: 'StaleEpoch', code: 150}, {code_name: 'RetryChangeStream', code: 234}, {code_name: 'StaleConfig', code: 13388}, ].freeze

CHANGE_STREAM_RESUME_MESSAGES =

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

Change stream can be resumed when these error messages are encountered.

ReadWriteRetryable::WRITE_RETRY_MESSAGES

Constants included from ReadWriteRetryable

ReadWriteRetryable::RETRY_MESSAGES, ReadWriteRetryable::WRITE_RETRY_ERRORS, ReadWriteRetryable::WRITE_RETRY_MESSAGES

Constants included from SdamErrorDetection

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

Instance Attribute Summary collapse

• #code ⇒ Integer readonly
  The error code parsed from the document.
• #code_name ⇒ String readonly
  The error code name parsed from the document.
• #details ⇒ String | nil readonly
  The details of the error.
• #document ⇒ BSON::Document | nil readonly
  The server-returned error document.
• #result ⇒ Operation::Result readonly private
  The result object for the operation.
• #server_message ⇒ String readonly
  The server-returned error message parsed from the response.
• #write_concern_error_code ⇒ Integer | nil readonly
  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 readonly
  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 readonly
  Returns the write concern error document as it was reported by the server, if any.

Instance Method Summarycollapse

• #change_stream_resumable? ⇒ true, false
  Can the change stream on which this error occurred be resumed, provided the operation that triggered this error was a getMore?.
• #connection_description ⇒ Server::Description private
  Server description of the server that the operation that this exception refers to was performed on.
• #initialize(message = nil, result = nil, options = {}) ⇒ Object
  Create the operation failure.
• #max_time_ms_expired? ⇒ true | false
  Whether the error is MaxTimeMSExpired.
• #unsupported_retryable_write? ⇒ true | false
  Whether the error is caused by an attempted retryable write on a storage engine that does not support retryable writes.
• #write_concern_error? ⇒ true | false
  Whether the failure includes a write concern error.
• #wtimeout? ⇒ true | false
  Whether the error is a write concern timeout.

Methods included from ReadWriteRetryable

#retryable?, #write_retryable?

Methods included from SdamErrorDetection

#node_recovering?, #node_shutting_down?, #not_master?

Instance Attribute Details

#code ⇒ Integer

Returns The error code parsed from the document.

#code_name ⇒ String

Returns The error code name parsed from the document.

#details ⇒ String | nil

Returns The details of the error. For WriteConcernErrors this is ‘document[’errInfo’]‘. For WriteErrors this is `document[0]`. For all other errors this is nil.

#document ⇒ BSON::Document | nil

Returns The server-returned error document.

#result ⇒ Operation::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.

Returns the result object for the operation.

#server_message ⇒ String

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

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

Instance Method Details

#change_stream_resumable? ⇒ true, false

Can the change stream on which this error occurred be resumed, provided the operation that triggered this error was a getMore?

#connection_description ⇒ Server::Description

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 Server description of the server that the operation that this exception refers to was performed on.

#initialize(message = nil, result = nil, options = {}) ⇒ Object

Create the operation failure.

| 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 | # File 'lib/mongo/error/operation_failure.rb', line 187 def initialize(message = nil, result = nil, options = {}) @details = retrieve_details(options[:document]) super(append_details(message, @details)) @result = result @code = options[:code] @code_name = options[:code_name] @write_concern_error_document = options[:write_concern_error_document] @write_concern_error_code = options[:write_concern_error_code] @write_concern_error_code_name = options[:write_concern_error_code_name] @write_concern_error_labels = options[:write_concern_error_labels] || [] @labels = options[:labels] | | [] @wtimeout = !!options[:wtimeout] @document = options[:document] @server_message = options[:server_message] end | | --------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |

#max_time_ms_expired? ⇒ true | false

Whether the error is MaxTimeMSExpired.

#unsupported_retryable_write? ⇒ true | false

Whether the error is caused by an attempted retryable write on a storage engine that does not support retryable writes.

retryable write on a storage engine that does not support retryable writes.

| 229 230 231 232 233 234 | # File 'lib/mongo/error/operation_failure.rb', line 229 def unsupported_retryable_write? code == 20 && server_message&.start_with?("Transaction numbers") || false end | | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

#write_concern_error? ⇒ true | false

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

#wtimeout? ⇒ true | false

Whether the error is a write concern timeout.