clickhouse-activerecord 1.0.13 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71882da78e208681ad3f28c05bfad0ca4746f8e6b046a4b8cd14c2fa26a007b6
-  data.tar.gz: b0daa57171963e98a6d0aa4284b7728731009960a07cbdd45a0cc104fcb14213
+  metadata.gz: 33b7616478a348a6d6cb1566fbf48bf5e1bad4f0dbb72269eb9befd851416121
+  data.tar.gz: d6479be11b4f06096e7fdf24bb75742e1ac2381e671918088ca05f83960bd6a9
 SHA512:
-  metadata.gz: aea7e2146f23b6183e4583a1b5cc7e4a38131fabff83574415a1e6c8bd607089305265c53ddb54dcbe2c476144d21b4b97795123cd7bfa038ef7a975de7bde9d
-  data.tar.gz: 2228a7f2a7e71005f2d2bb910c721373671bdbb7a6ea15e370ecd923a8fb47fa7cebaa548b50ed7ca9bf8d6d6c2ac27a95cca8c680604ba95934866b6488a8b9
+  metadata.gz: dc19098e7e42c154e6255a90e6abf4e46d4546658c8db1b8ade27caa3e73e3fb29636e64c05c3160522a9bdd8c12f95b515300a637453e05a520a6d92746b248
+  data.tar.gz: 64c7023e7cc381696a6f97ae8fa3b5ed20cdf6d971bc7f852a8403895ce62d0274fddc3325978f6d733b086e322967c7b827e94bc10e09da364fc7fd040081fe

data/.github/workflows/testing.yml

@@ -19,8 +19,16 @@ jobs:
       fail-fast: true
       max-parallel: 1
       matrix:
-        ruby-version: [ '2.7', '3.0', '3.2' ]
-        clickhouse: [ '22.1' ]
+        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.0
+        clickhouse: [ '22.1', '24.6' ]
 
     steps:
       - uses: actions/checkout@v4
@@ -33,10 +41,12 @@ jobs:
           compose-file: '.docker/docker-compose.yml'
           down-flags: '--volumes'
 
-      - name: Set up Ruby ${{ matrix.ruby-version }}
+      - run: echo 'gem "activerecord", "~> ${{ matrix.version.rails }}"' >> Gemfile
+
+      - name: Set up Ruby ${{ matrix.version.ruby }}
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: ${{ matrix.ruby-version }}
+          ruby-version: ${{ matrix.version.ruby }}
           bundler-cache: true
 
       - run: bundle exec rspec spec/single
@@ -54,8 +64,16 @@ jobs:
       fail-fast: true
       max-parallel: 1
       matrix:
-        ruby-version: [ '2.7', '3.0', '3.2' ]
-        clickhouse: [ '22.1' ]
+        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.0
+        clickhouse: [ '22.1', '24.6' ]
 
     steps:
       - uses: actions/checkout@v4
@@ -68,10 +86,12 @@ jobs:
           compose-file: '.docker/docker-compose.cluster.yml'
           down-flags: '--volumes'
 
-      - name: Set up Ruby ${{ matrix.ruby-version }}
+      - run: echo 'gem "activerecord", "~> ${{ matrix.version.rails }}"' >> Gemfile
+
+      - name: Set up Ruby ${{ matrix.version.ruby }}
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: ${{ matrix.ruby-version }}
+          ruby-version: ${{ matrix.version.ruby }}
           bundler-cache: true
 
       - run: bundle exec rspec spec/cluster

data/.gitignore

@@ -54,3 +54,4 @@ crashlytics.properties
 crashlytics-build.properties
 fabric.properties
 .rspec_status
+.tool-versions

data/README.md

