clickhouse-activerecord 0.5.15 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6534694860bbb41c21789239e0589406bcbef64bc1750645c68485e77acb7310
-  data.tar.gz: c6640ccc74004a93bfaa18d93dd1c135411d66f27273eb65848f9843f64fd6d0
+  metadata.gz: 182d838abbda9972bdfa59b1e6a76af247bd4e3b275a5e611dfe6cd8ceaaea5c
+  data.tar.gz: f987ee429692c24518a0ea54d24f52c65f96ddfe1e6d6770fe0c2dd4549c623e
 SHA512:
-  metadata.gz: f848ad57f80f061aa85a593a90bff65707e8dbe281caf3f4a41914d93a4723351bf7e5ca12bfdc7c8ed2cbed5df3db39472b8d015645875476b68941d7de6111
-  data.tar.gz: 1592560741198e983d43599ff78b145262e0638951a2825dcaac993e0dcc0195bf85980b5eeff80d973e0573aeaa865d6d6c8acdd7ee2b2b1ba6bb6740e734cf
+  metadata.gz: 90aac52260cd39eaa23dddb9be9290afa8ccb6731f4c84b6403d67fc56ddf1e24d075e9e33d9cc99ffdf29309608b0a8ae78a35db87d673731438dd5db50c57b
+  data.tar.gz: 505c299c7f657deb7b0685504c0f61754b801d0900238fa9a00a939b49873e379e2d2c84f9ce3661e0c26d405b9e94a31cbeb71c514f644cf4391059df44fa22

data/README.md

@@ -1,7 +1,7 @@
 # Clickhouse::Activerecord
 
 A Ruby database ActiveRecord driver for ClickHouse. Support Rails >= 5.2.
-Support ClickHouse version from 20.9 LTS.
+Support ClickHouse version from 22.0 LTS.
 
 ## Installation
 
@@ -165,7 +165,7 @@ Structure load from `db/clickhouse_structure.sql` file:
 
 ```ruby
 Action.where(url: 'http://example.com', date: Date.current).where.not(name: nil).order(created_at: :desc).limit(10)
-# Clickhouse Action Load (10.3ms)  SELECT  actions.* FROM actions WHERE actions.date = '2017-11-29' AND actions.url = 'http://example.com' AND (actions.name IS NOT NULL)  ORDER BY actions.created_at DESC LIMIT 10
+# Clickhouse Action Load (10.3ms)  SELECT actions.* FROM actions WHERE actions.date = '2017-11-29' AND actions.url = 'http://example.com' AND (actions.name IS NOT NULL)  ORDER BY actions.created_at DESC LIMIT 10
 #=> #<ActiveRecord::Relation [#<Action *** >]>
 
 Action.create(url: 'http://example.com', date: Date.yesterday)
@@ -175,6 +175,14 @@ Action.create(url: 'http://example.com', date: Date.yesterday)
 ActionView.maximum(:date)
 # Clickhouse (10.3ms)  SELECT maxMerge(actions.date) FROM actions
 #=> 'Wed, 29 Nov 2017'
+
+Action.where(date: Date.current).final.limit(10)
+# Clickhouse Action Load (10.3ms)  SELECT actions.* FROM actions FINAL WHERE actions.date = '2017-11-29' LIMIT 10
+#=> #<ActiveRecord::Relation [#<Action *** >]>
+
+Action.settings(optimize_read_in_order: 1).where(date: Date.current).limit(10)
+# Clickhouse Action Load (10.3ms)  SELECT actions.* FROM actions FINAL WHERE actions.date = '2017-11-29' LIMIT 10 SETTINGS optimize_read_in_order = 1
+#=> #<ActiveRecord::Relation [#<Action *** >]>
 ```
 
 

data/clickhouse-activerecord.gemspec

@@ -26,7 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'bundler', '>= 1.13.4'
   spec.add_runtime_dependency 'activerecord', '>= 5.2'
 
-  spec.add_development_dependency 'bundler', '>= 1.15'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.4'
   spec.add_development_dependency 'pry', '~> 0.12'

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

