click_house 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05f0f9426500a803ec5d2d37b1a2a06d2eb2d3e4b934eac19a434acc5086dc5c
-  data.tar.gz: c079c080dedbcc3342bbfde789099ddacf714a16029779bddbd8352d1912f1b0
+  metadata.gz: e21fcc0831f8f6612fac22c8e64eebb78b6e6f5d5d371c6db57dbfc0556610fd
+  data.tar.gz: 792ac875a51e3f545b9b49b55618a4161183056b82cad7e213d05ef46974d69c
 SHA512:
-  metadata.gz: f2f1d0d8f438b317ee475499e24f9d3ecae9f2b6a872a21695f11e0f8d744693790cd6f1caa50beab7e2c11f008952e453ca37d9282caeed18a95f54e99dff44
-  data.tar.gz: 17f7aff9dad97b3ad4384618b8cf8ce92f550ec9ee5b7ee524413458dce48f7eb08a69d4f78abf5862ac01acd33f1257de37403f6ce42595b152435819bc2e2f
+  metadata.gz: bca7f416a90d0d92046c8ac171511110fe2c02329e67260279b36a475bf2b59a0c65051c3f25f1f12f5ceb26bdabc659a94a75fea499fa0de65a9d3473d85156
+  data.tar.gz: 5eee878068a827c4875a65a4435b44c87adc2fbe83b824bbb143e9086dc6ae2aad5fe4a07d43efc3fcb5bf8c2cc56003d7ca56d7fc9a4cf17db717bff90caa41

data/.gitignore

