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

Class: Mongo::Cluster::Topology::Sharded

Overview

Defines behavior for when a cluster is in sharded topology.

Constant Summarycollapse

NAME =

The display name for the topology.

'Sharded'.freeze

Constants included from Loggable

Loggable::PREFIX

Instance Attribute Summary

Attributes inherited from Base

#compatibility_error, #logical_session_timeout, #monitoring, #options, #server_descriptions

Attributes included from Monitoring::Publishable

#monitoring

Instance Method Summarycollapse

• #display_name ⇒ String
  Get the display name.
• #has_readable_server?(cluster, server_selector = nil) ⇒ true
  Determine if the topology would select a readable server for the provided candidates and read preference.
• #has_writable_server?(cluster) ⇒ true
  Determine if the topology would select a writable server for the provided candidates.
• #replica_set? ⇒ false
  A sharded topology is not a replica set.
• #servers(servers) ⇒ Array
  Select appropriate servers for this topology.
• #sharded? ⇒ true
  A sharded topology is sharded.
• #single? ⇒ false
  A sharded topology is not single.
• #summary ⇒ Object
• #unknown? ⇒ false
  A sharded topology is not unknown.

Methods inherited from Base

#addresses, #compatible?, #data_bearing_servers?, #initialize, #max_election_id, #max_set_version, #new_max_election_id, #new_max_set_version, #replica_set_name, #server_hosts_match_any?

Methods included from Monitoring::Publishable

#publish_cmap_event, #publish_event, #publish_sdam_event

Methods included from Loggable

#log_debug, #log_error, #log_fatal, #log_info, #log_warn, #logger

Instance Method Details

#display_name ⇒ String

#has_readable_server?(cluster, server_selector = nil) ⇒ true

Determine if the topology would select a readable server for the provided candidates and read preference.

#has_writable_server?(cluster) ⇒ true

Determine if the topology would select a writable server for the provided candidates.

#replica_set? ⇒ false

A sharded topology is not a replica set.

#servers(servers) ⇒ Array<Server>

Select appropriate servers for this topology.

| 102 103 104 | # File 'lib/mongo/cluster/topology/sharded.rb', line 102 def servers(servers) servers.select { |server| server.mongos? } end | | ----------- | -------------------------------------------------------------------------------------------------------------------------------- |

#sharded? ⇒ true

A sharded topology is sharded.

#single? ⇒ false

A sharded topology is not single.

#summary ⇒ Object

Note:

This method is experimental and subject to change.

#unknown? ⇒ false

A sharded topology is not unknown.