@@ -207,6 +207,7 @@ false`. The default integer is `UInt32`
 | UInt64          |          0 to 18446744073709551615           |            5,6,7,8 |
 | UInt256         |                   0 to ...                   |                 8+ |
 | Array           |                     ...                      |                ... |
+| Map             |                     ...                      |                ... |
 
 Example:
 

data/clickhouse-activerecord.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'bundler', '>= 1.13.4'
-  spec.add_runtime_dependency 'activerecord', '>= 7.1'
+  spec.add_runtime_dependency 'activerecord', '~> 7.1'
 
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.4'

data/lib/active_record/connection_adapters/clickhouse/oid/map.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module ConnectionAdapters
+    module Clickhouse
+      module OID # :nodoc:
+        class Map < Type::Value # :nodoc:
+
+          def initialize(sql_type)
+            @subtype = case sql_type
+                       when /U?Int\d+/
+                         :integer
+                       when /DateTime/
+                         :datetime
+                       when /Date/
+                         :date
+                       else
+                         :string
+            end
+          end
+
+          def type
+            @subtype
+          end
+
+          def deserialize(value)
+            if value.is_a?(::Hash)
+              value.map { |k, item| [k.to_s, deserialize(item)] }.to_h
+            else
+              return value if value.nil?
+              case @subtype
+                when :integer
+                  value.to_i
+                when :datetime
+                  ::DateTime.parse(value)
+                when :date
+                  ::Date.parse(value)
+              else
+                super
+              end
+            end
+          end
+
+          def serialize(value)
+            if value.is_a?(::Hash)
+              value.map { |k, item| [k.to_s, serialize(item)] }.to_h
+            else
+              return value if value.nil?
+              case @subtype
+                when :integer
+                  value.to_i
+                when :datetime
+                  DateTime.new.serialize(value)
+                when :date
+                  Date.new.serialize(value)
+                when :string
+                  value.to_s
+              else
+                super
+              end
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module ActiveRecord
+  module ConnectionAdapters
+    module Clickhouse
+      module Quoting
+        extend ActiveSupport::Concern
+
+        module ClassMethods # :nodoc:
+          def quote_column_name(name)
+            name
+          end
+
+          def quote_table_name(name)
+            name
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -33,6 +33,9 @@ module ActiveRecord
           if options[:array]
             sql.gsub!(/\s+(.*)/, ' Array(\1)')
           end
+          if options[:map]
+            sql.gsub!(/\s+(.*)/, ' Map(String, \1)')
+          end
           sql.gsub!(/(\sString)\(\d+\)/, '\1')
           sql << " DEFAULT #{quote_default_expression(options[:default], options[:column])}" if options_include_default?(options)
           sql

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

@@ -97,7 +97,7 @@ module ActiveRecord
         private
 
         def valid_column_definition_options
-          super + [:array, :low_cardinality, :fixed_string, :value, :type]
+          super + [:array, :low_cardinality, :fixed_string, :value, :type, :map]
         end
       end
 

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

@@ -18,9 +18,16 @@ module ActiveRecord
           true
         end
 
-        def internal_exec_query(sql, name = nil, binds = [], prepare: false, async: false)
+        def internal_exec_query(sql, name = nil, binds = [], prepare: false, async: false, allow_retry: false)
           result = do_execute(sql, name)
-          ActiveRecord::Result.new(result['meta'].map { |m| m['name'] }, result['data'], result['meta'].map { |m| [m['name'], type_map.lookup(m['type'])] }.to_h)
+          columns = result['meta'].map { |m| m['name'] }
+          types = {}
+          result['meta'].each_with_index do |m, i|
+            # need use column name and index after commit in 7.2:
+            # https://github.com/rails/rails/commit/24dbf7637b1d5cd6eb3d7100b8d0f6872c3fee3c
+            types[m['name']] = types[i] = type_map.lookup(m['type'])
+          end
+          ActiveRecord::Result.new(columns, result['data'], types)
         rescue ActiveRecord::ActiveRecordError => e
           raise e
         rescue StandardError => e
@@ -57,6 +64,12 @@ module ActiveRecord
           result['data'].flatten
         end
 
+        def views(name = nil)
+          result = do_system_execute("SHOW TABLES WHERE engine = 'View'", name)
+          return [] if result.nil?
+          result['data'].flatten
+        end
+
         def functions
           result = do_system_execute("SELECT name FROM system.functions WHERE origin = 'SQLUserDefined'")
           return [] if result.nil?
@@ -103,6 +116,20 @@ module ActiveRecord
           end
         end
 
+        if ::ActiveRecord::version >= Gem::Version.new('7.2')
+          def schema_migration
+            pool.schema_migration
+          end
+
+          def migration_context
+            pool.migration_context
+          end
+
+          def internal_metadata
+            pool.internal_metadata
+          end
+        end
+
         def assume_migrated_upto_version(version, migrations_paths = nil)
           version = version.to_i
           sm_table = quote_table_name(schema_migration.table_name)
@@ -126,7 +153,7 @@ module ActiveRecord
         # Fix insert_all method
         # https://github.com/PNixx/clickhouse-activerecord/issues/71#issuecomment-1923244983
         def with_yaml_fallback(value) # :nodoc:
-          if value.is_a?(Array)
+          if value.is_a?(Array) || value.is_a?(Hash)
             value
           else
             super
@@ -191,9 +218,9 @@ module ActiveRecord
         def new_column_from_field(table_name, field, _definitions)
           sql_type = field[1]
           type_metadata = fetch_type_metadata(sql_type)
-          default = field[3]
-          default_value = extract_value_from_default(default)
-          default_function = extract_default_function(default_value, default)
+          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)
           ClickhouseColumn.new(field[0], default_value, type_metadata, field[1].include?('Nullable'), default_function)
         end
 
@@ -212,32 +239,22 @@ module ActiveRecord
         private
 
         # Extracts the value from a PostgreSQL column default definition.
-        def extract_value_from_default(default)
-          case default
-            # Quoted types
-          when /\Anow\(\)\z/m
-            nil
-            # Boolean types
-          when "true".freeze, "false".freeze
-            default
-            # Object identifier types
-          when "''"
-            ''
-          when /\A-?\d+\z/
-            $1
-          else
-            # Anything else is blank, some user type, or some function
-            # and we can't know the value of that, so return nil.
-            nil
-          end
+        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)
+
+          # Convert string
+          return $1 if default_expression.match(/^'(.*?)'$/)
+
+          default_expression
         end
 
-        def extract_default_function(default_value, default) # :nodoc:
-          default if has_default_function?(default_value, default)
+        def extract_default_function(default) # :nodoc:
+          default if has_default_function?(default)
         end
 
-        def has_default_function?(default_value, default) # :nodoc:
-          !default_value && (%r{\w+\(.*\)} === default)
+        def has_default_function?(default) # :nodoc:
+          (%r{\w+\(.*\)} === default)
         end
 
         def format_body_response(body, format)

data/lib/active_record/connection_adapters/clickhouse_adapter.rb

@@ -8,7 +8,9 @@ require 'active_record/connection_adapters/clickhouse/oid/array'
 require 'active_record/connection_adapters/clickhouse/oid/date'
 require 'active_record/connection_adapters/clickhouse/oid/date_time'
 require 'active_record/connection_adapters/clickhouse/oid/big_integer'
+require 'active_record/connection_adapters/clickhouse/oid/map'
 require 'active_record/connection_adapters/clickhouse/oid/uuid'
+require 'active_record/connection_adapters/clickhouse/quoting'
 require 'active_record/connection_adapters/clickhouse/schema_definitions'
 require 'active_record/connection_adapters/clickhouse/schema_creation'
 require 'active_record/connection_adapters/clickhouse/schema_statements'
@@ -22,30 +24,11 @@ module ActiveRecord
       def clickhouse_connection(config)
         config = config.symbolize_keys
 
-        if config[:connection]
-          connection = {
-            connection: config[:connection]
-          }
-        else
-          port = config[:port] || 8123
-          connection = {
-            host: config[:host] || 'localhost',
-            port: port,
-            ssl: config[:ssl].present? ? config[:ssl] : port == 443,
-            sslca: config[:sslca],
-            read_timeout: config[:read_timeout],
-            write_timeout: config[:write_timeout],
-            keep_alive_timeout: config[:keep_alive_timeout]
-          }
-        end
-
-        if config.key?(:database)
-          database = config[:database]
-        else
+        unless config.key?(:database)
           raise ArgumentError, 'No database specified. Missing argument: database.'
         end
 
-        ConnectionAdapters::ClickhouseAdapter.new(logger, connection, config)
+        ConnectionAdapters::ClickhouseAdapter.new(config)
       end
     end
   end
@@ -82,11 +65,21 @@ module ActiveRecord
   end
 
   module ConnectionAdapters
-    class ClickhouseColumn < Column
 
+    if ActiveRecord::version >= Gem::Version.new('7.2')
+      register "clickhouse", "ActiveRecord::ConnectionAdapters::ClickhouseAdapter", "active_record/connection_adapters/clickhouse_adapter"
+    end
+
+    class ClickhouseColumn < Column
+      private
+      def deduplicated
+        self
+      end
     end
 
     class ClickhouseAdapter < AbstractAdapter
+      include Clickhouse::Quoting
+
       ADAPTER_NAME = 'Clickhouse'.freeze
       NATIVE_DATABASE_TYPES = {
         string: { name: 'String' },
@@ -121,12 +114,28 @@ module ActiveRecord
       include Clickhouse::SchemaStatements
 
       # Initializes and connects a Clickhouse adapter.
-      def initialize(logger, connection_parameters, config)
-        super(nil, logger)
-        @connection_parameters = connection_parameters
-        @connection_config = { user: config[:username], password: config[:password], database: config[:database] }.compact
-        @debug = config[:debug] || false
-        @config = config
+      def initialize(config_or_deprecated_connection, deprecated_logger = nil, deprecated_connection_options = nil, deprecated_config = nil)
+        super
+        if @config[:connection]
+          connection = {
+            connection: @config[:connection]
+          }
+        else
+          port = @config[:port] || 8123
+          connection = {
+            host: @config[:host] || 'localhost',
+            port: port,
+            ssl: @config[:ssl].present? ? @config[:ssl] : port == 443,
+            sslca: @config[:sslca],
+            read_timeout: @config[:read_timeout],
+            write_timeout: @config[:write_timeout],
+            keep_alive_timeout: @config[:keep_alive_timeout]
+          }
+        end
+        @connection_parameters = connection
+
+        @connection_config = { user: @config[:username], password: @config[:password], database: @config[:database] }.compact
+        @debug = @config[:debug] || false
 
         @prepared_statements = false
 
@@ -221,6 +230,10 @@ module ActiveRecord
           m.register_type(%r(Array)) do |sql_type|
             Clickhouse::OID::Array.new(sql_type)
           end
+
+          m.register_type(%r(Map)) do |sql_type|
+            Clickhouse::OID::Map.new(sql_type)
+          end
         end
       end
 
@@ -233,6 +246,8 @@ module ActiveRecord
         case value
         when Array
           '[' + value.map { |v| quote(v) }.join(', ') + ']'
+        when Hash
+          '{' + value.map { |k, v| "#{quote(k)}: #{quote(v)}" }.join(', ') + '}'
         else
           super
         end
@@ -517,6 +532,10 @@ module ActiveRecord
         @connection
       end
 
+      def reconnect
+        connect
+      end
+
       def apply_replica(table, options)
         if use_replica? && options[:options]
           if options[:options].match(/^Replicated/)

data/lib/clickhouse-activerecord/schema.rb

@@ -2,6 +2,12 @@
 
 module ClickhouseActiverecord
   class Schema < ::ActiveRecord::Schema
-
+    def define(...)
+      ActiveRecord.deprecator.warn(<<~MSG)
+        ClickhouseActiverecord::Schema is deprecated
+        and will be removed in 1.2 version. Use ActiveRecord::Schema instead.
+      MSG
+      super
+    end
   end
 end

data/lib/clickhouse-activerecord/schema_dumper.rb

@@ -14,25 +14,6 @@ module ClickhouseActiverecord
 
     private
 
-    def header(stream)
-      stream.puts <<HEADER
-# This file is auto-generated from the current state of the database. Instead
-# of editing this file, please use the migrations feature of Active Record to
-# incrementally modify your database, and then regenerate this schema definition.
-#
-# This file is the source Rails uses to define your schema when running `rails
-# #{simple ? 'db' : 'clickhouse'}:schema:load`. When creating a new database, `rails #{simple ? 'db' : 'clickhouse'}:schema:load` tends to
-# be faster and is potentially less error prone than running all of your
-# migrations from scratch. Old migrations may fail to apply correctly if those
-# migrations use external dependencies or application code.
-#
-# It's strongly recommended that you check this file into your version control system.
-
-#{simple ? 'ActiveRecord' : 'ClickhouseActiverecord'}::Schema.define(#{define_params}) do
-
-HEADER
-    end
-
     def tables(stream)
       functions = @connection.functions
       functions.each do |function|