@@ -18,7 +18,7 @@ module ActiveRecord
 
         def exec_query(sql, name = nil, binds = [], prepare: false)
           result = do_execute(sql, name)
-          ActiveRecord::Result.new(result['meta'].map { |m| m['name'] }, result['data'])
+          ActiveRecord::Result.new(result['meta'].map { |m| m['name'] }, result['data'], result['meta'].map { |m| [m['name'], type_map.lookup(m['type'])] }.to_h)
         rescue ActiveRecord::ActiveRecordError => e
           raise e
         rescue StandardError => e
@@ -105,10 +105,20 @@ module ActiveRecord
         def process_response(res)
           case res.code.to_i
           when 200
-            res.body.presence && JSON.parse(res.body)
+            if res.body.to_s.include?("DB::Exception")
+              raise ActiveRecord::ActiveRecordError, "Response code: #{res.code}:\n#{res.body}"
+            else
+              res.body.presence && JSON.parse(res.body)
+            end
           else
-            raise ActiveRecord::ActiveRecordError,
-              "Response code: #{res.code}:\n#{res.body}"
+            case res.body
+              when /DB::Exception:.*\(UNKNOWN_DATABASE\)/
+                raise ActiveRecord::NoDatabaseError
+              when /DB::Exception:.*\(DATABASE_ALREADY_EXISTS\)/
+                raise ActiveRecord::DatabaseAlreadyExists
+              else
+                raise ActiveRecord::ActiveRecordError, "Response code: #{res.code}:\n#{res.body}"
+            end
           end
         rescue JSON::ParserError
           res.body

data/lib/active_record/connection_adapters/clickhouse_adapter.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'clickhouse-activerecord/arel/visitors/to_sql'
-require 'clickhouse-activerecord/arel/table'
+require 'arel/visitors/clickhouse'
+require 'arel/nodes/settings'
 require 'clickhouse-activerecord/migration'
 require 'active_record/connection_adapters/clickhouse/oid/array'
 require 'active_record/connection_adapters/clickhouse/oid/date'
@@ -62,6 +62,8 @@ module ActiveRecord
 
   module ModelSchema
     module ClassMethods
+      delegate :final, :settings, to: :all
+
       def is_view
         @is_view || false
       end
@@ -69,10 +71,10 @@ module ActiveRecord
       def is_view=(value)
         @is_view = value
       end
-
-      def arel_table # :nodoc:
-        @arel_table ||= ClickhouseActiverecord::Arel::Table.new(table_name, type_caster: type_caster)
-      end
+      #
+      # def arel_table # :nodoc:
+      #   @arel_table ||= Arel::Table.new(table_name, type_caster: type_caster)
+      # end
     end
   end
 
@@ -92,7 +94,7 @@ module ActiveRecord
         datetime: { name: 'DateTime' },
         datetime64: { name: 'DateTime64' },
         date: { name: 'Date' },
-        boolean: { name: 'UInt8' },
+        boolean: { name: 'Bool' },
         uuid: { name: 'UUID' },
 
         enum8: { name: 'Enum8' },
@@ -145,7 +147,7 @@ module ActiveRecord
       end
 
       def arel_visitor # :nodoc:
-        ClickhouseActiverecord::Arel::Visitors::ToSql.new(self)
+        Arel::Visitors::Clickhouse.new(self)
       end
 
       def native_database_types #:nodoc:

data/lib/arel/nodes/settings.rb

@@ -0,0 +1,11 @@
+module Arel # :nodoc: all
+  module Nodes
+    class Settings < Arel::Nodes::Unary
+      def initialize(expr)
+        raise ArgumentError, 'Settings must be a Hash' unless expr.is_a?(Hash)
+
+        super
+      end
+    end
+  end
+end

data/lib/arel/visitors/clickhouse.rb

