clickhouse-activerecord 1.5.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 313cad6f9f4c4887d92e8bc07b3d67c9b5e5ed2e404f3f46d0eb56dc6ff238a5
-  data.tar.gz: f63f1db5435d34e0fce894eedf473dae91a65936b5db8dcea41355636d13c206
+  metadata.gz: b247a8916fb85dbbc5392da80096fca8d2bea2f822d3e60ed96dced9395d9ebd
+  data.tar.gz: dd1ed15c3367463fdc870f5ead578a8af775b9423fe0b851a2eb5be7782e65ba
 SHA512:
-  metadata.gz: b82c4e53376baafb4c5258ae57ecc31556e72ffef45fd4ad2f4194a170ea3e48068268b09bd56c6e462ac070e0635d2e8c30af4e6cfd66ed81bd23879a428956
-  data.tar.gz: e20b6246ce0ef5f967289c832dc96649b6aa733dbb3ed27f746f9c01baa29a4dfc55bc50c527a84a3f7b96b53fb4dc4cec2f2908e70586d7d8030e97633551ae
+  metadata.gz: eddec177c686f387fc062689e472a90310a2b8a45f7e20ab416ab865cb39c8f6d52ef5f35433d435372c917ba5bbf211c9a60e00075b50ad6e7cfd7f70322291
+  data.tar.gz: acacc953e84579b76da29a1cbf29337de6bd33c72857abdc65484222f0a485b62bc5a9e2305c4c999cd4966ccc99d0c16cbf0d92434ff881d4ce572b10970f46

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+### Version 1.6.0 (Jan 19, 2026)
+
+* Support CSE (Common Scalar Expressions) in the `WITH` clause
+* Fix regex to match FROM keyword, not column names containing 'from' #220
+* Add JSON column type support #209
+* Support execute_batch #216
+* Add disconnect method to adapter #186
+* Add check_current_protected_environment! to Tasks #222
+* Do not truncate engines that cannot be truncated #226
+
 ### Version 1.5.1 (Nov 6, 2025)
 
 * Fix rake tasks

data/README.md

@@ -158,10 +158,18 @@ Structure load from `db/clickhouse_structure.sql` file:
 
 For auto truncate tables before each test add to `spec/rails_helper.rb` file:
 
-```
+```ruby
 require 'clickhouse-activerecord/rspec'
 ```
-    
+
+### Minitest
+
+For auto truncate tables before each test add to `test/test_helper.rb` file:
+
+```ruby
+require 'clickhouse-activerecord/minitest'
+```
+
 ### Insert and select data
 
 ```ruby

data/lib/active_record/connection_adapters/clickhouse/schema_creation.rb

@@ -79,7 +79,9 @@ module ActiveRecord
           # If you do not specify a database explicitly, ClickHouse will use the "default" database.
           return unless subquery
 
-          match = subquery.match(/(?<=from)[^.\w]+(?<database>\w+(?=\.))?(?<table_name>[.\w]+)/i)
+          # Match FROM as a keyword (with word boundary), not as part of a column name
+          # \b ensures we only match 'from' as a whole word
+          match = subquery.match(/\bfrom\s+(?<database>\w+(?=\.))?(?<table_name>[.\w]+)/i)
           return unless match
           return if match[:database]
 

data/lib/active_record/connection_adapters/clickhouse/schema_statements.rb

@@ -47,6 +47,12 @@ module ActiveRecord
           end
         end
 
+        def execute_batch(statements, name = nil, **kwargs)
+          statements.each do |statement|
+            execute(statement, name, **kwargs)
+          end
+        end
+
         def exec_insert(sql, name = nil, _binds = [], _pk = nil, _sequence_name = nil, returning: nil)
           new_sql = sql.sub(/ (DEFAULT )?VALUES/, " VALUES")
           with_response_format(nil) { execute(new_sql, name) }