@@ -6,6 +6,7 @@
 /spec/reports/
 /log/*
 /tmp/*
+/*.gem
 
 !/log/.keep
 !/tmp/.keep

data/Makefile

@@ -3,7 +3,10 @@
 help:
 	@echo 'Available targets:'
 	@echo '  make dockerize OR make ARGS="--build" dockerize'
+	@echo '  make release'
 
 dockerize:
-	rm -f tmp/pids/server.pid tmp/sockets/puma.sock
 	docker-compose up ${ARGS}
+
+release:
+	bin/release.sh

data/README.md

@@ -28,7 +28,9 @@ Despite we have full compatibility of protocol of different versions of client a
 * [Usage](#usage)
 * [Queries](#queries)
 * [Insert](#insert)
+* [Insert an Array](#insert-an-array)
 * [Create a table](#create-a-table)
+* [Alter table](#alter-table)
 * [Type casting](#type-casting)
 * [Using with a connection pool](#using-with-a-connection-pool)
 * [Using with Rails](#using-with-rails)
@@ -89,6 +91,11 @@ ClickHouse.connection.describe_table('visits') #=> [{"name"=>"id", "type"=>"Fixe
 ClickHouse.connection.table_exists?('visits', temporary: nil) #=> true
 ClickHouse.connection.drop_table('visits', if_exists: true, temporary: nil, cluster: nil)
 ClickHouse.connection.create_table(*) # see <Create a table> section
+ClickHouse.connection.truncate_table('name', if_exists: true, cluster: nil)
+ClickHouse.connection.truncate_tables(['table_1', 'table_2'], if_exists: true, cluster: nil)
+ClickHouse.connection.truncate_tables # will truncate all tables in database
+ClickHouse.connection.rename_table('old_name', 'new_name', cluster: nil)
+ClickHouse.connection.rename_table(%w[table_1 table_2], %w[new_1 new_2], cluster: nil)
 ```
 
 ## Queries
@@ -174,6 +181,24 @@ ClickHouse.connection.insert('table', columns: %i[id name], values: [[1, 'Mercur
 #=> true
 ```
 
+## Insert an Array
+
+Serializing an Array of strings is pretty low level at the moment but it works (and thanks for that).
+Array of numeric types works as expected without pre-serialization   
+
+```ruby
+string_type = ClickHouse::Type::StringType.new
+array_of_string = ClickHouse::Type::ArrayType.new(string_type)
+
+data = [
+  { id: 1, tags: array_of_string.serialize(%w[ruby redis rails node]) }
+]
+
+subject.insert('rspec', columns: data.first.keys) do |buffer|
+  buffer.concat(data.map(&:values))
+end
+```
+
 ## Create a table
 ### Create table using DSL
 
@@ -253,6 +278,27 @@ ClickHouse.connection.execute <<~SQL
 SQL
 ```
 
+## Alter table
+### Alter table with DSL
+```ruby
+ClickHouse.connection.add_column('table', 'column_name', :UInt64, default: nil, after: nil, cluster: nil)
+ClickHouse.connection.drop_column('table', 'column_name', if_exists: nil, cluster: nil)
+```
+
+### Alter table with SQL
+
+```ruby
+# By SQL in argument
+ClickHouse.connection.alter_table('table', 'DROP COLUMN user_id', cluster: nil)
+
+# By SQL in a block
+ClickHouse.connection.alter_table('table', cluster: nil) do 
+  <<~SQL
+    DROP COLUMN user_id
+  SQL  
+end
+```
+
 ## Type casting
 
 By default gem provides all necessary type casting, but you may overwrite or define
@@ -404,6 +450,23 @@ scope = Visit.with_os.select('COUNT(*) as counter').group(:ipv4)
 ClickHouse.connection.select_all(scope.to_sql)
 ```` 
 
+You can clear the data table before each test with RSpec
+
+```ruby
+RSpec.configure do |config|
+  config.before(:each, clean_click_house: true) do
+    ClickHouse.connection.truncate_tables
+  end
+end
+```
+
+```ruby
+RSpec.describe Api::MetricsCountroller, clean_click_house: true do 
+  it { }
+  it { }
+end
+```
+
 ## Development
 
 ```bash

data/bin/release.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+rm ./*.gem
+gem build click_house.gemspec
+gem push click_house-*

data/lib/click_house.rb

@@ -31,6 +31,11 @@ module ClickHouse
     add_type "Nullable(#{column})", Type::NullableType.new(Type::DateType.new)
   end
 
+  %w[String].each do |column|
+    add_type column, Type::StringType.new
+    add_type "Nullable(#{column})", Type::NullableType.new(Type::StringType.new)
+  end
+
   ['DateTime(%s)'].each do |column|
     add_type column, Type::DateTimeType.new
     add_type "Nullable(#{column})", Type::NullableType.new(Type::DateTimeType.new)

data/lib/click_house/connection.rb

@@ -7,6 +7,7 @@ module ClickHouse
     include Extend::ConnectionTable
     include Extend::ConnectionSelective
     include Extend::ConnectionInserting
+    include Extend::ConnectionAltering
 
     attr_reader :config
 

data/lib/click_house/errors.rb

@@ -4,4 +4,5 @@ module ClickHouse
   Error = Class.new(StandardError)
   NetworkException = Class.new(Error)
   DbException = Class.new(Error)
+  StatementException = Class.new(Error)
 end

data/lib/click_house/extend.rb

@@ -10,5 +10,6 @@ module ClickHouse
     autoload :ConnectionTable, 'click_house/extend/connection_table'
     autoload :ConnectionSelective, 'click_house/extend/connection_selective'
     autoload :ConnectionInserting, 'click_house/extend/connection_inserting'
+    autoload :ConnectionAltering, 'click_house/extend/connection_altering'
   end
 end

data/lib/click_house/extend/connection_altering.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# rubocop:disable Metrics/ParameterLists
+module ClickHouse
+  module Extend
+    module ConnectionAltering
+      def add_column(table, name, type, default: nil, if_not_exists: false, after: nil, cluster: nil)
+        sql = 'ADD COLUMN %<exists>s %<name>s %<type>s %<default>s %<after>s'
+
+        pattern = {
+          name: name,
+          exists: Util::Statement.ensure(if_not_exists, 'IF NOT EXISTS'),
+          type: Util::Statement.ensure(type, type),
+          default: Util::Statement.ensure(default, "DEFAULT #{default}"),
+          after: Util::Statement.ensure(after, "AFTER #{after}")
+        }
+
+        alter_table(table, format(sql, pattern), cluster: cluster)
+      end
+
+      def drop_column(table, name, if_exists: false, cluster: nil)
+        sql = 'DROP COLUMN %<exists>s %<name>s'
+
+        pattern = {
+          name: name,
+          exists: Util::Statement.ensure(if_exists, 'IF EXISTS')
+        }
+
+        alter_table(table, format(sql, pattern), cluster: cluster)
+      end
+
+      def alter_table(name, sql = nil, cluster: nil)
+        template = 'ALTER TABLE %<name>s %<cluster>s %<sql>s'
+        sql = yield(sql) if sql.nil?
+
+        pattern = {
+          name: name,
+          sql: sql,
+          cluster: Util::Statement.ensure(cluster, "ON CLUSTER #{cluster}"),
+        }
+
+        execute(format(template, pattern)).success?
+      end
+    end
+  end
+end
+# rubocop:enable Metrics/ParameterLists

data/lib/click_house/extend/connection_table.rb

@@ -68,14 +68,48 @@ module ClickHouse
           sample: Util::Statement.ensure(sample, "SAMPLE BY  #{sample}"),
           ttl: Util::Statement.ensure(ttl, "TTL #{ttl}"),
           settings: Util::Statement.ensure(settings, "SETTINGS #{settings}"),
-          engine: Util::Statement.ensure(engine, "ENGINE = #{engine}"),
+          engine: Util::Statement.ensure(engine, "ENGINE = #{engine}")
         }
 
-        puts format(sql, pattern)
-
         execute(format(sql, pattern)).success?
       end
       # rubocop:enable Metrics/ParameterLists
+
+      def truncate_table(name, if_exists: false, cluster: nil)
+        sql = 'TRUNCATE TABLE %<exists>s %<name>s %<cluster>s'
+
+        pattern = {
+          name: name,
+          exists: Util::Statement.ensure(if_exists, 'IF EXISTS'),
+          cluster: Util::Statement.ensure(cluster, "ON CLUSTER #{cluster}")
+        }
+
+        execute(format(sql, pattern)).success?
+      end
+
+      def truncate_tables(names = tables, *argv)
+        Array(names).each { |name| truncate_table(name, *argv) }
+      end
+
+      def rename_table(from, to, cluster: nil)
+        from = Array(from)
+        to = Array(to)
+
+        unless from.length == to.length
+          raise StatementException, '<from> tables length should equal <to> length'
+        end
+
+        sql = <<~SQL
+          RENAME TABLE %<names>s %<cluster>s
+        SQL
+
+        pattern = {
+          names: from.zip(to).map { |a| a.join(' TO ') }.join(', '),
+          cluster: Util::Statement.ensure(cluster, "ON CLUSTER #{cluster}")
+        }
+
+        execute(format(sql, pattern)).success?
+      end
     end
   end
 end

data/lib/click_house/response/result_set.rb

@@ -9,7 +9,7 @@ module ClickHouse
       TYPE_ARGV_DELIM = ','
       NULLABLE = 'Nullable'
 
-      def_delegators :to_a, :each, :fetch
+      def_delegators :to_a, :each, :fetch, :length, :count, :size
 
       attr_reader :meta, :data, :statistics
 

data/lib/click_house/type.rb

@@ -12,5 +12,7 @@ module ClickHouse
     autoload :BooleanType, 'click_house/type/boolean_type'
     autoload :DecimalType, 'click_house/type/decimal_type'
     autoload :FixedStringType, 'click_house/type/fixed_string_type'
+    autoload :ArrayType, 'click_house/type/array_type'
+    autoload :StringType, 'click_house/type/string_type'
   end
 end

data/lib/click_house/type/array_type.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module ClickHouse
+  module Type
+    class ArrayType < BaseType
+      attr_reader :subtype
+
+      STRING_QUOTE = "'"
+
+      def initialize(subtype)
+        @subtype = subtype
+      end
+
+      def cast(value, *)
+        value
+      end
+
+      def serialize(array, *argv)
+        return array unless string?
+
+        serialized = array.map do |value|
+          escaped = subtype.serialize(value, *argv).tr(STRING_QUOTE, '\\\\' + STRING_QUOTE)
+          format("%<quote>s#{escaped}%<quote>s", quote: STRING_QUOTE)
+        end
+
+        "[#{serialized.join(',')}]"
+      end
+
+      private
+
+      def string?
+        return @is_string if defined?(@is_string)
+
+        @is_string = subtype.is_a?(StringType) || subtype.is_a?(FixedStringType)
+      end
+    end
+  end
+end

data/lib/click_house/type/string_type.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ClickHouse
+  module Type
+    class StringType < BaseType
+      def cast(value)
+        value.to_s unless value.nil?
+      end
+
+      def serialize(value)
+        value.to_s unless value.nil?
+      end
+    end
+  end
+end

data/lib/click_house/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: click_house
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Aliaksandr Shylau
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-09 00:00:00.000000000 Z
+date: 2019-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -139,6 +139,7 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/release.sh
 - bin/setup
 - click_house.gemspec
 - doc/logo.svg
@@ -153,6 +154,7 @@ files:
 - lib/click_house/extend.rb
 - lib/click_house/extend/configurable.rb
 - lib/click_house/extend/connectible.rb
+- lib/click_house/extend/connection_altering.rb
 - lib/click_house/extend/connection_database.rb
 - lib/click_house/extend/connection_healthy.rb
 - lib/click_house/extend/connection_inserting.rb
@@ -167,6 +169,7 @@ files:
 - lib/click_house/response/factory.rb
 - lib/click_house/response/result_set.rb
 - lib/click_house/type.rb
+- lib/click_house/type/array_type.rb
 - lib/click_house/type/base_type.rb
 - lib/click_house/type/boolean_type.rb
 - lib/click_house/type/date_time_type.rb
@@ -176,6 +179,7 @@ files:
 - lib/click_house/type/float_type.rb
 - lib/click_house/type/integer_type.rb
 - lib/click_house/type/nullable_type.rb
+- lib/click_house/type/string_type.rb
 - lib/click_house/type/undefined_type.rb
 - lib/click_house/util.rb
 - lib/click_house/util/pretty.rb