activerecord-turntable 3.1.0 → 4.0.0

data/lib/active_record/turntable/configuration_methods.rb

@@ -0,0 +1,26 @@
+module ActiveRecord::Turntable
+  module ConfigurationMethods
+    DEFAULT_PATH = File.dirname(File.dirname(__FILE__))
+
+    def turntable_configuration_file
+      @turntable_configuration_file ||= File.join(turntable_app_root_path, "config/turntable.yml")
+    end
+    alias_method :turntable_config_file, :turntable_configuration_file
+    deprecate turntable_config_file: "use turntable_configuration_file instead", deprecator: ActiveRecord::Turntable::Deprecation.instance
+
+    def turntable_configuration_file=(filename)
+      @turntable_configuration_file = filename
+    end
+    alias_method :turntable_config_file=, :turntable_configuration_file=
+    deprecate "turntable_config_file=": "use turntable_configuration_file= instead", deprecator: ActiveRecord::Turntable::Deprecation.instance
+
+    def turntable_app_root_path
+      defined?(::Rails.root) ? ::Rails.root.to_s : DEFAULT_PATH
+    end
+
+    def turntable_config
+      turntable_configuration
+    end
+    deprecate turntable_config: "use turntable_configuration instead", deprecator: ActiveRecord::Turntable::Deprecation.instance
+  end
+end

data/lib/active_record/turntable/connection_proxy.rb

@@ -7,14 +7,13 @@ module ActiveRecord::Turntable
     # for expiring query cache
     CLEAR_CACHE_METHODS = [:update, :insert, :delete, :exec_insert, :exec_update, :exec_delete, :insert_many].freeze
 
-    attr_reader :klass
+    attr_reader :klass, :default_shard, :default_current_shard
     attr_writer :spec
 
-    def initialize(klass, cluster, options = {})
-      @klass   = klass
-      @cluster = cluster
-      @master_shard = MasterShard.new(klass)
-      @default_current_shard = @master_shard
+    def initialize(klass, options = {})
+      @klass = klass
+      @default_shard = DefaultShard.new(klass)
+      @default_current_shard = @default_shard
       @mixer = ActiveRecord::Turntable::Mixer.new(self)
     end
 
@@ -26,10 +25,16 @@ module ActiveRecord::Turntable
              :change_column, :change_column_default, :rename_column, :add_index,
              :remove_index, :initialize_schema_information,
              :dump_schema_information, :execute_ignore_duplicate,
-             :query_cache_enabled, to: :master_connection
+             :query_cache_enabled, to: :default_connection
+
+    def cluster
+      klass.turntable_cluster
+    end
 
     def transaction(options = {}, &block)
-      connection.transaction(options, &block)
+      with_master {
+        connection.transaction(options, &block)
+      }
     end
 
     def cache
@@ -52,7 +57,7 @@ module ActiveRecord::Turntable
     end
 
     def enable_query_cache!
-      master_connection.enable_query_cache!
+      default_connection.enable_query_cache!
 
       klass.turntable_connections.each do |_k, v|
         v.connection.enable_query_cache!
@@ -60,7 +65,7 @@ module ActiveRecord::Turntable
     end
 
     def disable_query_cache!
-      master_connection.disable_query_cache!
+      default_connection.disable_query_cache!
 
       klass.turntable_connections.each do |_k, v|
         v.connection.disable_query_cache!
@@ -72,7 +77,7 @@ module ActiveRecord::Turntable
     end
 
     def clear_query_cache
-      master_connection.clear_query_cache
+      default_connection.clear_query_cache
 
       klass.turntable_connections.each do |_k, v|
         v.connection.clear_query_cache
@@ -104,13 +109,11 @@ module ActiveRecord::Turntable
     end
 
     def to_sql(arel, binds = [])
-      master.connection.to_sql(arel, binds)
+      default_connection.to_sql(arel, binds)
     end
 
-    attr_reader :cluster
-
     def shards
-      @cluster.shards
+      cluster.shards
     end
 
     def shard_fixed?
@@ -125,16 +128,8 @@ module ActiveRecord::Turntable
       fixed_shard_entry[object_id] = shard
     end
 
-    def master
-      @master_shard
-    end
-
-    def master_connection
-      master.connection
-    end
-
-    def seq
-      @cluster.seq || master
+    def default_connection
+      default_shard.connection
     end
 
     def current_shard
