lib/mongo/cluster/topology/sharded.rb
# frozen_string_literal: true
# rubocop:todo all
# Copyright (C) 2014-2020 MongoDB Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
module Mongo
class Cluster
module Topology
# Defines behavior for when a cluster is in sharded topology.
#
# @since 2.0.0
class Sharded < Base
include NoReplicaSetOptions
# The display name for the topology.
#
# @since 2.0.0
NAME = 'Sharded'.freeze
# Get the display name.
#
# @example Get the display name.
# Sharded.display_name
#
# @return [ String ] The display name.
#
# @since 2.0.0
def display_name
self.class.name.gsub(/.*::/, '')
end
# @note This method is experimental and subject to change.
#
# @api experimental
# @since 2.7.0
def summary
details = server_descriptions.keys.join(',')
"#{display_name}[#{details}]"
end
# 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 Sharded cluster always has a readable server.
#
# @since 2.4.0
def has_readable_server?(cluster, server_selector = nil); true; end
# 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 Sharded cluster always has a writable server.
#
# @since 2.4.0
def has_writable_server?(cluster); true; end
# A sharded topology is not a replica set.
#
# @example Is the topology a replica set?
# Sharded.replica_set?
#
# @return [ false ] Always false.
#
# @since 2.0.0
def replica_set?; false; end
# Select appropriate servers for this topology.
#
# @example Select the servers.
# Sharded.servers(servers)
#
# @param [ Array<Server> ] servers The known servers.
#
# @return [ Array<Server> ] The mongos servers.
#
# @since 2.0.0
def servers(servers)
servers.select { |server| server.mongos? }
end
# A sharded topology is sharded.
#
# @example Is the topology sharded?
# Sharded.sharded?
#
# @return [ true ] Always true.
#
# @since 2.0.0
def sharded?; true; end
# A sharded topology is not single.
#
# @example Is the topology single?
# Sharded.single?
#
# @return [ false ] Always false.
#
# @since 2.0.0
def single?; false; end
# A sharded topology is not unknown.
#
# @example Is the topology unknown?
# Sharded.unknown?
#
# @return [ false ] Always false.
#
# @since 2.0.0
def unknown?; false; end
end
end
end
end