clickhouse-activerecord 0.4.7 → 0.4.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed292c2d626374fcb26194a4ca28ca34d60f8c49105b7217bfc7654a5a1b08f0
-  data.tar.gz: 97d4074d47e641e8202fd8796ea049f78bf76d86906ce08877f3eb96b236b116
+  metadata.gz: ad0ad1c7545498f275ff975d35ee9dde7d2f644516932ee33ab65796360426a0
+  data.tar.gz: 15b32b155c596c8cdd9e187681a128a4806ca7e2c457e0f833ffc66ba9c994af
 SHA512:
-  metadata.gz: 23c4d834c3c3bbaa000b8bd9202064cbabf2c366a8984d1b2fd92dc51e4c6d2811301e39cd8d2b80141581dcedb8cb6647dcbe59d90eb0b0987afdd5f1b22efa
-  data.tar.gz: 0ac017b6614a3072fdad422db66a36201d5e3a62269230f102fbe8b6c7085f48a139cd8c0753adab11ca53a25e91e6eb327298036ebc385eb26f302c4e5178f8
+  metadata.gz: 8f80ffc1c70dbbdd489ea59627e85a72f538276c80adc0fe5ee4319c222a61da2acd1680ea42bd8c4c4b713fb354f7498a3469cc3cfd17f9003c8dbd607719b2
+  data.tar.gz: 9c91108f18bb9b133708a682ee3dfec238cc54afac480fcada95e876bb051843a7269e3d81c6298299b1bbffbc5a8a47975add7919144d220845fd87c710122b

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### Version 0.4.10 (Mar 10, 2021)
+
+ * Support ClickHouse 20.9+
+ * Fix schema create / dump
+ * Support all integer types through :limit and :unsigned [@bdevel](https://github.com/bdevel)
+
 ### Version 0.4.4 (Sep 23, 2020)
 
  * Full support migration and rollback database

data/README.md

@@ -1,7 +1,7 @@
 # Clickhouse::Activerecord
 
 A Ruby database ActiveRecord driver for ClickHouse. Support Rails >= 5.2.
-Support ClickHouse version from 19.14 LTS.
+Support ClickHouse version from 20.9 LTS.
 
 ## Installation
 
@@ -35,6 +35,21 @@ default: &default
   replica_name: '{replica}' # replica macros name, optional for creating replicated tables
 ```
 
+Alternatively if you wish to pass a custom `Net::HTTP` transport (or any other
+object which supports a `.post()` function with the same parameters as
+`Net::HTTP`'s), you can do this directly instead of specifying
+`host`/`port`/`ssl`:
+
+```ruby
+class ActionView < ActiveRecord::Base
+  establish_connection(
+    adapter: 'clickhouse',
+    database: 'database',
+    connection: Net::HTTP.start('http://example.org', 8123)
+  )
+end
+```
+
 ## Usage in Rails 5
 
 Add your `database.yml` connection information with postfix `_clickhouse` for you environment:
@@ -162,6 +177,44 @@ ActionView.maximum(:date)
 #=> 'Wed, 29 Nov 2017'
 ```
 
+
+### Migration Data Types
+
+Integer types are unsigned by default. Specify signed values with `:unsigned =>
+false`. The default integer is `UInt32`
+
+| Type (bit size)    | Range | :limit (byte size) |
+| :---        |    :----:   |          ---: |
+| Int8 | -128 to 127 | 1 | 
+| Int16 | -32768 to 32767 | 2 |
+| Int32 | -2147483648 to 2,147,483,647 | 3,4 |
+| Int64 | -9223372036854775808 to 9223372036854775807] |  5,6,7,8 |
+| Int128 | ... | 9 - 15 |
+| Int256 | ... | 16+ |
+| UInt8 | 0 to 255 | 1 |
+| UInt16 | 0 to 65,535 | 2 |
+| UInt32 | 0 to 4,294,967,295 | 3,4 |
+| UInt64 | 0 to 18446744073709551615 | 5,6,7,8 |
+| UInt256 | 0 to ... | 8+ |
+
+Example:
+
+``` ruby
+class CreateDataItems < ActiveRecord::Migration
+  def change
+    create_table "data_items", id: false, options: "VersionedCollapsingMergeTree(sign, version) PARTITION BY toYYYYMM(day) ORDER BY category", force: :cascade do |t|
+      t.date "day", null: false
+      t.string "category", null: false
+      t.integer "value_in", null: false
+      t.integer "sign", limit: 1, unsigned: false, default: -> { "CAST(1, 'Int8')" }, null: false
+      t.integer "version", limit: 8, default: -> { "CAST(toUnixTimestamp(now()), 'UInt64')" }, null: false
+    end
+  end
+end
+      
+```
+
+
 ### Using replica and cluster params in connection parameters
 
 ```yml

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

@@ -39,7 +39,9 @@ module ActiveRecord
           statements << accept(o.primary_keys) if o.primary_keys
 
           create_sql << "(#{statements.join(', ')})" if statements.present?
-          add_table_options!(create_sql, table_options(o))
+          # Attach options for only table or materialized view
+          add_table_options!(create_sql, table_options(o)) if !o.view || o.view && o.materialized
+
           create_sql << " AS #{to_sql(o.as)}" if o.as
           create_sql
         end

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

@@ -35,13 +35,31 @@ module ActiveRecord
         end
 
         def integer(*args, **options)
-          if options[:limit] == 8
-            args.each { |name| column(name, :big_integer, options.except(:limit)) }
-          else
-            super
+          # default to unsigned
+          unsigned = options[:unsigned]
+          unsigned = true if unsigned.nil?
+
+          kind = :uint32 # default
+
+          if options[:limit]
+            if unsigned
+              kind = :uint8       if options[:limit] == 1
+              kind = :uint16      if options[:limit] == 2
+              kind = :uint32      if [3,4].include?(options[:limit])
+              kind = :uint64      if [5,6,7].include?(options[:limit])
+              kind = :big_integer if options[:limit] == 8
+              kind = :uint256     if options[:limit] > 8
+            else
+              kind = :int8       if options[:limit] == 1
+              kind = :int16      if options[:limit] == 2
+              kind = :int32      if [3,4].include?(options[:limit])
+              kind = :int64     if options[:limit] > 5 && options[:limit] <= 8
+              kind = :int128     if options[:limit] > 8 && options[:limit] <= 16
+              kind = :int256     if options[:limit] > 16
+            end
           end
+          args.each { |name| column(name, kind, options.except(:limit, :unsigned)) }
         end
-
       end
     end
   end

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

@@ -17,8 +17,10 @@ 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'])
-        rescue StandardError => _e
-          raise ActiveRecord::ActiveRecordError, "Response: #{result}"
+        rescue ActiveRecord::ActiveRecordError => e
+          raise e
+        rescue StandardError => e
+          raise ActiveRecord::ActiveRecordError, "Response: #{e.message}"
         end
 
         def exec_update(_sql, _name = nil, _binds = [])
@@ -36,8 +38,8 @@ module ActiveRecord
         end
 
         def table_options(table)
-          sql = do_system_execute("SHOW CREATE TABLE `#{table}`")['data'].try(:first).try(:first)
-          { options: sql.gsub(/^(?:.*?)ENGINE = (.*?)$/, '\\1') }
+          sql = show_create_table(table)
+          { options: sql.gsub(/^(?:.*?)(?:ENGINE = (.*?))?( AS SELECT .*?)?$/, '\\1').presence, as: sql.match(/^CREATE (?:.*?) AS (SELECT .*?)$/).try(:[], 1) }.compact
         end
 
         # Not indexes on clickhouse