@@ -168,6 +149,10 @@ HEADER
       (column.sql_type =~ /Array?\(/).nil? ? nil : true
     end
 
+    def schema_map(column)
+      (column.sql_type =~ /Map?\(/).nil? ? nil : true
+    end
+
     def schema_low_cardinality(column)
       (column.sql_type =~ /LowCardinality?\(/).nil? ? nil : true
     end
@@ -176,6 +161,7 @@ HEADER
       spec = {}
       spec[:unsigned] = schema_unsigned(column)
       spec[:array] = schema_array(column)
+      spec[:map] = schema_map(column)
       spec[:low_cardinality] = schema_low_cardinality(column)
       spec.merge(super).compact
     end

data/lib/clickhouse-activerecord/version.rb

@@ -1,3 +1,3 @@
 module ClickhouseActiverecord
-  VERSION = '1.0.13'
+  VERSION = '1.1.1'
 end

data/lib/core_extensions/active_record/internal_metadata.rb

@@ -4,7 +4,7 @@ module CoreExtensions
 
       def create_table
         return super unless connection.is_a?(::ActiveRecord::ConnectionAdapters::ClickhouseAdapter)
-        return if table_exists? || !enabled?
+        return if !enabled? || table_exists?
 
         key_options = connection.internal_string_options_for_primary_key
         table_options = {
@@ -31,14 +31,23 @@ module CoreExtensions
 
       private
 
-      def update_entry(key, new_value)
-        return super unless connection.is_a?(::ActiveRecord::ConnectionAdapters::ClickhouseAdapter)
-
-        create_entry(key, new_value)
+      def update_entry(connection_or_key, key_or_new_value, new_value = nil)
+        if ::ActiveRecord::version >= Gem::Version.new('7.2')
+          return super unless connection.is_a?(::ActiveRecord::ConnectionAdapters::ClickhouseAdapter)
+          create_entry(connection_or_key, key_or_new_value, new_value)
+        else
+          return super(connection_or_key, key_or_new_value) unless connection.is_a?(::ActiveRecord::ConnectionAdapters::ClickhouseAdapter)
+          create_entry(connection_or_key, key_or_new_value)
+        end
       end
 
-      def select_entry(key)
-        return super unless connection.is_a?(::ActiveRecord::ConnectionAdapters::ClickhouseAdapter)
+      def select_entry(connection_or_key, key = nil)
+        if ::ActiveRecord::version >= Gem::Version.new('7.2')
+          return super unless connection.is_a?(::ActiveRecord::ConnectionAdapters::ClickhouseAdapter)
+        else
+          key = connection_or_key
+          return super(key) unless connection.is_a?(::ActiveRecord::ConnectionAdapters::ClickhouseAdapter)
+        end
 
         sm = ::Arel::SelectManager.new(arel_table)
         sm.final! if connection.table_options(table_name)[:options] =~ /^ReplacingMergeTree/
@@ -49,6 +58,14 @@ module CoreExtensions
 
         connection.select_one(sm, "#{self.class} Load")
       end
+
+      def connection
+        if ::ActiveRecord::version >= Gem::Version.new('7.2')
+          @pool.lease_connection
+        else
+          super
+        end
+      end
     end
   end
 end

data/lib/core_extensions/active_record/relation.rb

@@ -25,7 +25,6 @@ module CoreExtensions
 
       # @param [Hash] opts
       def settings!(**opts)
-        assert_mutability!
         check_command('SETTINGS')
         @values[:settings] = (@values[:settings] || {}).merge opts
         self
@@ -43,7 +42,6 @@ module CoreExtensions
       end
 
       def final!
-        assert_mutability!
         check_command('FINAL')
         @values[:final] = true
         self
@@ -62,7 +60,6 @@ module CoreExtensions
 
       # @param [Array] opts
       def using!(*opts)
-        assert_mutability!
         @values[:using] = opts
         self
       end
@@ -73,8 +70,12 @@ module CoreExtensions
         raise ::ActiveRecord::ActiveRecordError, cmd + ' is a ClickHouse specific query clause' unless connection.is_a?(::ActiveRecord::ConnectionAdapters::ClickhouseAdapter)
       end
 
-      def build_arel(aliases = nil)
-        arel = super
+      def build_arel(connection_or_aliases = nil, aliases = nil)
+        if ::ActiveRecord::version >= Gem::Version.new('7.2')
+          arel = super
+        else
+          arel = super(connection_or_aliases)
+        end
 
         arel.final! if @values[:final].present?
         arel.settings(@values[:settings]) if @values[:settings].present?

data/lib/core_extensions/active_record/schema_migration.rb

@@ -47,6 +47,14 @@ module CoreExtensions
 
         connection.select_values(sm, "#{self.class} Load")
       end
+
+      def connection
+        if ::ActiveRecord::version >= Gem::Version.new('7.2')
+          @pool.lease_connection
+        else
+          super
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clickhouse-activerecord
 version: !ruby/object:Gem::Version
-  version: 1.0.13
+  version: 1.1.1
 platform: ruby
 authors:
 - Sergey Odintsov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-01 00:00:00.000000000 Z
+date: 2024-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,14 +28,14 @@ dependencies:
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '7.1'
 - !ruby/object:Gem::Dependency
@@ -110,7 +110,9 @@ files:
 - lib/active_record/connection_adapters/clickhouse/oid/big_integer.rb
 - lib/active_record/connection_adapters/clickhouse/oid/date.rb
 - lib/active_record/connection_adapters/clickhouse/oid/date_time.rb
+- lib/active_record/connection_adapters/clickhouse/oid/map.rb
 - lib/active_record/connection_adapters/clickhouse/oid/uuid.rb
+- lib/active_record/connection_adapters/clickhouse/quoting.rb
 - lib/active_record/connection_adapters/clickhouse/schema_creation.rb
 - lib/active_record/connection_adapters/clickhouse/schema_definitions.rb
 - lib/active_record/connection_adapters/clickhouse/schema_statements.rb