mongo 1.12.5 → 2.0.0.beta

data/lib/mongo/cluster/topology/replica_set.rb

@@ -0,0 +1,160 @@
+# Copyright (C) 2014-2015 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 behaviour when a cluster is in replica set topology.
+      #
+      # @since 2.0.0
+      class ReplicaSet
+        include Loggable
+
+        # Constant for the replica set name configuration option.
+        #
+        # @since 2.0.0
+        REPLICA_SET_NAME = :replica_set.freeze
+
+        # @return [ Hash ] options The options.
+        attr_reader :options
+
+        # The display name for the topology.
+        #
+        # @since 2.0.0
+        NAME = 'Replica Set'.freeze
+
+        # Get the display name.
+        #
+        # @example Get the display name.
+        #   ReplicaSet.display_name
+        #
+        # @return [ String ] The display name.
+        #
+        # @since 2.0.0
+        def display_name
+          NAME
+        end
+
+        # Elect a primary server within this topology.
+        #
+        # @example Elect a primary server.
+        #   topology.elect_primary(description, servers)
+        #
+        # @param [ Server::Description ] description The description of the
+        #   elected primary.
+        # @param [ Array<Server> ] server The list of known servers to the
+        #   cluster.
+        #
+        # @return [ ReplicaSet ] The topology.
+        def elect_primary(description, servers)
+          if description.replica_set_name == replica_set_name
+            log_debug([ "Server #{description.address.to_s} elected as primary in #{replica_set_name}." ])
+            servers.each do |server|
+              if server.primary? && server.address != description.address
+                server.description.unknown!
+              end
+            end
+          else
+            log_warn([
+              "Server #{description.address.to_s} in incorrect replica set: #{description.replica_set_name}."
+            ])
+          end
+          self
+        end
+
+        # Initialize the topology with the options.
+        #
+        # @example Initialize the topology.
+        #   ReplicaSet.new(options)
+        #
+        # @param [ Hash ] options The options.
+        #
+        # @since 2.0.0
+        def initialize(options)
+          @options = options
+        end
+
+        # A replica set topology is a replica set.
+        #
+        # @example Is the topology a replica set?
+        #   ReplicaSet.replica_set?
+        #
+        # @return [ true ] Always true.
+        #
+        # @since 2.0.0
+        def replica_set?; true; end
+
+        # Get the replica set name configured for this topology.
+        #
+        # @example Get the replica set name.
+        #   topology.replica_set_name
+        #
+        # @return [ String ] The name of the configured replica set.
+        #
+        # @since 2.0.0
+        def replica_set_name
+          @replica_set_name ||= options[REPLICA_SET_NAME]
+        end
+
+        # Select appropriate servers for this topology.
+        #
+        # @example Select the servers.
+        #   ReplicaSet.servers(servers)
+        #
+        # @param [ Array<Server> ] servers The known servers.
+        #
+        # @return [ Array<Server> ] The servers in the replica set.
+        #
+        # @since 2.0.0
+        def servers(servers)
+          servers.select do |server|
+            (replica_set_name.nil? || server.replica_set_name == replica_set_name) &&
+              server.primary? || server.secondary?
+          end
+        end
+
+        # A replica set topology is not sharded.
+        #
+        # @example Is the topology sharded?
+        #   ReplicaSet.sharded?
+        #
+        # @return [ false ] Always false.
+        #
+        # @since 2.0.0
+        def sharded?; false; end
+
+        # A replica set topology is not standalone.
+        #
+        # @example Is the topology standalone?
+        #   ReplicaSet.standalone?
+        #
+        # @return [ false ] Always false.
+        #
+        # @since 2.0.0
+        def standalone?; false; end
+
+        # A replica set topology is not unknown.
+        #
+        # @example Is the topology unknown?
+        #   ReplicaSet.unknown?
+        #
+        # @return [ false ] Always false.
+        #
+        # @since 2.0.0
+        def unknown?; false; end
+      end
+    end
+  end
+end

