click_house 1.6.2 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a24e10e60cd19671f70f521f6db773ef0d3b0f6f33a9ef40b5a26ed7aaf8106
-  data.tar.gz: 3a948f7381d345f6784a8a125bedbc62ba9df554920cc40eb217699c350cfc02
+  metadata.gz: 49f4230ea84634e1cfed295d8cc41239d1212bb48807b68636ce82c6cba08039
+  data.tar.gz: e78054a1f0e3094746adfea54b8fcf649d306cbaa1fce636e822a073ac446376
 SHA512:
-  metadata.gz: 12af01d64fb80f0fbfff2df8654c79b6574bd09b6159bac8ae9425417a5fc48fbf7ae8bcf2b0e42efc80bd23bc55212f5ba232f187e606b76fb8d6f7193a6976
-  data.tar.gz: 2d819029b2030f25b68a85f623dcbbec497aa9756d6b69d2e223eccdc97ba35ef58299ceea47f45de568cfdd161f09ca75e1635f9bc3176e94de337ae88e4a59
+  metadata.gz: 280540bf287f99f4fc87e90c47bd94312cc4a82047ada6f193ca4e77b84527c7733e2260f8cb7c960a04d726ffbe449612cf9ee3f297bf30cc6ba27e2ccb9b7c
+  data.tar.gz: 8a4e4213c46c99181a521e749e57fd63857cb0f135fa41ef9e25781947ecbef4eb8844a9062305a5080abeea85e4dee652d50b432e9c1b1cd65f12bf43006624

data/.github/workflows/main.yml

@@ -8,7 +8,7 @@ jobs:
 
     services:
       clickhouse:
-        image: clickhouse/clickhouse-server:22.6
+        image: clickhouse/clickhouse-server:22.9
         ports: 
           - 8123:8123
 

data/.rubocop.yml

@@ -14,7 +14,9 @@ Bundler/OrderedGems:
   Enabled: false
 
 # ============================== Gemspec ======================
-Gemspec/DateAssignment:
+Gemspec/DeprecatedAttributeAssignment:
+  Enabled: true
+Gemspec/RequireMFA: # new in 1.23
   Enabled: true
 
 # =============================== Performance =======================
@@ -52,6 +54,10 @@ Performance/RedundantSplitRegexpArgument:
   Enabled: true
 Performance/MapCompact:
   Enabled: true
+Performance/ConcurrentMonotonicTime: # new in 1.12
+  Enabled: true
+Performance/StringIdentifierArgument: # new in 1.13
+  Enabled: true
 
 # ============================== Metrics ============================
 Metrics/ClassLength:
@@ -77,6 +83,8 @@ Naming/AccessorMethodName:
   Enabled: false
 Naming/InclusiveLanguage:
   Enabled: true
+Naming/BlockForwarding: # new in 1.24
+  Enabled: true
 
 # ============================== Layout =============================
 Layout/LineLength:
@@ -117,6 +125,10 @@ Layout/SpaceBeforeBrackets:
   Enabled: true
 Layout/LineEndStringConcatenationIndentation:
   Enabled: true
+Layout/LineContinuationLeadingSpace: # new in 1.31
+  Enabled: true
+Layout/LineContinuationSpacing: # new in 1.31
+  Enabled: true
 
 # ============================== Style ==============================
 Style/RescueModifier:
@@ -247,6 +259,50 @@ Style/QuotedSymbols:
   Enabled: true
 Style/StringChars:
   Enabled: true
