clickhouse-activerecord 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd5f6e3d161c6a71abcbafb000b06a3bf0637c07f451bd410c06f9d25fe20901
-  data.tar.gz: e4ba690507249b3a5d9d1a975b5cc3c7d0bfa6018f5744b84f2a382be3bcd996
+  metadata.gz: b8c5d0d360ba85375ca8f11600f5a6c3e37cd24504ede6255dbced8e3652319b
+  data.tar.gz: d2491e138a661eeb1c9952064e55125eed84f61fdebab88279e3ba73d881d19f
 SHA512:
-  metadata.gz: 3fdc2f20d8540d9599bf6281d19b8408022575d5a6648caaff55337e039bc6538c8da95004f9ab9eea74bd438c514d7907b25cd7ddd58d5f134fbc1ff77732eb
-  data.tar.gz: 45d9da6d58a53e614d2966bfcf0b7db575dce2e8afab6bfdc8cb0f4853ca977a6bfd15e43f767bcce934dbfea371921abc0215f0fdf304661961c58d499bde4a
+  metadata.gz: 3904eff8d2ff017cdb2572483baa5e201e8280799a4ab8753e5545ac27795365bec5174b183b2128cdbe7c8cf075c935f9d9f0b83045c5569db397a22ece8ad7
+  data.tar.gz: 80aed33044ca6ebf12280f352e41584a7c9582f7e934f44370a49148ad292a3af499f2d5132621142756fd384cea51111c59bed8f4a188539ed80b552befba7e

data/.docker/clickhouse/cluster/server1_config.xml

@@ -15,15 +15,16 @@
   <tmp_path>/var/lib/clickhouse/tmp/</tmp_path>
   <user_files_path>/var/lib/clickhouse/user_files/</user_files_path>
   <access_control_path>/var/lib/clickhouse/access/</access_control_path>
+  <format_schema_path>/var/lib/clickhouse/format_schemas/</format_schema_path>
   <keep_alive_timeout>3</keep_alive_timeout>
 
   <logger>
-    <level>debug</level>
+    <level>error</level>
     <log>/var/log/clickhouse-server/clickhouse-server.log</log>
     <errorlog>/var/log/clickhouse-server/clickhouse-server.err.log</errorlog>
     <size>1000M</size>
     <count>10</count>
-    <console>1</console>
+    <console>0</console>
   </logger>
 
   <remote_servers>
@@ -114,4 +115,11 @@
       <value>86400</value>
     </header>
   </http_options_response>
+
+  <user_directories>
+    <users_xml>
+      <path>users.xml</path>
+    </users_xml>
+  </user_directories>
+
 </clickhouse>

data/.docker/clickhouse/cluster/server2_config.xml

@@ -15,15 +15,16 @@
   <tmp_path>/var/lib/clickhouse/tmp/</tmp_path>
   <user_files_path>/var/lib/clickhouse/user_files/</user_files_path>
   <access_control_path>/var/lib/clickhouse/access/</access_control_path>
+  <format_schema_path>/var/lib/clickhouse/format_schemas/</format_schema_path>
   <keep_alive_timeout>3</keep_alive_timeout>
 
   <logger>
-    <level>debug</level>
+    <level>error</level>
     <log>/var/log/clickhouse-server/clickhouse-server.log</log>
     <errorlog>/var/log/clickhouse-server/clickhouse-server.err.log</errorlog>
     <size>1000M</size>
     <count>10</count>
-    <console>1</console>
+    <console>0</console>
   </logger>
 
   <remote_servers>
@@ -114,4 +115,11 @@
       <value>86400</value>
     </header>
   </http_options_response>
+
+  <user_directories>
+    <users_xml>
+      <path>users.xml</path>
+    </users_xml>
+  </user_directories>
+
 </clickhouse>

data/.docker/clickhouse/single/config.xml

@@ -14,15 +14,16 @@
   <tmp_path>/var/lib/clickhouse/tmp/</tmp_path>
   <user_files_path>/var/lib/clickhouse/user_files/</user_files_path>
   <access_control_path>/var/lib/clickhouse/access/</access_control_path>
+  <format_schema_path>/var/lib/clickhouse/format_schemas/</format_schema_path>
   <keep_alive_timeout>3</keep_alive_timeout>
 
   <logger>
-    <level>debug</level>
+    <level>error</level>
     <log>/var/log/clickhouse-server/clickhouse-server.log</log>
     <errorlog>/var/log/clickhouse-server/clickhouse-server.err.log</errorlog>
     <size>1000M</size>
     <count>10</count>
-    <console>1</console>
+    <console>0</console>
   </logger>
 
   <query_log>
@@ -51,4 +52,10 @@
     </header>
   </http_options_response>
 
+  <user_directories>
+    <users_xml>
+      <path>users.xml</path>
+    </users_xml>
+  </user_directories>
+
 </clickhouse>

