Sha256: 974f6f1869ce0b5cdc0fe37ee21c55859bcecd0b1a88e05cb8e8923a9ae4dcb1

Contents?: true

Size: 1.34 KB

Versions: 17

Compression:

Stored size: 1.34 KB

Contents

# encoding: utf-8
module Moped
  module ReadPreference

    # Encapsulates behaviour around a secondary read preference.
    #
    # @since 2.0.0
    class Secondary
      include Selectable

      # Get the name for the read preference on the server side.
      #
      # @example Get the name of the read preference.
      #   secondary.name
      #
      # @return [ Symbol ] :secondary.
      #
      # @since 2.0.0
      def name
        :secondary
      end

      # Select a secondary node from the cluster. If no secondary is available then
      # an exception will be raised.
      #
      # @example Read from a secondary node from the cluster.
      #   preference.with_node(cluster) do |node|
      #     node.command(ismaster: 1)
      #   end
      #
      # @note If tag sets are provided then secondary selection will need to
      #   match the provided tags.
      #
      # @param [ Cluster ] cluster The cluster of nodes to select from.
      # @param [ Proc ] block The block to execute on the node.
      #
      # @raise [ Errors::ConnectionFailure ] If no secondary node was available
      #   in the cluster.
      #
      # @return [ Object ] The result of the block.
      #
      # @since 2.0.0
      def with_node(cluster, &block)
        with_retry(cluster) do
          cluster.with_secondary(&block)
        end
      end
    end
  end
end

Version data entries

17 entries across 17 versions & 2 rubygems

Version Path
ish_lib_manager-0.0.1 test/dummy/vendor/bundle/ruby/2.3.0/bundler/gems/moped-cf817ca58a85/lib/moped/read_preference/secondary.rb
moped-2.0.7 lib/moped/read_preference/secondary.rb
moped-2.0.6 lib/moped/read_preference/secondary.rb
moped-2.0.5 lib/moped/read_preference/secondary.rb
moped-2.0.4 lib/moped/read_preference/secondary.rb
moped-2.0.3 lib/moped/read_preference/secondary.rb
moped-2.0.2 lib/moped/read_preference/secondary.rb
moped-2.0.1 lib/moped/read_preference/secondary.rb
moped-2.0.0 lib/moped/read_preference/secondary.rb
moped-2.0.0.rc2 lib/moped/read_preference/secondary.rb
moped-2.0.0.rc1 lib/moped/read_preference/secondary.rb
moped-2.0.0.beta6 lib/moped/read_preference/secondary.rb
moped-2.0.0.beta5 lib/moped/read_preference/secondary.rb
moped-2.0.0.beta4 lib/moped/read_preference/secondary.rb
moped-2.0.0.beta3 lib/moped/read_preference/secondary.rb
moped-2.0.0.beta2 lib/moped/read_preference/secondary.rb
moped-2.0.0.beta lib/moped/read_preference/secondary.rb