data/lib/active_record/connection_adapters/clickhouse_adapter.rb

@@ -17,9 +17,18 @@ module ActiveRecord
       # Establishes a connection to the database that's used by all Active Record objects
       def clickhouse_connection(config)
         config = config.symbolize_keys
-        host = config[:host] || 'localhost'
-        port = config[:port] || 8123
-        ssl = config[:ssl].present? ? config[:ssl] : port == 443
+        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,
+          }
+        end
 
         if config.key?(:database)
           database = config[:database]
@@ -27,7 +36,7 @@ module ActiveRecord
           raise ArgumentError, 'No database specified. Missing argument: database.'
         end
 
-        ConnectionAdapters::ClickhouseAdapter.new(logger, [host, port, ssl], { user: config[:username], password: config[:password], database: database }.compact, config)
+        ConnectionAdapters::ClickhouseAdapter.new(logger, connection, { user: config[:username], password: config[:password], database: database }.compact, config)
       end
     end
   end
@@ -79,7 +88,6 @@ module ActiveRecord
 
     class ClickhouseAdapter < AbstractAdapter
       ADAPTER_NAME = 'Clickhouse'.freeze
-
       NATIVE_DATABASE_TYPES = {
         string: { name: 'String' },
         integer: { name: 'UInt32' },
@@ -88,7 +96,21 @@ module ActiveRecord
         decimal: { name: 'Decimal' },
         datetime: { name: 'DateTime' },
         date: { name: 'Date' },
-        boolean: { name: 'UInt8' }
+        boolean: { name: 'UInt8' },
+
+        int8:  { name: 'Int8' },
+        int16: { name: 'Int16' },
+        int32: { name: 'Int32' },
+        int64:  { name: 'Int64' },
+        int128: { name: 'Int128' },
+        int256: { name: 'Int256' },
+
+        uint8: { name: 'UInt8' },
+        uint16: { name: 'UInt16' },
+        uint32: { name: 'UInt32' },
+        uint64: { name: 'UInt64' },
+        # uint128: { name: 'UInt128' }, not yet implemented in clickhouse
+        uint256: { name: 'UInt256' },
       }.freeze
 
       include Clickhouse::SchemaStatements