@@ -0,0 +1,54 @@
+require 'arel/visitors/to_sql'
+
+module Arel
+  module Visitors
+    class Clickhouse < ::Arel::Visitors::ToSql
+
+      def aggregate(name, o, collector)
+        # replacing function name for materialized view
+        if o.expressions.first && o.expressions.first != '*' && !o.expressions.first.is_a?(String) && o.expressions.first.relation&.is_view
+          super("#{name.downcase}Merge", o, collector)
+        else
+          super
+        end
+      end
+
+      def visit_Arel_Table o, collector
+        collector = super
+        collector << ' FINAL ' if o.final
+        collector
+      end
+
+      def visit_Arel_Nodes_SelectOptions(o, collector)
+        maybe_visit o.settings, super
+      end
+
+      def visit_Arel_Nodes_Settings(o, collector)
+        return collector if o.expr.empty?
+
+        collector << "SETTINGS "
+        o.expr.each_with_index do |(key, value), i|
+          collector << ", " if i > 0
+          collector << key.to_s.gsub(/\W+/, "")
+          collector << " = "
+          collector << sanitize_as_setting_value(value)
+        end
+        collector
+      end
+
+      def sanitize_as_setting_value(value)
+        if value == :default
+          'DEFAULT'
+        else
+          quote(value)
+        end
+      end
+
+      def sanitize_as_setting_name(value)
+        return value if Arel::Nodes::SqlLiteral === value
+        @connection.sanitize_as_setting_name(value)
+      end
+
+    end
+  end
+end

data/lib/clickhouse-activerecord/migration.rb

@@ -28,20 +28,32 @@ module ClickhouseActiverecord
       end
 
       def all_versions
-        from("#{table_name} FINAL").where(active: 1).order(:version).pluck(:version)
+        final.where(active: 1).order(:version).pluck(:version)
       end
     end
   end
 
   class InternalMetadata < ::ActiveRecord::InternalMetadata
     class << self
+
+      def []=(key, value)
+        row = final.find_by(key: key)
+        if row.nil? || row.value != value
+          create!(key: key, value: value)
+        end
+      end
+
+      def [](key)
+        final.where(key: key).pluck(:value).first
+      end
+
       def create_table
         return if table_exists?
 
         key_options = connection.internal_string_options_for_primary_key
         table_options = {
           id: false,
-          options: connection.adapter_name.downcase == 'clickhouse' ? 'MergeTree() PARTITION BY toDate(created_at) ORDER BY (created_at)' : '',
+          options: connection.adapter_name.downcase == 'clickhouse' ? 'ReplacingMergeTree(created_at) PARTITION BY key ORDER BY key' : '',
           if_not_exists: true
         }
         full_config = connection.instance_variable_get(:@full_config) || {}
@@ -122,5 +134,13 @@ module ClickhouseActiverecord
         super
       end
     end
+
+    private
+
+    def record_environment
+      return if down?
+      ClickhouseActiverecord::InternalMetadata[:environment] = ActiveRecord::Base.connection.migration_context.current_environment
+    end
+
   end
 end

data/lib/clickhouse-activerecord/version.rb

@@ -1,3 +1,3 @@
 module ClickhouseActiverecord
-  VERSION = '0.5.15'
+  VERSION = '0.6.0'
 end

data/lib/clickhouse-activerecord.rb

@@ -4,6 +4,10 @@ require 'active_record/connection_adapters/clickhouse_adapter'
 
 require 'core_extensions/active_record/relation'
 
+require 'core_extensions/arel/nodes/select_statement'
+require 'core_extensions/arel/select_manager'
+require 'core_extensions/arel/table'
+
 require_relative '../core_extensions/active_record/migration/command_recorder'
 ActiveRecord::Migration::CommandRecorder.include CoreExtensions::ActiveRecord::Migration::CommandRecorder
 
@@ -18,5 +22,9 @@ end
 module ClickhouseActiverecord
   def self.load
     ActiveRecord::Relation.prepend(CoreExtensions::ActiveRecord::Relation)