@@ -293,6 +299,38 @@ module ActiveRecord
                         .except(*except)
                         .to_param
         end
+
+        # Returns a hash of table names to their engine types
+        def table_engines(table_names = nil)
+          table_names_sql = if table_names.present?
+            "AND name IN (#{table_names.map { |name| "'#{name}'" }.join(', ')})"
+          end
+
+          sql = <<~SQL
+            SELECT name, engine FROM system.tables
+            WHERE database = currentDatabase()
+            #{table_names_sql}
+          SQL
+
+          result = do_system_execute(sql)
+          return {} if result.nil?
+
+          result['data'].to_h { |row| [row[0], row[1]] }
+        end
+
+        # @see https://clickhouse.com/docs/sql-reference/statements/truncate
+        # Additionally add 'Dictionary' because it is returned from 'show tables'.
+        TRUNCATE_UNSUPPORTED_ENGINES = %w[View File URL Buffer Null Dictionary].freeze
+
+        def build_truncate_statements(table_names)
+          engines = table_engines(table_names)
+          tables_to_truncate = table_names.select do |table_name|
+            engine = engines[table_name]
+            engine.nil? || !TRUNCATE_UNSUPPORTED_ENGINES.include?(engine)
+          end
+
+          super(tables_to_truncate)
+        end
       end
     end
   end

data/lib/active_record/connection_adapters/clickhouse_adapter.rb

@@ -113,6 +113,8 @@ module ActiveRecord
         uint64: { name: 'UInt64' },
         # uint128: { name: 'UInt128' }, not yet implemented in clickhouse
         uint256: { name: 'UInt256' },
+
+        json: { name: 'JSON' },
       }.freeze
 
       include Clickhouse::SchemaStatements
@@ -147,6 +149,11 @@ module ActiveRecord
         connect
       end
 
+      def disconnect!
+        @connection.finish if @connection&.started?
+        super
+      end
+
       # Return ClickHouse server version
       def server_version
         @server_version ||= select_value('SELECT version()')
@@ -246,6 +253,8 @@ module ActiveRecord
           m.register_type(%r(Map)) do |sql_type|
             Clickhouse::OID::Map.new(sql_type)
           end
+
+          m.register_type %r(JSON)i, ActiveRecord::Type::Json.new
         end
       end
 

data/lib/arel/visitors/clickhouse.rb

@@ -18,6 +18,33 @@ module Arel
         end
       end
 
+      # https://clickhouse.com/docs/sql-reference/statements/select/with
+      def visit_Arel_Nodes_Cte(o, collector)
+        is_cse = o.relation.is_a?(Symbol)
+
+        if is_cse && o.name.is_a?(String)
+          collector << quote(o.name)
+        elsif is_cse && o.name.is_a?(ActiveRecord::Relation)
+          visit o.name.arel, collector
+        else
+          collector << quote_table_name(o.name)
+        end
+        collector << " AS "
+
+        case o.materialized
+        when true
+          collector << "MATERIALIZED "
+        when false
+          collector << "NOT MATERIALIZED "
+        end
+
+        if is_cse
+          collector << o.relation.to_s
+        else
+          visit o.relation, collector
+        end
+      end
+
       # https://clickhouse.com/docs/en/sql-reference/statements/delete
       # DELETE and UPDATE in ClickHouse working only without table name
       def visit_Arel_Attributes_Attribute(o, collector)

data/lib/clickhouse-activerecord/minitest.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ClickhouseActiverecord
+  module TestHelper
+    def before_setup
+      super
+      ActiveRecord::Base.configurations.configurations.select { |x| x.env_name == Rails.env && x.adapter == 'clickhouse' }.each do |config|
+        ActiveRecord::Base.establish_connection(config)
+        ActiveRecord::Base.connection.truncate_tables(*ActiveRecord::Base.connection.tables)
+      end
+    end
+  end
+end
+
+ActiveSupport::TestCase.include(ClickhouseActiverecord::TestHelper) if defined?(ActiveSupport::TestCase)