@@ -139,10 +161,12 @@ module ActiveRecord
           when /(Nullable)?\(?String\)?/
             super('String')
           when /(Nullable)?\(?U?Int8\)?/
-            super('int2')
-          when /(Nullable)?\(?U?Int(16|32)\)?/
-            super('int4')
-          when /(Nullable)?\(?U?Int(64)\)?/
+            1
+          when /(Nullable)?\(?U?Int16\)?/
+            2
+          when /(Nullable)?\(?U?Int32\)?/
+            nil
+          when /(Nullable)?\(?U?Int64\)?/
             8
           else
             super
@@ -154,14 +178,20 @@ module ActiveRecord
         register_class_with_limit m, %r(String), Type::String
         register_class_with_limit m, 'Date',  Clickhouse::OID::Date
         register_class_with_limit m, 'DateTime',  Clickhouse::OID::DateTime
-        register_class_with_limit m, %r(Uint8), Type::UnsignedInteger
-        m.alias_type 'UInt16', 'UInt8'
-        m.alias_type 'UInt32', 'UInt8'
-        register_class_with_limit m, %r(UInt64), Type::UnsignedInteger
+
         register_class_with_limit m, %r(Int8), Type::Integer
-        m.alias_type 'Int16', 'Int8'
-        m.alias_type 'Int32', 'Int8'
+        register_class_with_limit m, %r(Int16), Type::Integer
+        register_class_with_limit m, %r(Int32), Type::Integer
         register_class_with_limit m, %r(Int64), Type::Integer
+        register_class_with_limit m, %r(Int128), Type::Integer
+        register_class_with_limit m, %r(Int256), Type::Integer
+
+        register_class_with_limit m, %r(Uint8), Type::UnsignedInteger
+        register_class_with_limit m, %r(UInt16), Type::UnsignedInteger
+        register_class_with_limit m, %r(UInt32), Type::UnsignedInteger
+        register_class_with_limit m, %r(UInt64), Type::UnsignedInteger
+        #register_class_with_limit m, %r(UInt128), Type::UnsignedInteger #not implemnted in clickhouse
+        register_class_with_limit m, %r(UInt256), Type::UnsignedInteger
       end
 
       # Quoting time without microseconds
@@ -201,6 +231,12 @@ module ActiveRecord
         ClickhouseActiverecord::SchemaDumper.create(self, options)
       end
 