+
+    Arel::Nodes::SelectStatement.prepend(CoreExtensions::Arel::Nodes::SelectStatement)
+    Arel::SelectManager.prepend(CoreExtensions::Arel::SelectManager)
+    Arel::Table.prepend(CoreExtensions::Arel::Table)
   end
 end

data/lib/core_extensions/active_record/relation.rb

@@ -10,6 +10,35 @@ module CoreExtensions
         self.order_values = (column_names & %w[date created_at]).map { |c| arel_table[c].desc }
         self
       end
+
+      # @param [Hash] opts
+      def settings(**opts)
+        check_command('SETTINGS')
+        @values[:settings] = (@values[:settings] || {}).merge opts
+        self
+      end
+
+      # @param [Boolean] final
+      def final(final = true)
+        check_command('FINAL')
+        @table = @table.dup
+        @table.final = final
+        self
+      end
+
+      private
+
+      def check_command(cmd)
+        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
+
+        arel.settings(@values[:settings]) if @values[:settings].present?
+
+        arel
+      end
     end
   end
 end

data/lib/core_extensions/arel/nodes/select_statement.rb

@@ -0,0 +1,18 @@
+module CoreExtensions
+  module Arel # :nodoc: all
+    module Nodes
+      module SelectStatement
+        attr_accessor :settings
+
+        def initialize
+          super
+          @settings = nil
+        end
+
+        def eql?(other)
+          super && settings == other.settings
+        end
+      end
+    end
+  end
+end

data/lib/core_extensions/arel/select_manager.rb

@@ -0,0 +1,12 @@
+module CoreExtensions
+  module Arel
+    module SelectManager
+
+      # @param [Hash] values
+      def settings(values)
+        @ast.settings = ::Arel::Nodes::Settings.new(values)
+        self
+      end
+    end
+  end
+end

data/lib/{clickhouse-activerecord → core_extensions}/arel/table.rb

@@ -1,6 +1,8 @@
-module ClickhouseActiverecord
+module CoreExtensions
   module Arel
-    class Table < ::Arel::Table
+    module Table
+      attr_accessor :final
+
       def is_view
         type_caster.is_view
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clickhouse-activerecord
 version: !ruby/object:Gem::Version
-  version: 0.5.15
+  version: 0.6.0
 platform: ruby
 authors:
 - Sergey Odintsov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-21 00:00:00.000000000 Z
+date: 2023-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.2'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.15'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -121,9 +107,9 @@ files:
 - lib/active_record/connection_adapters/clickhouse/schema_definitions.rb
 - lib/active_record/connection_adapters/clickhouse/schema_statements.rb
 - lib/active_record/connection_adapters/clickhouse_adapter.rb
+- lib/arel/nodes/settings.rb
+- lib/arel/visitors/clickhouse.rb
 - lib/clickhouse-activerecord.rb
-- lib/clickhouse-activerecord/arel/table.rb
-- lib/clickhouse-activerecord/arel/visitors/to_sql.rb
 - lib/clickhouse-activerecord/migration.rb
 - lib/clickhouse-activerecord/railtie.rb
 - lib/clickhouse-activerecord/schema.rb
@@ -131,6 +117,9 @@ files:
 - lib/clickhouse-activerecord/tasks.rb
 - lib/clickhouse-activerecord/version.rb
 - lib/core_extensions/active_record/relation.rb
+- lib/core_extensions/arel/nodes/select_statement.rb
+- 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
@@ -152,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: ClickHouse ActiveRecord

data/lib/clickhouse-activerecord/arel/visitors/to_sql.rb

@@ -1,20 +0,0 @@
-require 'arel/visitors/to_sql'
-
-module ClickhouseActiverecord
-  module Arel
-    module Visitors
-      class ToSql < ::Arel::Visitors::ToSql
-
-        def aggregate(name, o, collector)
-          # replacing function name for materialized view
-          if o.expressions.first && o.expressions.first != '*' && !o.expressions.first.is_a?(String) && o.expressions.first.relation&.is_view
-            super("#{name.downcase}Merge", o, collector)
-          else
-            super
-          end
-        end
-
-      end
-    end
-  end
-end