+Style/EmptyHeredoc: # new in 1.32
+  Enabled: true
+Style/EnvHome: # new in 1.29
+  Enabled: true
+Style/FetchEnvVar: # new in 1.28
+  Enabled: true
+Style/FileRead: # new in 1.24
+  Enabled: true
+Style/FileWrite: # new in 1.24
+  Enabled: true
+Style/MagicCommentFormat: # new in 1.35
+  Enabled: true
+Style/MapCompactWithConditionalBlock: # new in 1.30
+  Enabled: true
+Style/MapToHash: # new in 1.24
+  Enabled: true
+Style/NestedFileDirname: # new in 1.26
+  Enabled: true
+Style/NumberedParameters: # new in 1.22
+  Enabled: true
+Style/NumberedParametersLimit: # new in 1.22
+  Enabled: true
+Style/ObjectThen: # new in 1.28
+  Enabled: true
+Style/OpenStructUse: # new in 1.23
+  Enabled: true
+Style/OperatorMethodCall: # new in 1.37
+  Enabled: true
+Style/RedundantEach: # new in 1.38
+  Enabled: true
+Style/RedundantInitialize: # new in 1.27
+  Enabled: true
+Style/RedundantSelfAssignmentBranch: # new in 1.19
+  Enabled: true
+Style/RedundantStringEscape: # new in 1.37
+  Enabled: true
+Style/SelectByRegexp: # new in 1.22
+  Enabled: true
+
+# ============================== Security ==============================
+Security/CompoundHash: # new in 1.28
+  Enabled: true
+Security/IoMethods: # new in 1.22
+  Enabled: true
 
 # ============================== Lint ==============================
 Lint/DuplicateMethods:
@@ -335,3 +391,23 @@ Lint/AmbiguousAssignment:
   Enabled: true
 Lint/EmptyInPattern:
   Enabled: true