+      # @param [String] table
+      # @return [String]
+      def show_create_table(table)
+        do_system_execute("SHOW CREATE TABLE `#{table}`")['data'].try(:first).try(:first).gsub(/[\n\s]+/m, ' ')
+      end
+
       # Create a new ClickHouse database.
       def create_database(name)
         sql = apply_cluster "CREATE DATABASE #{quote_table_name(name)}"
@@ -298,7 +334,7 @@ module ActiveRecord
       private
 
       def connect
-        @connection = Net::HTTP.start(@connection_parameters[0], @connection_parameters[1], use_ssl: @connection_parameters[2], verify_mode: OpenSSL::SSL::VERIFY_NONE)
+        @connection = @connection_parameters[:connection] || Net::HTTP.start(@connection_parameters[:host], @connection_parameters[:port], use_ssl: @connection_parameters[:ssl], verify_mode: OpenSSL::SSL::VERIFY_NONE)
       end
 
       def apply_replica(table, options)

data/lib/clickhouse-activerecord/migration.rb

@@ -27,7 +27,7 @@ module ClickhouseActiverecord
         unless table_exists?
           key_options = connection.internal_string_options_for_primary_key
 
-          connection.create_table(table_name, id: false, options: 'MergeTree() PARTITION BY toDate(created_at) ORDER BY (created_at)', if_not_exists: true) do |t|
+          connection.create_table(table_name, id: false, options: connection.adapter_name.downcase == 'clickhouse' ? 'MergeTree() PARTITION BY toDate(created_at) ORDER BY (created_at)' : '', if_not_exists: true) do |t|
             t.string :key, key_options
             t.string :value
             t.timestamps

data/lib/clickhouse-activerecord/schema_dumper.rb

@@ -33,16 +33,24 @@ module ClickhouseActiverecord
 HEADER
     end
 
+    def tables(stream)
+      sorted_tables = @connection.tables.sort {|a,b| @connection.show_create_table(a).match(/^CREATE\s+(MATERIALIZED\s+)?VIEW/) ? 1 : a <=> b }
+
+      sorted_tables.each do |table_name|
+        table(table_name, stream) unless ignored?(table_name)
+      end
+    end
+
     def table(table, stream)
-      if table.match(/^\.inner\./).nil?
+      if table.match(/^\.inner/).nil?
         unless simple
           stream.puts "  # TABLE: #{table}"
-          sql = @connection.do_system_execute("SHOW CREATE TABLE `#{table.gsub(/^\.inner\./, '')}`")['data'].try(:first).try(:first)
+          sql = @connection.show_create_table(table)
           stream.puts "  # SQL: #{sql.gsub(/ENGINE = Replicated(.*?)\('[^']+',\s*'[^']+',?\s?([^\)]*)?\)/, "ENGINE = \\1(\\2)")}" if sql
           # super(table.gsub(/^\.inner\./, ''), stream)
 
           # detect view table
-          match = sql.match(/^CREATE\s+(MATERIALIZED)\s+VIEW/)
+          match = sql.match(/^CREATE\s+(MATERIALIZED\s+)?VIEW/)
         end
 
         # Copy from original dumper
@@ -125,5 +133,21 @@ HEADER
         super
       end
     end
+
+    def schema_limit(column)
+      return nil if column.type == :float
+      super
+    end
+
+    def schema_unsigned(column)
+      return nil unless column.type == :integer && !simple
+      (column.sql_type =~ /(Nullable)?\(?UInt\d+\)?/).nil? ? false : nil
+    end
+
+    def prepare_column_options(column)
+      spec = {}
+      spec[:unsigned] = schema_unsigned(column)
+      spec.merge(super).compact
+    end
   end
 end

data/lib/clickhouse-activerecord/version.rb

@@ -1,3 +1,3 @@
 module ClickhouseActiverecord
-  VERSION = '0.4.7'
+  VERSION = '0.4.12'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clickhouse-activerecord
 version: !ruby/object:Gem::Version
-  version: 0.4.7
+  version: 0.4.12
 platform: ruby
 authors:
 - Sergey Odintsov
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-25 00:00:00.000000000 Z
+date: 2021-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -134,7 +134,7 @@ homepage: https://github.com/pnixx/clickhouse-activerecord
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -149,8 +149,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: ClickHouse ActiveRecord
 test_files: []