click_house 1.6.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 402590e2de7189b46fca70711b33bf8428ccbc677d8d98ad4205b470bcf5eeb4
-  data.tar.gz: b3a33602650115c46c638347b993d118921e7254a2ed9f20bdb92ad30c50a05a
+  metadata.gz: 85fbf603cf09ee0a076a3ca0fa0add17c167919c458008a5616a4a7b064b0790
+  data.tar.gz: 95cf0f595c70a2943bba62a0d8568b4f432b3fdf27365b036377a66960733efe
 SHA512:
-  metadata.gz: 4d71565e61efb57711463fa3b4071d418ad8136656d64e3de15fbb7f4b48134ab284e9b2dc13b0dcbdf77dd9bee19aa4757593b0dee98480ac6cd64cc4e85a5f
-  data.tar.gz: c2d45bd01a211acfb8be077d38ac93807c191c95a3a6fe2a6ac63a7a097b5c599351f0c6282b86d533eff2dd59d2820c0f824ffd975d0cd6692636eb0bb31e48
+  metadata.gz: 8a31451c3ed68aa5ff213cabaa51578723212fe43d0e63a1b58a1d68b135facece27f2d52025512d41862ba7495dcd05972f3a9cd8a4d01cc25916e2e502f42b
+  data.tar.gz: 0d78cbad863fcb89e8d58da4c10eeec60013877c5097480c0e6bc190c9698641f5ac95c116bd3b938f7ce927aa58ad10abae73729ce579149d40a51e529320c7

data/.github/workflows/main.yml

@@ -14,7 +14,7 @@ jobs:
 
     strategy:
       matrix:
-        ruby-version: [3.1, 3.0, 2.7, 2.6]
+        ruby-version: [3.1, '3.0', 2.7, 2.6]
 
     steps:
       - uses: actions/checkout@v2
