class Mongo::Cluster::Topology::Single

Defines behavior for when a cluster is in single topology.

@since 2.0.0

Constants

NAME

The display name for the topology.

@since 2.0.0

Public Instance Methods

display_name() click to toggle source

Get the display name.

@example Get the display name.

Single.display_name

@return [ String ] The display name.

@since 2.0.0

# File lib/mongo/cluster/topology/single.rb, line 37
def display_name
  self.class.name.gsub(/.*::/, '')
end
has_readable_server?(cluster, server_selector = nil) click to toggle source

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

@example Is a readable server present?

topology.has_readable_server?(cluster, server_selector)

@param [ Cluster ] cluster The cluster. @param [ ServerSelector ] server_selector The server

selector.

@return [ true ] A standalone always has a readable server.

@since 2.4.0

# File lib/mongo/cluster/topology/single.rb, line 63
def has_readable_server?(cluster, server_selector = nil); true; end
has_writable_server?(cluster) click to toggle source

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

@example Is a writable server present?

topology.has_writable_server?(servers)

@param [ Cluster ] cluster The cluster.

@return [ true ] A standalone always has a writable server.

@since 2.4.0

# File lib/mongo/cluster/topology/single.rb, line 76
def has_writable_server?(cluster); true; end
replica_set?() click to toggle source

A single topology is not a replica set.

@example Is the topology a replica set?

Single.replica_set?

@return [ false ] Always false.

@since 2.0.0

# File lib/mongo/cluster/topology/single.rb, line 86
def replica_set?; false; end
servers(servers, name = nil) click to toggle source

Select appropriate servers for this topology.

@example Select the servers.

Single.servers(servers, 'test')

@param [ Array<Server> ] servers The known servers.

@return [ Array<Server> ] The single servers.

@since 2.0.0

# File lib/mongo/cluster/topology/single.rb, line 98
def servers(servers, name = nil)
  [ servers.detect { |server| !server.unknown? } ]
end
sharded?() click to toggle source

A single topology is not sharded.

@example Is the topology sharded?

Single.sharded?

@return [ false ] Always false.

@since 2.0.0

# File lib/mongo/cluster/topology/single.rb, line 110
def sharded?; false; end
single?() click to toggle source

A single topology is single.

@example Is the topology single?

Single.single?

@return [ true ] Always true.

@since 2.0.0

# File lib/mongo/cluster/topology/single.rb, line 120
def single?; true; end
summary() click to toggle source

@note This method is experimental and subject to change.

@api experimental @since 2.7.0

# File lib/mongo/cluster/topology/single.rb, line 45
def summary
  details = server_descriptions.keys.join(',')
  "#{display_name}[#{details}]"
end
unknown?() click to toggle source

An single topology is not unknown.

@example Is the topology unknown?

Single.unknown?

@return [ false ] Always false.

@since 2.0.0

# File lib/mongo/cluster/topology/single.rb, line 130
def unknown?; false; end

Private Instance Methods

validate_options(options, cluster) click to toggle source
# File lib/mongo/cluster/topology/single.rb, line 134
def validate_options(options, cluster)
  if cluster.servers_list.length > 1
    raise ArgumentError, 'Cannot instantiate a single topology with more than one server in the cluster'
  end

  super(options, cluster)
end