data/.docker/clickhouse/users.xml

@@ -8,8 +8,17 @@
   </profiles>
 
   <users>
+    <test>
+      <password>test</password>
+      <networks>
+        <ip>::/0</ip>
+      </networks>
+      <profile>default</profile>
+      <quota>default</quota>
+      <access_management>1</access_management>
+    </test>
     <default>
-      <password></password>
+      <password />
       <networks>
         <ip>::/0</ip>
       </networks>

data/.docker/docker-compose.cluster.yml

@@ -1,6 +1,6 @@
 services:
   clickhouse1:
-    image: 'clickhouse/clickhouse-server:${CLICKHOUSE_VERSION-23.11-alpine}'
+    image: 'clickhouse/clickhouse-server:${CLICKHOUSE_VERSION}'
     ulimits:
       nofile:
         soft: 262144
@@ -18,7 +18,7 @@ services:
       interval: 5s
 
   clickhouse2:
-    image: 'clickhouse/clickhouse-server:${CLICKHOUSE_VERSION-23.11-alpine}'
+    image: 'clickhouse/clickhouse-server:${CLICKHOUSE_VERSION}'
     ulimits:
       nofile:
         soft: 262144

data/.docker/docker-compose.yml

@@ -1,6 +1,6 @@
 services:
   clickhouse:
-    image: 'clickhouse/clickhouse-server:${CLICKHOUSE_VERSION-23.11-alpine}'
+    image: 'clickhouse/clickhouse-server:${CLICKHOUSE_VERSION}'
     container_name: 'clickhouse-activerecord-clickhouse-server'
     ports:
       - '18123:8123'

data/.github/workflows/testing.yml

@@ -14,6 +14,8 @@ jobs:
     env:
       CLICKHOUSE_PORT: 18123
       CLICKHOUSE_DATABASE: default
+      CLICKHOUSE_USER: test
+      CLICKHOUSE_PASSWORD: test
 
     strategy:
       fail-fast: true
@@ -22,21 +24,21 @@ jobs:
         version:
           - ruby: 2.7
             rails: 7.1.3
-          - ruby: 3.0
-            rails: 7.1.3
           - ruby: 3.2
             rails: 7.1.3
           - ruby: 3.2
             rails: 7.2.1
           - ruby: 3.2
             rails: 8.0.1
-        clickhouse: [ '22.1', '24.9' ]
+          - ruby: 3.2
+            rails: 8.1
+        clickhouse: [ '24.9', '25.10' ]
 
     steps:
       - uses: actions/checkout@v4
 
       - name: Start ClickHouse ${{ matrix.clickhouse }}
-        uses: hoverkraft-tech/compose-action@v2.1.0
+        uses: hoverkraft-tech/compose-action@v2.4.1
         env:
           CLICKHOUSE_VERSION: ${{ matrix.clickhouse }}
         with:
@@ -61,6 +63,8 @@ jobs:
       CLICKHOUSE_PORT: 28123
       CLICKHOUSE_DATABASE: default
       CLICKHOUSE_CLUSTER: test_cluster
+      CLICKHOUSE_USER: test
+      CLICKHOUSE_PASSWORD: test
 
     strategy:
       fail-fast: true
@@ -69,21 +73,21 @@ jobs:
         version:
           - ruby: 2.7
             rails: 7.1.3
-          - ruby: 3.0
-            rails: 7.1.3
           - ruby: 3.2
             rails: 7.1.3
           - ruby: 3.2
             rails: 7.2.1
           - ruby: 3.2
             rails: 8.0.1
-        clickhouse: [ '22.1', '24.9' ]
+          - ruby: 3.2
+            rails: 8.1
+        clickhouse: [ '24.9', '25.10' ]
 
     steps:
       - uses: actions/checkout@v4
 
       - name: Start ClickHouse Cluster ${{ matrix.clickhouse }}
-        uses: hoverkraft-tech/compose-action@v2.1.0
+        uses: hoverkraft-tech/compose-action@v2.4.1
         env:
           CLICKHOUSE_VERSION: ${{ matrix.clickhouse }}
         with:

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### Version 1.5.0 (Nov 5, 2025)
+
+* 🎉 Support for Rails 8.1
+* Fix sql structure dump with `schema_migrations` #138
+* Remove old tasks
+
 ### Version 1.4.0 (Sep 18, 2025)
 
 * `CREATE OR REPLACE FUNCTION` in SQL schema dumps in #198

data/README.md