data/lib/mongo/cluster/topology/sharded.rb

@@ -0,0 +1,132 @@
+# Copyright (C) 2014-2015 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 behaviour for when a cluster is in sharded topology.
+      #
+      # @since 2.0.0
+      class Sharded
+
+        # 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
+          NAME
+        end
+
+        # Elect a primary server within this topology.
+        #
+        # @example Elect a primary server.
+        #   topology.elect_primary(description, servers)
+        #
+        # @param [ Server::Description ] description The description of the
+        #   elected primary.
+        # @param [ Array<Server> ] server The list of known servers to the
+        #   cluster.
+        #
+        # @return [ Sharded ] The topology.
+        def elect_primary(description, servers); self; end
+
+        # Initialize the topology with the options.
+        #
+        # @example Initialize the topology.
+        #   Sharded.new(options)
+        #
+        # @param [ Hash ] options The options.
+        #
+        # @since 2.0.0
+        def initialize(options)
+          @options = options
+        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
+
+        # Sharded topologies have no replica set name.
+        #
+        # @example Get the replica set name.
+        #   sharded.replica_set_name
+        #
+        # @return [ nil ] Always nil.
+        #
+        # @since 2.0.0
+        def replica_set_name; nil; 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 standalone.
+        #
+        # @example Is the topology standalone?
+        #   Sharded.standalone?
+        #
+        # @return [ false ] Always false.
+        #
+        # @since 2.0.0
+        def standalone?; 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

data/lib/mongo/cluster/topology/standalone.rb

@@ -0,0 +1,132 @@
+# Copyright (C) 2014-2015 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 behaviour for when a cluster is in standalone topology.
+      #
+      # @since 2.0.0
+      class Standalone
+
+        # The display name for the topology.
+        #
+        # @since 2.0.0
+        NAME = 'Standalone'.freeze
+
+        # Get the display name.
+        #
+        # @example Get the display name.
+        #   Standalone.display_name
+        #
+        # @return [ String ] The display name.
+        #
+        # @since 2.0.0
+        def display_name
+          NAME
+        end
+
+        # Elect a primary server within this topology.
+        #
+        # @example Elect a primary server.
+        #   topology.elect_primary(description, servers)
+        #
+        # @param [ Server::Description ] description The description of the
+        #   elected primary.
+        # @param [ Array<Server> ] server The list of known servers to the
+        #   cluster.
+        #
+        # @return [ Standalone ] The topology.
+        def elect_primary(description, servers); self; end
+
+        # Initialize the topology with the options.
+        #
+        # @example Initialize the topology.
+        #   Standalone.new(options)
+        #
+        # @param [ Hash ] options The options.
+        #
+        # @since 2.0.0
+        def initialize(options)
+          @options = options
+        end
+
+        # A standalone 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
+
+        # Standalone topologies have no replica set name.
+        #
+        # @example Get the replica set name.
+        #   standalone.replica_set_name
+        #
+        # @return [ nil ] Always nil.
+        #
+        # @since 2.0.0
+        def replica_set_name; nil; end
+
+        # Select appropriate servers for this topology.
+        #
+        # @example Select the servers.
+        #   Standalone.servers(servers, 'test')
+        #
+        # @param [ Array<Server> ] servers The known servers.
+        #
+        # @return [ Array<Server> ] The standalone servers.
+        #
+        # @since 2.0.0
+        def servers(servers, name = nil)
+          [ servers.detect{ |server| server.standalone? } ]
+        end
+
+        # A standalone topology is not sharded.
+        #
+        # @example Is the topology sharded?
+        #   Standalone.sharded?
+        #
+        # @return [ false ] Always false.
+        #
+        # @since 2.0.0
+        def sharded?; false; end
+
+        # A standalone topology is standalone.
+        #
+        # @example Is the topology standalone?
+        #   Standalone.standalone?
+        #
+        # @return [ true ] Always true.
+        #
+        # @since 2.0.0
+        def standalone?; true; end
+
+        # An standalone topology is not unknown.
+        #
+        # @example Is the topology unknown?
+        #   Standalone.unknown?
+        #
+        # @return [ false ] Always false.
+        #
+        # @since 2.0.0
+        def unknown?; false; end
+      end
+    end
+  end
+end