data/lib/clickhouse-activerecord/rspec.rb

@@ -4,9 +4,7 @@ RSpec.configure do |config|
   config.before do
     ActiveRecord::Base.configurations.configurations.select { |x| x.env_name == Rails.env && x.adapter == 'clickhouse' }.each do |config|
       ActiveRecord::Base.establish_connection(config)
-      ActiveRecord::Base.connection.tables.each do |table|
-        ActiveRecord::Base.connection.execute("TRUNCATE TABLE #{table}")
-      end
+      ActiveRecord::Base.connection.truncate_tables(*ActiveRecord::Base.connection.tables)
     end
   end
 end

data/lib/clickhouse-activerecord/tasks.rb

@@ -88,8 +88,34 @@ module ClickhouseActiverecord
       ActiveRecord::Migration.verbose = verbose_was
     end
 
+    def check_current_protected_environment!(db_config, migration_class = ActiveRecord::Migration)
+      with_temporary_pool(db_config, migration_class) do |pool|
+        migration_context = pool.migration_context
+        current = migration_context.current_environment
+        stored  = migration_context.last_stored_environment
+
+        if migration_context.protected_environment?
+          raise ActiveRecord::ProtectedEnvironmentError.new(stored)
+        end
+
+        if stored && stored != current
+          raise ActiveRecord::EnvironmentMismatchError.new(current: current, stored: stored)
+        end
+      rescue ActiveRecord::NoDatabaseError
+      end
+    end
+
     private
 
+    def with_temporary_pool(db_config, migration_class, clobber: false)
+      original_db_config = migration_class.connection_db_config
+      pool = migration_class.connection_handler.establish_connection(db_config, clobber: clobber)
+
+      yield pool
+    ensure
+      migration_class.connection_handler.establish_connection(original_db_config, clobber: clobber)
+    end
+
     def establish_master_connection
       establish_connection @configuration
     end

data/lib/clickhouse-activerecord/version.rb

@@ -1,3 +1,3 @@
 module ClickhouseActiverecord
-  VERSION = '1.5.1'
+  VERSION = '1.6.0'
 end

data/lib/core_extensions/active_record/relation.rb

@@ -192,6 +192,32 @@ module CoreExtensions
 
         arel
       end
+
+      def build_with_value_from_hash(hash)
+        return super if ::ActiveRecord::version >= Gem::Version.new('7.2')
+
+        # Redefine for ActiveRecord < 7.2
+        hash.map do |name, value|
+          expression =
+            case value
+            when ::Arel::Nodes::SqlLiteral then ::Arel::Nodes::Grouping.new(value)
+            when ::ActiveRecord::Relation then value.arel
+            when ::Arel::SelectManager then value
+            when Symbol then value
+            else
+              raise ArgumentError, "Unsupported argument type: `#{value}` #{value.class}"
+            end
+          ::Arel::Nodes::TableAlias.new(expression, name)
+        end
+      end
+
+      def build_with_expression_from_value(value, nested = false)
+        case value
+        when Symbol then value
+        else
+          super
+        end
+      end
     end
   end
 end

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clickhouse-activerecord
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0
 platform: ruby
 authors:
 - Sergey Odintsov
+autorequire:
 bindir: exe
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -133,6 +134,7 @@ files:
 - lib/arel/nodes/using.rb
 - lib/arel/visitors/clickhouse.rb
 - lib/clickhouse-activerecord.rb
+- lib/clickhouse-activerecord/minitest.rb
 - lib/clickhouse-activerecord/railtie.rb
 - lib/clickhouse-activerecord/rspec.rb
 - lib/clickhouse-activerecord/schema.rb
@@ -152,6 +154,7 @@ homepage: https://github.com/pnixx/clickhouse-activerecord
 licenses:
 - MIT
 metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -166,7 +169,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: ClickHouse ActiveRecord
 test_files: []