@@ -285,10 +285,10 @@ Engines `MergeTree` and all support replication engines will be replaced to `Rep
 
 Donations to this project are going directly to [PNixx](https://github.com/PNixx), the original author of this project:
 
-* BTC address: `1H3rhpf7WEF5JmMZ3PVFMQc7Hm29THgUfN`
+* BTC address: `bc1qr73vls0kv2ujk4ugqmpqj6j0qtqvdr3nx25xdl`
 * ETH address: `0x6F094365A70fe7836A633d2eE80A1FA9758234d5`
 * XMR address: `42gP71qLB5M43RuDnrQ3vSJFFxis9Kw9VMURhpx9NLQRRwNvaZRjm2TFojAMC8Fk1BQhZNKyWhoyJSn5Ak9kppgZPjE17Zh`
-* TON address: `UQBt0-s1igIpJoEup0B1yAUkZ56rzbpruuAjNhQ26MVCaNlC`
+* TON address: `UQBCnxOfBsHPZ3PesGgMedVMEf5UHnm0jrSq-042pMWw08Ux`
 
 ## Development
 

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

@@ -5,7 +5,7 @@ module ActiveRecord
 
         attr_reader :codec
 
-        def initialize(name, default, sql_type_metadata = nil, null = true, default_function = nil, codec: nil, **args)
+        def initialize(*, codec: nil, **)
           super
           @codec = codec
         end

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

@@ -43,7 +43,12 @@ module ActiveRecord
             sql.gsub!(/\s+(.*)/, " \\1 CODEC(#{options[:codec]})")
           end
           sql.gsub!(/(\sString)\(\d+\)/, '\1')
-          sql << " DEFAULT #{quote_default_expression(options[:default], options[:column])}" if options_include_default?(options)
+
+          if ::ActiveRecord::version >= Gem::Version.new('8.1')
+            sql << " DEFAULT #{quote_default_expression_for_column_definition(options[:default], options[:column])}" if options_include_default?(options)
+          else
+            sql << " DEFAULT #{quote_default_expression(options[:default], options[:column])}" if options_include_default?(options)
+          end
           sql
         end
 

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

@@ -228,15 +228,20 @@ module ActiveRecord
         end
 
         def new_column_from_field(table_name, field, _definitions)
-          sql_type = field[1]
+          column_name, sql_type, default_type, default_expression = field
           type_metadata = fetch_type_metadata(sql_type)
-          default_value = extract_value_from_default(field[3], field[2])
-          default_function = extract_default_function(field[3])
-          default_value = lookup_cast_type(sql_type).cast(default_value)
-          Clickhouse::Column.new(field[0], default_value, type_metadata, field[1].include?('Nullable'), default_function, codec: field[5].presence)
+          default_value = extract_value_from_default(default_expression, default_type)
+          default_function = extract_default_function(default_expression)
+          cast_type = lookup_cast_type(sql_type)
+          default_value = cast_type.cast(default_value)
+
+          args = [column_name]
+          args << cast_type if ::ActiveRecord::version >= Gem::Version.new('8.1')
+          args += [default_value, type_metadata, field[1].include?('Nullable'), default_function]
+
+          Clickhouse::Column.new(*args, codec: field[5].presence)
         end
 
-        # Extracts the value from a PostgreSQL column default definition.
         def extract_value_from_default(default_expression, default_type)
           return nil if default_type != 'DEFAULT' || default_expression.blank?
           return nil if has_default_function?(default_expression)

data/lib/clickhouse-activerecord/tasks.rb

@@ -39,7 +39,6 @@ module ClickhouseActiverecord
 
       # get all tables
       tables = connection.execute("SHOW TABLES FROM #{@configuration.database} WHERE name NOT LIKE '.inner_id.%'")['data'].flatten.map do |table|
-        next if %w[schema_migrations ar_internal_metadata].include?(table)
         connection.show_create_table(table, single_line: false).gsub("#{@configuration.database}.", '')
       end.compact
 

data/lib/clickhouse-activerecord/version.rb

@@ -1,3 +1,3 @@
 module ClickhouseActiverecord
-  VERSION = '1.4.0'
+  VERSION = '1.5.0'
 end

data/lib/core_extensions/active_record/relation.rb

@@ -176,7 +176,9 @@ module CoreExtensions
       end
 
       def build_arel(connection_or_aliases = nil, aliases = nil)
-        if ::ActiveRecord::version >= Gem::Version.new('7.2')
+        requirement = Gem::Requirement.new('>= 7.2', '< 8.1')
+
+        if requirement.satisfied_by?(::ActiveRecord::version)
           arel = super
         else
           arel = super(connection_or_aliases)

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: clickhouse-activerecord
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Sergey Odintsov
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-09-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -149,12 +148,10 @@ files:
 - lib/core_extensions/arel/select_manager.rb
 - lib/core_extensions/arel/table.rb
 - lib/generators/clickhouse_migration_generator.rb
-- lib/tasks/clickhouse.rake
 homepage: https://github.com/pnixx/clickhouse-activerecord
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -169,8 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: ClickHouse ActiveRecord
 test_files: []

data/lib/tasks/clickhouse.rake

@@ -1,90 +0,0 @@
-# frozen_string_literal: true
-
-namespace :clickhouse do
-  task prepare_schema_migration_table: :environment do
-    connection = ActiveRecord::Tasks::DatabaseTasks.migration_connection
-    connection.schema_migration.create_table unless ENV['simple'] || ARGV.any? { |a| a.include?('--simple') }
-  end
-
-  task prepare_internal_metadata_table: :environment do
-    connection = ActiveRecord::Tasks::DatabaseTasks.migration_connection
-    connection.internal_metadata.create_table unless ENV['simple'] || ARGV.any? { |a| a.include?('--simple') }
-  end
-
-  namespace :schema do
-    # TODO: deprecated
-    desc 'Load database schema'
-    task load: %i[prepare_internal_metadata_table] do
-      puts 'Warning: `rake clickhouse:schema:load` is deprecated! Use `rake db:schema:load:clickhouse` instead'
-      simple = ENV['simple'] || ARGV.any? { |a| a.include?('--simple') } ? '_simple' : nil
-      ActiveRecord::Base.establish_connection(:clickhouse)
-      connection = ActiveRecord::Tasks::DatabaseTasks.migration_connection
-      connection.schema_migration.drop_table
-      load(Rails.root.join("db/clickhouse_schema#{simple}.rb"))
-    end
-
-    # TODO: deprecated
-    desc 'Dump database schema'
-    task dump: :environment do |_, args|
-      puts 'Warning: `rake clickhouse:schema:dump` is deprecated! Use `rake db:schema:dump:clickhouse` instead'
-      simple = ENV['simple'] || args[:simple] || ARGV.any? { |a| a.include?('--simple') } ? '_simple' : nil
-      filename = Rails.root.join("db/clickhouse_schema#{simple}.rb")
-      File.open(filename, 'w:utf-8') do |file|
-        ActiveRecord::Base.establish_connection(:clickhouse)
-        ClickhouseActiverecord::SchemaDumper.dump(ActiveRecord::Base.connection, file, ActiveRecord::Base, simple.present?)
-      end
-    end
-  end
-
-  namespace :structure do
-    config = ActiveRecord::Base.configurations.configs_for(env_name: Rails.env, name: 'clickhouse')
-
-    desc 'Load database structure'
-    task load: ['db:check_protected_environments'] do
-      ClickhouseActiverecord::Tasks.new(config).structure_load(Rails.root.join('db/clickhouse_structure.sql'))
-    end
-
-    desc 'Dump database structure'
-    task dump: ['db:check_protected_environments'] do
-      ClickhouseActiverecord::Tasks.new(config).structure_dump(Rails.root.join('db/clickhouse_structure.sql'))
-    end
-  end
-
-  desc 'Creates the database from DATABASE_URL or config/database.yml'
-  task create: [] do
-    puts 'Warning: `rake clickhouse:create` is deprecated! Use `rake db:create:clickhouse` instead'
-  end
-
-  desc 'Drops the database from DATABASE_URL or config/database.yml'
-  task drop: ['db:check_protected_environments'] do
-    puts 'Warning: `rake clickhouse:drop` is deprecated! Use `rake db:drop:clickhouse` instead'
-  end
-
-  desc 'Empty the database from DATABASE_URL or config/database.yml'
-  task purge: ['db:check_protected_environments'] do
-    puts 'Warning: `rake clickhouse:purge` is deprecated! Use `rake db:reset:clickhouse` instead'
-  end
-
-  # desc 'Resets your database using your migrations for the current environment'
-  task :reset  do
-    puts 'Warning: `rake clickhouse:reset` is deprecated! Use `rake db:reset:clickhouse` instead'
-  end
-
-  desc 'Migrate the clickhouse database'
-  task migrate: %i[prepare_schema_migration_table prepare_internal_metadata_table] do
-    puts 'Warning: `rake clickhouse:migrate` is deprecated! Use `rake db:migrate:clickhouse` instead'
-    Rake::Task['db:migrate:clickhouse'].execute
-    if File.exist? "#{Rails.root}/db/clickhouse_schema_simple.rb"
-      Rake::Task['clickhouse:schema:dump'].execute(simple: true)
-    end
-  end
-
-  desc 'Rollback the clickhouse database'
-  task rollback: %i[prepare_schema_migration_table prepare_internal_metadata_table] do
-    puts 'Warning: `rake clickhouse:rollback` is deprecated! Use `rake db:rollback:clickhouse` instead'
-    Rake::Task['db:rollback:clickhouse'].execute
-    if File.exist? "#{Rails.root}/db/clickhouse_schema_simple.rb"
-      Rake::Task['clickhouse:schema:dump'].execute(simple: true)
-    end
-  end
-end