@@ -176,7 +171,7 @@ module ActiveRecord::Turntable
     end
 
     def with_recursive_shards(connection_name, *klasses, &block)
-      with_shard(shards[connection_name]) do
+      with_shard(cluster.shard_registry[connection_name]) do
         if klasses.blank?
           yield
         else
@@ -186,10 +181,26 @@ module ActiveRecord::Turntable
       end
     end
 
+    def with_master
+      old = cluster.slave_enabled?
+      cluster.set_slave_enabled(false)
+      yield
+    ensure
+      cluster.set_slave_enabled(old)
+    end
+
+    def with_slave
+      old = cluster.slave_enabled?
+      cluster.set_slave_enabled(true)
+      yield
+    ensure
+      cluster.set_slave_enabled(old)
+    end
+
     # Send queries to all shards in this cluster
     # @param [Boolean] continue_on_error when a shard raises error, ignore exception and continue
     def with_all(continue_on_error = false)
-      @cluster.shards.values.map do |shard|
+      cluster.shards.map do |shard|
         begin
           with_shard(shard) {
             yield
@@ -203,10 +214,10 @@ module ActiveRecord::Turntable
       end
     end
 
-    # Send queries to master connection and all shards in this cluster
+    # Send queries to default connection and all shards in this cluster
     # @param [Boolean] continue_on_error when a shard raises error, ignore exception and continue
-    def with_master_and_all(continue_on_error = false)
-      ([master] + @cluster.shards.values).map do |shard|
+    def with_default_and_all(continue_on_error = false)
+      ([default_shard] + cluster.shards).map do |shard|
         begin
           with_shard(shard) {
             yield
@@ -220,8 +231,8 @@ module ActiveRecord::Turntable
       end
     end
 
-    def with_master(&block)
-      with_shard(master) do
+    def with_default_shard(&block)
+      with_shard(default_shard) do
         yield
       end
     end
@@ -231,13 +242,13 @@ module ActiveRecord::Turntable
 
     %w(columns columns_hash column_defaults primary_keys).each do |name|
       define_method(name.to_sym) do
-        master.connection_pool.send(name.to_sym)
+        default_shard.connection_pool.send(name.to_sym)
       end
     end
 
     %w(data_source_exists?).each do |name|
       define_method(name.to_sym) do |*args|
-        master.connection_pool.with_connection do |c|
+        default_shard.connection_pool.with_connection do |c|
           c.schema_cache.send(name.to_sym, *args)
         end
       end
@@ -245,26 +256,26 @@ module ActiveRecord::Turntable
 
     def columns(*args)
       if args.size > 0
-        master.connection_pool.columns[*args]
+        default_shard.connection_pool.columns[*args]
       else
-        master.connection_pool.columns
+        default_shard.connection_pool.columns
       end
     end
 
     def pk_and_sequence_for(*args)
-      master.connection.send(:pk_and_sequence_for, *args)
+      default_shard.connection.send(:pk_and_sequence_for, *args)
     end
 
     def primary_key(*args)
-      master.connection.send(:primary_key, *args)
+      default_shard.connection.send(:primary_key, *args)
     end
 
     def supports_views?(*args)
-      master.connection.send(:supports_views?, *args)
+      default_shard.connection.send(:supports_views?, *args)
     end
 
     def spec
-      @spec ||= master.connection_pool.spec
+      @spec ||= default_shard.connection_pool.spec
     end
 
     private

data/lib/active_record/turntable/{master_shard.rb → default_shard.rb}

@@ -1,8 +1,8 @@
 module ActiveRecord::Turntable
-  class MasterShard < Shard
+  class DefaultShard < Shard
     def initialize(klass)
       (klass and original_connection_pool(klass)) or
-        raise MasterShardNotConnected, "connection_pool is nil"
+        raise DefaultShardNotConnected, "connection_pool is nil"
       @klass = klass
       @name  = "master"
     end
@@ -16,6 +16,10 @@ module ActiveRecord::Turntable
       end
     end
 
+    def support_slave?
+      false
+    end
+
     private
 
       def original_connection_pool(klass = @klass)

data/lib/active_record/turntable/deprecation.rb

@@ -0,0 +1,8 @@
+module ActiveRecord::Turntable
+  class Deprecation < ActiveSupport::Deprecation
+    def initialize(deprecation_horizon = "4.1",
+                   gem_name = "activerecord-turntable")
+      super
+    end
+  end
+end

data/lib/active_record/turntable/error.rb

@@ -2,6 +2,7 @@ module ActiveRecord::Turntable
   class TurntableError < StandardError; end
   class SequenceNotFoundError < TurntableError; end
   class CannotSpecifyShardError < TurntableError; end
-  class MasterShardNotConnected < TurntableError; end
+  class DefaultShardNotConnected < TurntableError; end
   class UnknownOperatorError < TurntableError; end
+  class InvalidConfigurationError < TurntableError; end
 end

data/lib/active_record/turntable/migration.rb

@@ -12,17 +12,13 @@ module ActiveRecord::Turntable::Migration
 
   module ShardDefinition
     def clusters(*cluster_names)
-      config = ActiveRecord::Base.turntable_config
+      config = ActiveRecord::Base.turntable_configuration
       (self.target_shards ||= []).concat(
         if cluster_names.first == :all
-          config[:clusters].map do |_name, cluster_conf|
-            cluster_conf[:shards].map { |shard| shard[:connection] }
-          end
+          config.clusters.map(&:shards).flatten
         else
           cluster_names.map do |cluster_name|
-            config[:clusters][cluster_name][:shards].map do |shard|
-              shard[:connection]
-            end
+            config.cluster(cluster_name).shards
           end.flatten
         end
       )

data/lib/active_record/turntable/mixer.rb

@@ -43,9 +43,9 @@ module ActiveRecord::Turntable
       when SQLTree::Node::InsertQuery
         build_insert_fader(tree, method, query, *args, &block)
       else
-        # send to master shard
+        # send to default shard
         Fader::SpecifiedShard.new(@proxy,
-                                  { @proxy.master => query },
+                                  { @proxy.default_shard => query },
                                   method, query, *args, &block)
       end
     rescue Exception => err
@@ -119,7 +119,7 @@ module ActiveRecord::Turntable
         query = sql.is_a?(String) ? sql : @proxy.to_sql(sql, binds)
         if query.include?("\0") && binds.is_a?(Array) && binds[0].is_a?(Array) && binds[0][0].is_a?(ActiveRecord::ConnectionAdapters::Column)
           binds = binds.dup
-          query.gsub("\0") { @proxy.master.connection.quote(*binds.shift.reverse) }
+          query.gsub("\0") { @proxy.default_shard.connection.quote(*binds.shift.reverse) }
         else
           query
         end
@@ -144,7 +144,7 @@ module ActiveRecord::Turntable
         elsif SQLTree::Node::SelectDeclaration === tree.select.first &&
               tree.select.first.to_sql == '1 AS "one"' # for `SELECT 1 AS one` (AR::Base.exists?)
           return Fader::SelectShardsMergeResult.new(@proxy,
-                                                    build_shards_with_same_query(@proxy.shards.values, query),
+                                                    build_shards_with_same_query(@proxy.shards, query),
                                                     method, query, *args, &block)
         elsif tree.group_by || tree.order_by || tree.limit.try(:value).to_i > 0
           raise CannotSpecifyShardError, "cannot specify shard for query: #{tree.to_sql}"
@@ -152,7 +152,7 @@ module ActiveRecord::Turntable
           if SQLTree::Node::SelectDeclaration === tree.select.first &&
              SQLTree::Node::CountAggregrate === tree.select.first.expression
             return Fader::CalculateShardsSumResult.new(@proxy,
-                                                       build_shards_with_same_query(@proxy.shards.values, query),
+                                                       build_shards_with_same_query(@proxy.shards, query),
                                                        method, query, *args, &block)
           else
             return Fader::SelectShardsMergeResult.new(@proxy,
@@ -167,7 +167,7 @@ module ActiveRecord::Turntable
               raise CannotSpecifyShardError, "[Performance Notice] PLEASE FIX: #{tree.to_sql}"
             end
             return Fader::CalculateShardsSumResult.new(@proxy,
-                                                       build_shards_with_same_query(@proxy.shards.values, query),
+                                                       build_shards_with_same_query(@proxy.shards, query),
                                                        method, query, *args, &block)
           elsif SQLTree::Node::AllFieldsDeclaration === tree.select.first ||
                 SQLTree::Node::Expression::Value === tree.select.first.expression ||
@@ -177,7 +177,7 @@ module ActiveRecord::Turntable
               raise CannotSpecifyShardError, "[Performance Notice] PLEASE FIX: #{tree.to_sql}"
             end
             return Fader::SelectShardsMergeResult.new(@proxy,
-                                                      build_shards_with_same_query(@proxy.shards.values, query),
+                                                      build_shards_with_same_query(@proxy.shards, query),
                                                       method, query, *args, &block)
           else
             raise CannotSpecifyShardError, "cannot specify shard for query: #{tree.to_sql}"
@@ -190,7 +190,7 @@ module ActiveRecord::Turntable
         shards_with_query = if shard_keys.present?
                               build_shards_with_same_query(shard_keys.map { |k| @proxy.cluster.shard_for(k) }, query)
                             else
-                              build_shards_with_same_query(@proxy.shards.values, query)
+                              build_shards_with_same_query(@proxy.shards, query)
                             end
 
         if shards_with_query.size == 1
@@ -223,11 +223,11 @@ module ActiveRecord::Turntable
       end
 
       def raise_on_not_specified_shard_query?
-        ActiveRecord::Base.turntable_config[:raise_on_not_specified_shard_query]
+        ActiveRecord::Base.turntable_configuration.raise_on_not_specified_shard_query
       end
 
       def raise_on_not_specified_shard_update?
-        ActiveRecord::Base.turntable_config[:raise_on_not_specified_shard_update]
+        ActiveRecord::Base.turntable_configuration.raise_on_not_specified_shard_update
       end
   end
 end

data/lib/active_record/turntable/mixer/fader.rb

@@ -11,7 +11,7 @@ module ActiveRecord::Turntable
         autoload :SelectShardsMergeResult
         autoload :InsertShardsMergeResult
         autoload :UpdateShardsMergeResult
-        # calcurations
+        # calculations
         autoload :CalculateShardsSumResult
       end
 

data/lib/active_record/turntable/pool_proxy.rb

@@ -46,9 +46,11 @@ module ActiveRecord::Turntable
 
       def connection_pools_list
         pools = []
-        pools << proxy.master.connection_pool
-        pools << proxy.seq.try(:connection_pool) if proxy.respond_to?(:seq)
-        pools.concat(proxy.shards.values.map(&:connection_pool))
+        pools << proxy.default_shard.connection_pool
+        if proxy.respond_to?(:sequencers)
+          pools.concat proxy.cluster.sequencers.values.map { |s| s.try(:connection_pool) }.compact
+        end
+        pools.concat(proxy.cluster.shards.map(&:connection_pool))
         pools.compact
       end
   end

data/lib/active_record/turntable/railtie.rb

@@ -13,12 +13,19 @@ module ActiveRecord::Turntable
     end
 
     # initialize
-    initializer "turntable.initialize_clusters" do
+    initializer "turntable.initialize_clusters" do |app|
+      app.paths.add "config/turntable", with: "config/turntable.rb"
+      app.paths.add "config/turntable", with: "config/turntable.yml"
+
       ActiveSupport.on_load(:active_record) do
-        if File.exist?(ActiveRecord::Base.turntable_config_file)
-          ActiveRecord::Turntable::Config.load!
+        path = app.paths["config/turntable"].existent.first
+        self.turntable_configuration_file = path
+
+        if path
+          reset_turntable_configuration(Configuration.load(turntable_configuration_file, Rails.env))
         else
-          warn("[activerecord-turntable] config/turntable.yml is not found. skipped initliazing cluster.")
+          # FIXME: suppress this warning during rails g turntable:install
+          warn("[activerecord-turntable] config/turntable.{rb,yml} is not found. skipped initliazing cluster.")
         end
       end
     end

data/lib/active_record/turntable/seq_shard.rb

@@ -1,5 +1,13 @@
 module ActiveRecord::Turntable
   class SeqShard < Shard
+    def initialize(name = defined?(Rails) ? Rails.env : "development")
+      super(nil, name)
+    end
+
+    def support_slave?
+      false
+    end
+
     private
 
       def create_connection_class
@@ -8,14 +16,5 @@ module ActiveRecord::Turntable
         klass.establish_connection ActiveRecord::Base.connection_pool.spec.config[:seq][name].with_indifferent_access
         klass
       end
-
-      def retrieve_connection_pool
-        ActiveRecord::Base.turntable_connections[name] ||=
-          begin
-            config = ActiveRecord::Base.configurations[Rails.env]["seq"][name]
-            raise ArgumentError, "Unknown database config: #{name}, have #{ActiveRecord::Base.configurations.inspect}" unless config
-            ActiveRecord::ConnectionAdapters::ConnectionPool.new(spec_for(config))
-          end
-      end
   end
 end