@@ -23,19 +23,7 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby-version }}
-
-      - name: Cache gems
-        uses: actions/cache@v1
-        with:
-          path: vendor/bundle
-          key: ${{ runner.os }}-${{ matrix.ruby-version }}-bundler-${{ hashFiles('**/Gemfile.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-${{ matrix.ruby-version }}-bundler-
-
-      - name: Install gems
-        run: |
-          bundle config path vendor/bundle
-          bundle install --jobs 4 --retry 3
+          bundler-cache: true # 'bundle install' and cache
 
       - name: Run tests
         run: bundle exec rspec
@@ -50,19 +38,7 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.7
-
-      - name: Cache gems
-        uses: actions/cache@v1
-        with:
-          path: vendor/bundle
-          key: ${{ runner.os }}-bundler-${{ hashFiles('**/Gemfile.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-bundler-
-
-      - name: Install gems
-        run: |
-          bundle config path vendor/bundle
-          bundle install --jobs 4 --retry 3
+          bundler-cache: true # 'bundle install' and cache
 
       - name: Run Rubocop
         run: bundle exec rubocop

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 1.6.1
+* [PR](https://github.com/shlima/click_house/pull/26) call logging middleware when an error is raised
+
 # 1.6.0
 * [PR](https://github.com/shlima/click_house/pull/19) handle value returned as nil in float and integer types (case of Aggregate Function Combinators) 
 * [PR](https://github.com/shlima/click_house/pull/18) Fix Faraday deprecation

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    click_house (1.5.0)
+    click_house (1.6.1)
       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.9.3)
+    faraday (1.10.0)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
@@ -38,41 +38,41 @@ GEM
       faraday (~> 1.0)
     method_source (1.0.0)
     multipart-post (2.1.1)
-    parallel (1.21.0)
-    parser (3.1.0.0)
+    parallel (1.22.1)
+    parser (3.1.1.0)
       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.0)
+    regexp_parser (2.2.1)
     rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.2)
+    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)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
-    rubocop (1.25.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.26.1)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.15.1, < 2.0)
+      rubocop-ast (>= 1.16.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.15.1)
-      parser (>= 3.0.1.1)
-    rubocop-performance (1.13.2)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.13.3)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)

data/README.md

@@ -10,8 +10,8 @@
 gem install click_house
 ```
 
-A modern Ruby database driver for ClickHouse. [ClickHouse](https://clickhouse.yandex) 
-is a high-performance column-oriented database management system developed by 
+A modern Ruby database driver for ClickHouse. [ClickHouse](https://clickhouse.yandex)
+is a high-performance column-oriented database management system developed by
 [Yandex](https://yandex.com/company) which operates Russia's most popular search engine.
 
 > This development was inspired by currently [unmaintainable alternative](https://github.com/archan937/clickhouse)
@@ -24,7 +24,7 @@ Well, the developers of ClickHouse themselves [discourage](https://github.com/ya
 > TCP transport is more specific, we don't want to expose details.
 Despite we have full compatibility of protocol of different versions of client and server, we want to keep the ability to "break" it for very old clients. And that protocol is not too clean to make a specification.
 
-Yandex uses HTTP interface for working from Java and Perl, Python and Go as well as shell scripts. 
+Yandex uses HTTP interface for working from Java and Perl, Python and Go as well as shell scripts.
 
 # TOC
 
@@ -53,15 +53,18 @@ ClickHouse.config do |config|
   config.open_timeout = 3
   config.ssl_verify = false
   config.headers = {}
-  
+
   # or provide connection options separately
-  config.scheme = 'http' 
-  config.host = 'localhost' 
-  config.port = 'port' 
-  
+  config.scheme = 'http'
+  config.host = 'localhost'
+  config.port = 'port'
+
   # if you use HTTP basic Auth
-  config.username = 'user' 
-  config.password = 'password' 
+  config.username = 'user'
+  config.password = 'password'
+
+  # if you want to add settings to all queries
+  config.global_params = { mutations_sync: 1 }
 end
 ```
 
@@ -76,7 +79,7 @@ Now you are able to communicate with ClickHouse:
 ```ruby
 ClickHouse.connection.ping #=> true
 ```
-You can easily build a new raw connection and override any configuration parameter 
+You can easily build a new raw connection and override any configuration parameter
 (such as database name, connection address)
 
 ```ruby
@@ -126,8 +129,8 @@ Select all type-casted result set
 @result.to_a #=> [{"date"=>#<Date: 2000-01-01>, "id"=>1}]
 
 # you can access raw data
-@result.meta #=> [{"name"=>"date", "type"=>"Date"}, {"name"=>"id", "type"=>"UInt32"}] 
-@result.data #=> [{"date"=>"2000-01-01", "id"=>1}, {"date"=>"2000-01-02", "id"=>2}] 
+@result.meta #=> [{"name"=>"date", "type"=>"Date"}, {"name"=>"id", "type"=>"UInt32"}]
+@result.data #=> [{"date"=>"2000-01-01", "id"=>1}, {"date"=>"2000-01-02", "id"=>2}]
 @result.statistics #=> {"elapsed"=>0.0002271, "rows_read"=>2, "bytes_read"=>12}
 ```
 
@@ -182,7 +185,7 @@ response = ClickHouse.connection.execute <<~SQL
   SELECT count(*) AS counter FROM rspec FORMAT RowBinary
 SQL
 
-response.body #=> "\u0002\u0000\u0000\u0000\u0000\u0000\u0000\u0000" 
+response.body #=> "\u0002\u0000\u0000\u0000\u0000\u0000\u0000\u0000"
 ```
 
 ## Insert
@@ -193,7 +196,7 @@ When column names and values are transferred separately
 ClickHouse.connection.insert('table', columns: %i[id name]) do |buffer|
   buffer << [1, 'Mercury']
   buffer << [2, 'Venus']
-end 
+end
 
 ClickHouse.connection.insert('table', columns: %i[id name], values: [[1, 'Mercury'], [2, 'Venus']])
 #=> true
@@ -272,7 +275,7 @@ end
 ### Set table options
 
 ```ruby
-ClickHouse.connection.create_table('visits', 
+ClickHouse.connection.create_table('visits',
   order: 'year',
   ttl: 'date + INTERVAL 1 DAY',
   sample: 'year',
@@ -308,24 +311,24 @@ ClickHouse.connection.modify_column('table', 'column_name', type: :UInt64, defau
 ClickHouse.connection.alter_table('table', 'DROP COLUMN user_id', cluster: nil)
 
 # By SQL in a block
-ClickHouse.connection.alter_table('table', cluster: nil) do 
+ClickHouse.connection.alter_table('table', cluster: nil) do
   <<~SQL
     MOVE PART '20190301_14343_16206_438' TO VOLUME 'slow'
-  SQL  
+  SQL
 end
 ```
 
 ## Type casting
 
 By default gem provides all necessary type casting, but you may overwrite or define
-your own logic 
+your own logic
 
 ```ruby
 class DateType
   def cast(value)
     Date.parse(value)
-  end 
-  
+  end
+
   def serialize(value)
     value.strftime('%Y-%m-%d')
   end
@@ -338,7 +341,7 @@ Actually `serialize` function is not used for now, but you may use it manually:
 
 ```ruby
 time_type = ClickHouse::Type::DateTimeType.new
-string_type = ClickHouse::Type::FixedStringType.new 
+string_type = ClickHouse::Type::FixedStringType.new
 
 ClickHouse.connection.insert('table', columns: %i[name time]) do |buffer|
   buffer << [string_type.serialize('a' * 1000, 20), time_type.serialize(Time.current, 'Europe/Moscow')]
@@ -353,20 +356,20 @@ data = @records.map do |record|
 end
 ```
 
-If native type supports arguments, define *String* type with `%s` 
+If native type supports arguments, define *String* type with `%s`
 argument and *Numeric* type with `%d` argument:
 
 ```ruby
 class DateTimeType
   def cast(value, time_zone)
     Time.parse("#{value} #{time_zone}")
-  end 
+  end
 end
 
 ClickHouse.add_type('DateTime(%s)', DateTimeType.new)
 ```
 
-if you need to redefine all built-in types with your implementation, 
+if you need to redefine all built-in types with your implementation,
 just clear the default type system:
 
 ```ruby
@@ -406,7 +409,7 @@ development:
 test:
   database: ecliptic_test
   <<: *default
-  
+
 production:
   <<: *default
   database: ecliptic_production
@@ -418,7 +421,7 @@ production:
 ClickHouse.config do |config|
   config.logger = Rails.logger
   config.assign(Rails.application.config_for('click_house'))
-end 
+end
 ```
 
 ```ruby
@@ -465,7 +468,7 @@ class CreateAdvertVisits < ActiveRecord::Migration[6.0]
     end
   end
 
-  def down    
+  def down
     ClickHouse.connection.drop_table('visits')
   end
 end
@@ -509,7 +512,7 @@ end
 ````
 
 ````ruby
-# FAKE MODEL FOR ClickHouse 
+# FAKE MODEL FOR ClickHouse
 class Visit < ClickHouseRecord
   scope :with_os, -> { where.not(os_family_id: nil) }
 end
@@ -517,12 +520,12 @@ end
 Visit.with_os.select('COUNT(*) as counter').group(:ipv4).select_all
 #=> [{ 'ipv4' => 1455869, 'counter' => 104 }]
 
-Visit.with_os.select('COUNT(*)').select_value 
+Visit.with_os.select('COUNT(*)').select_value
 #=> 20_345_678
- 
-Visit.where(user_id: 1).select_one 
-#=> { 'ipv4' => 1455869, 'user_id' => 1 }  
-```` 
+
+Visit.where(user_id: 1).select_one
+#=> { 'ipv4' => 1455869, 'user_id' => 1 }
+````
 
 ## Using with RSpec
 
@@ -537,7 +540,7 @@ end
 ```
 
 ```ruby
-RSpec.describe Api::MetricsCountroller, truncate_click_house: true do 
+RSpec.describe Api::MetricsCountroller, truncate_click_house: true do
   it { }
   it { }
 end

data/click_house.gemspec

@@ -17,8 +17,6 @@ Gem::Specification.new do |spec|
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
   spec.add_dependency 'faraday', '>= 1.7'

data/lib/click_house/config.rb

@@ -15,7 +15,8 @@ module ClickHouse
       timeout: nil,
       open_timeout: nil,
       ssl_verify: false,
-      headers: {}
+      headers: {},
+      global_params: {}
     }.freeze
 
     attr_accessor :adapter
@@ -31,6 +32,7 @@ module ClickHouse
     attr_accessor :open_timeout
     attr_accessor :ssl_verify
     attr_accessor :headers
+    attr_accessor :global_params
 
     def initialize(params = {})
       assign(DEFAULTS.merge(params))

data/lib/click_house/connection.rb

@@ -17,8 +17,8 @@ module ClickHouse
       @config = config
     end
 
-    def execute(query, body = nil, database: config.database)
-      post(body, query: { query: query }, database: database)
+    def execute(query, body = nil, database: config.database, params: {})
+      post(body, query: { query: query }, database: database, params: config.global_params.merge(params))
     end
 
     # @param path [String] Clickhouse HTTP endpoint, e.g. /ping, /replica_status
@@ -42,8 +42,8 @@ module ClickHouse
       end
     end
 
-    def post(body = nil, query: {}, database: config.database)
-      transport.post(compose('/', query.merge(database: database)), body)
+    def post(body = nil, query: {}, database: config.database, params: {})
+      transport.post(compose('/', query.merge(database: database, **params)), body)
     end
 
     def transport
@@ -53,8 +53,8 @@ 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 Middleware::Logging, logger: config.logger!
         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

data/lib/click_house/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: click_house
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.6.1
 platform: ruby
 authors:
 - Aliaksandr Shylau
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2022-01-21 00:00:00.000000000 Z
+date: 2022-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -210,7 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Modern Ruby database driver for ClickHouse