data/lib/mongo/cluster/topology/unknown.rb

@@ -0,0 +1,155 @@
+# Copyright (C) 2015 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 behaviour for when a cluster is in an unknown state.
+      #
+      # @since 2.0.0
+      class Unknown
+        include Loggable
+
+        # The display name for the topology.
+        #
+        # @since 2.0.0
+        NAME = 'Unknown'.freeze
+
+        # @return [ Hash ] options The options.
+        attr_reader :options
+
+        # Get the display name.
+        #
+        # @example Get the display name.
+        #   Unknown.display_name
+        #
+        # @return [ String ] The display name.
+        #
+        # @since 2.0.0
+        def display_name
+          NAME
+        end
+
+        # Elect a primary server within this topology.
+        #
+        # @example Elect a primary server.
+        #   topology.elect_primary(description, servers)
+        #
+        # @param [ Server::Description ] description The description of the
+        #   elected primary.
+        # @param [ Array<Server> ] server The list of known servers to the
+        #   cluster.
+        #
+        # @return [ Sharded, ReplicaSet ] The new topology.
+        def elect_primary(description, servers)
+          if description.mongos?
+            log_debug([ "Mongos #{description.address.to_s} discovered." ])
+            Sharded.new(options)
+          else
+            initialize_replica_set(description, servers)
+          end
+        end
+
+        # Initialize the topology with the options.
+        #
+        # @example Initialize the topology.
+        #   Unknown.new(options)
+        #
+        # @param [ Hash ] options The options.
+        #
+        # @since 2.0.0
+        def initialize(options)
+          @options = options
+        end
+
+        # An unknown topology is not a replica set.
+        #
+        # @example Is the topology a replica set?
+        #   Unknown.replica_set?
+        #
+        # @return [ false ] Always false.
+        #
+        # @since 2.0.0
+        def replica_set?; false; end
+
+        # Unknown topologies have no replica set name.
+        #
+        # @example Get the replica set name.
+        #   unknown.replica_set_name
+        #
+        # @return [ nil ] Always nil.
+        #
+        # @since 2.0.0
+        def replica_set_name; nil; end
+
+        # Select appropriate servers for this topology.
+        #
+        # @example Select the servers.
+        #   Unknown.servers(servers)
+        #
+        # @param [ Array<Server> ] servers The known servers.
+        #
+        # @raise [ Unknown ] Cannot select servers when the topology is
+        #   unknown.
+        #
+        # @since 2.0.0
+        def servers(servers)
+        end
+
+        # An unknown topology is not sharded.
+        #
+        # @example Is the topology sharded?
+        #   Unknown.sharded?
+        #
+        # @return [ false ] Always false.
+        #
+        # @since 2.0.0
+        def sharded?; false; end
+
+        # An unknown topology is not standalone.
+        #
+        # @example Is the topology standalone?
+        #   Unknown.standalone?
+        #
+        # @return [ true ] Always false.
+        #
+        # @since 2.0.0
+        def standalone?; false; end
+
+        # An unknown topology is unknown.
+        #
+        # @example Is the topology unknown?
+        #   Unknown.unknown?
+        #
+        # @return [ true ] Always true.
+        #
+        # @since 2.0.0
+        def unknown?; true; end
+
+        private
+
+        def initialize_replica_set(description, servers)
+          log_debug([ "Server #{description.address.to_s} discovered as primary." ])
+          servers.each do |server|
+            if server.standalone? && server.address != description.address
+              server.description.unknown!
+            end
+          end
+          ReplicaSet.new(options.merge(:replica_set => description.replica_set_name))
+        end
+      end
+    end
+  end
+end