Module: Mongo::Error::SdamErrorDetection

Included in:
OperationFailure::Family, Parser
Defined in:
lib/mongo/error/sdam_error_detection.rb

Overview

Note:

Although not_master? and node_recovering? methods of this module are part of the public API, the fact that these methods are defined on this module and not on the classes which include this module is not part of the public API.

Since:

  • 2.0.0

Constant Summary collapse

NOT_MASTER_CODES =

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.

Since:

  • 2.0.0

[10107, 13435].freeze
NODE_RECOVERING_CODES =

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.

Since:

  • 2.0.0

[11600, 11602, 13436, 189, 91, 10058].freeze
NODE_SHUTTING_DOWN_CODES =

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.

Since:

  • 2.0.0

[11600, 91].freeze

Instance Method Summary collapse

Instance Method Details

#node_recovering? ⇒ true | false

Whether the error is a “node is recovering” error, or one of its variants.

See github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-discovery-and-monitoring.rst#not-master-and-node-is-recovering.

Returns:

  • (true | false) —

    Whether the error is a node is recovering.

Since:

  • 2.8.0



53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/mongo/error/sdam_error_detection.rb', line 53

def node_recovering?
  # Require the error to be communicated at the top level of the response
  # for it to influence SDAM state. See DRIVERS-1376 / RUBY-2516.
  return false if document && document['ok'] == 1

  if code
    NODE_RECOVERING_CODES.include?(code)
  elsif message
    message.include?('node is recovering') || message.include?('not master or secondary')
  else
    false
  end
end

#node_shutting_down? ⇒ true | false

Whether the error is a “node is shutting down” type error.

See github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-discovery-and-monitoring.rst#not-master-and-node-is-recovering.

Returns:

  • (true | false) —

    Whether the error is a node is shutting down.

Since:

  • 2.9.0



74
75
76
77
78
79
80
 
# File 'lib/mongo/error/sdam_error_detection.rb', line 74

def node_shutting_down?
  if code && NODE_SHUTTING_DOWN_CODES.include?(code)
    true
  else
    false
  end
end

#not_master? ⇒ true | false

Whether the error is a “not master” error, or one of its variants.

See github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-discovery-and-monitoring.rst#not-master-and-node-is-recovering.

Returns:

  • (true | false) —

    Whether the error is a not master.

Since:

  • 2.8.0



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/mongo/error/sdam_error_detection.rb', line 30

def not_master?
  # Require the error to be communicated at the top level of the response
  # for it to influence SDAM state. See DRIVERS-1376 / RUBY-2516.
  return false if document && document['ok'] == 1

  if node_recovering?
    false
  elsif code
    NOT_MASTER_CODES.include?(code)
  elsif message
    message.include?('not master')
  else
    false
  end
end