+Lint/AmbiguousOperatorPrecedence: # new in 1.21
+  Enabled: true
+Lint/AmbiguousRange: # new in 1.19
+  Enabled: true
+Lint/ConstantOverwrittenInRescue: # new in 1.31
+  Enabled: true
+Lint/DuplicateMagicComment: # new in 1.37
+  Enabled: true
+Lint/IncompatibleIoSelectWithFiberScheduler: # new in 1.21
+  Enabled: true
+Lint/NonAtomicFileOperation: # new in 1.31
+  Enabled: true
+Lint/RefinementImportMethods: # new in 1.27
+  Enabled: true
+Lint/RequireRangeParentheses: # new in 1.32
+  Enabled: true
+Lint/RequireRelativeSelfPath: # new in 1.22
+  Enabled: true
+Lint/UselessRuby2Keywords: # new in 1.23
+  Enabled: true

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 1.6.3
+* [PR](https://github.com/shlima/click_house/pull/38) Add option format for insert
+* [PR](https://github.com/shlima/click_house/pull/34) Support X-ClickHouse-Exception-Code header
+* [ISSUE](https://github.com/shlima/click_house/issues/33) Fix parameterized types parsing
+* Added LowCardinality DDL support
+* Fixed body logging with POST queries
+
 # 1.6.2
 * [PR](https://github.com/shlima/click_house/pull/31) Add rows_before_limit_at_least to ResultSet
 * [PR](https://github.com/shlima/click_house/pull/29) Force JSON format by using "default_format" instead of modifying the query

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    click_house (1.6.2)
+    click_house (1.7.0)
       faraday (>= 1.7)
       faraday_middleware
 
@@ -11,7 +11,7 @@ GEM
     ast (2.4.2)
     coderay (1.1.3)
     diff-lcs (1.5.0)
-    faraday (1.10.0)
+    faraday (1.10.2)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
@@ -36,48 +36,50 @@ GEM
     faraday-retry (1.0.3)
     faraday_middleware (1.2.0)
       faraday (~> 1.0)
+    json (2.6.2)
     method_source (1.0.0)
     multipart-post (2.2.3)
     parallel (1.22.1)
-    parser (3.1.1.0)
+    parser (3.1.2.1)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.2.1)
+    regexp_parser (2.6.0)
     rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.26.1)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.38.0)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.16.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.16.0)
+    rubocop-ast (1.23.0)
       parser (>= 3.1.1.0)
-    rubocop-performance (1.13.3)
+    rubocop-performance (1.15.0)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
-    unicode-display_width (2.1.0)
+    unicode-display_width (2.3.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -221,7 +221,7 @@ end
 ```ruby
 ClickHouse.connection.create_table('visits', if_not_exists: true, engine: 'MergeTree(date, (year, date), 8192)') do |t|
   t.FixedString :id, 16
-  t.UInt16      :year
+  t.UInt16      :year, low_cardinality: true
   t.Date        :date
   t.DateTime    :time, 'UTC'
   t.Decimal     :money, 5, 4

data/docker-compose.yml

@@ -2,7 +2,7 @@ version: '3.5'
 
 services:
   clickhouse:
-    image: clickhouse/clickhouse-server:22.6
+    image: clickhouse/clickhouse-server:22.9
     ports:
       - "8123:8123"
       - "9000:9000"

data/lib/click_house/connection.rb

@@ -53,9 +53,9 @@ module ClickHouse
         conn.headers = config.headers
         conn.ssl.verify = config.ssl_verify
         conn.request(:basic_auth, config.username, config.password) if config.auth?
+        conn.response :json, content_type: %r{application/json}
         conn.response Middleware::RaiseError
         conn.response Middleware::Logging, logger: config.logger!
-        conn.response :json, content_type: %r{application/json}
         conn.response Middleware::ParseCsv, content_type: %r{text/csv}
         conn.adapter config.adapter
       end

data/lib/click_house/definition/column.rb

@@ -6,6 +6,7 @@ module ClickHouse
       attr_accessor :name
       attr_accessor :type
       attr_accessor :nullable
+      attr_accessor :low_cardinality
       attr_accessor :extensions
       attr_accessor :default
       attr_accessor :materialized
@@ -17,10 +18,12 @@ module ClickHouse
       end
 
       def to_s
-        nullable ? "#{name} Nullable(#{extension_type}) #{opts}" : "#{name} #{extension_type} #{opts}"
-      end
+        type = extension_type
+        type = "Nullable(#{type})" if nullable
+        type = "LowCardinality(#{type})" if low_cardinality
 
-      private
+        "#{name} #{type} #{opts}"
+      end
 
       def opts
         options = {

data/lib/click_house/extend/connection_inserting.rb

@@ -14,8 +14,8 @@ module ClickHouse
       # end
       #
       # == Example with a param
-      # subject.insert('rspec', values: [{ name: 'Sun', id: 1 }, { name: 'Moon', id: 2 }])
-      def insert(table, columns: [], values: [])
+      # subject.insert('rspec', values: [{ name: 'Sun', id: 1 }, { name: 'Moon', id: 2 }], format: 'JSONStringsEachRow')
+      def insert(table, columns: [], values: [], format: 'JSONEachRow')
         yield(values) if block_given?
 
         body = if columns.empty?
@@ -26,7 +26,7 @@ module ClickHouse
 
         return EMPTY_INSERT if values.empty?
 
-        execute("INSERT INTO #{table} FORMAT JSONEachRow", body.join("\n")).success?
+        execute("INSERT INTO #{table} FORMAT #{format}", body.join("\n")).success?
       end
     end
   end

data/lib/click_house/extend/type_definition.rb

@@ -5,6 +5,7 @@ module ClickHouse
     module TypeDefinition
       NULLABLE = 'Nullable'
       NULLABLE_RE = /#{NULLABLE}/i.freeze
+      LOW_CARDINALITY = 'LowCardinality'
 
       def types
         @types ||= Hash.new(Type::UndefinedType.new)

data/lib/click_house/middleware/logging.rb

@@ -30,7 +30,7 @@ module ClickHouse
       def on_complete(env)
         summary = extract_summary(env.response_headers)
         logger.info("\e[1mSQL (#{duration_stats_log(env.body)})\e[0m #{query(env)};")
-        logger.debug(body) if body && !query_in_body?(env)
+        logger.debug(body) if body
         logger.info("\e[1mRead: #{summary.fetch(:read_rows)} rows, #{summary.fetch(:read_bytes)}. Written: #{summary.fetch(:written_rows)} rows, #{summary.fetch(:written_bytes)}\e[0m")
       end
       # rubocop:enable Layout/LineLength

data/lib/click_house/middleware/raise_error.rb

@@ -4,6 +4,7 @@ module ClickHouse
   module Middleware
     class RaiseError < Faraday::Middleware
       SUCCEED_STATUSES = (200..299).freeze
+      EXCEPTION_CODE_HEADER = 'x-clickhouse-exception-code'
 
       Faraday::Response.register_middleware self => self
 
@@ -16,6 +17,11 @@ module ClickHouse
       private
 
       def on_complete(env)
+        # Valid since Clickhouse 22.6
+        if env.response_headers.key?(EXCEPTION_CODE_HEADER)
+          raise DbException, env.body
+        end
+
         return if SUCCEED_STATUSES.include?(env.status)
 
         raise DbException, "[#{env.status}] #{env.body}"

data/lib/click_house/response/result_set.rb

@@ -9,6 +9,9 @@ module ClickHouse
       TYPE_ARGV_DELIM = ','
       NULLABLE = 'Nullable'
       NULLABLE_TYPE_RE = /#{NULLABLE}\((.+)\)/i.freeze
+      ARG_D_RE = /\A-?\d+\Z/.freeze
+      PLACEHOLDER_D = '%d'
+      PLACEHOLDER_S = '%s'
 
       def_delegators :to_a,
                      :inspect, :each, :fetch, :length, :count, :size,
@@ -25,10 +28,10 @@ module ClickHouse
         # @output "DateTime(%s)"
         #
         # @input "Nullable(Decimal(10, 5))"
-        # @output "Nullable(Decimal(%s, %s))"
+        # @output "Nullable(Decimal(%d, %d))"
         #
         # @input "Decimal(10, 5)"
-        # @output "Decimal(%s, %s)"
+        # @output "Decimal(%d, %d)"
         def extract_type_info(type)
           type = type.gsub(NULLABLE_TYPE_RE, '\1')
           nullable = Regexp.last_match(1)
@@ -37,9 +40,11 @@ module ClickHouse
           type = type.gsub(/\((.+)\)/, '')
 
           if (match = Regexp.last_match(1))
-            counter = Array.new(match.count(TYPE_ARGV_DELIM).next) { '%s' }
-            type = "#{type}(#{counter.join("#{TYPE_ARGV_DELIM} ")})"
             argv = match.split("#{TYPE_ARGV_DELIM} ")
+            placeholder = argv.map do |value|
+              value.match?(ARG_D_RE) ? PLACEHOLDER_D : PLACEHOLDER_S
+            end
+            type = "#{type}(#{placeholder.join("#{TYPE_ARGV_DELIM} ")})"
           end
 
           [nullable ? "#{NULLABLE}(#{type})" : type, argv]

data/lib/click_house/type/low_cardinality_type.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ClickHouse
+  module Type
+    class LowCardinalityType < BaseType
+      attr_reader :subtype
+
+      def initialize(subtype)
+        @subtype = subtype
+      end
+
+      def cast(*argv)
+        subtype.cast(*argv)
+      end
+
+      def serialize(*argv)
+        subtype.serialize(*argv)
+      end
+    end
+  end
+end

data/lib/click_house/type.rb

@@ -16,5 +16,6 @@ module ClickHouse
     autoload :ArrayType, 'click_house/type/array_type'
     autoload :StringType, 'click_house/type/string_type'
     autoload :IPType, 'click_house/type/ip_type'
+    autoload :LowCardinalityType, 'click_house/type/low_cardinality_type'
   end
 end

data/lib/click_house/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ClickHouse
-  VERSION = '1.6.2'
+  VERSION = '1.7.0'
 end

data/lib/click_house.rb

@@ -38,7 +38,7 @@ module ClickHouse
     add_type column, Type::DateTimeType.new
   end
 
-  ['DateTime64(%d, %s)'].each do |column|
+  ['DateTime64(%d)', 'DateTime64(%d, %s)'].each do |column|
     add_type column, Type::DateTime64Type.new
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: click_house
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.7.0
 platform: ruby
 authors:
 - Aliaksandr Shylau
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-28 00:00:00.000000000 Z
+date: 2022-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -183,6 +183,7 @@ files:
 - lib/click_house/type/float_type.rb
 - lib/click_house/type/integer_type.rb
 - lib/click_house/type/ip_type.rb
+- lib/click_house/type/low_cardinality_type.rb
 - lib/click_house/type/nullable_type.rb
 - lib/click_house/type/string_type.rb
 - lib/click_house/type/undefined_type.rb