clickhouse-activerecord 0.3.8 → 0.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1d313720b1a43f19f51e6fa9e88ef40d136130e9
-  data.tar.gz: e82dbfb65bd38fa50df9304690bd116eef021a70
+SHA256:
+  metadata.gz: 69358e69c13cdf1d70ec417e4ef9e4374578eb63144bc713bdd3e934702d8118
+  data.tar.gz: 2a52857c0080ad2959c8d34b52a43185f911ff215ac52c1584dacc52e3047f1e
 SHA512:
-  metadata.gz: 8fed861c69428580cddb00c79656ac7614bd26f5c47cdc0a6e4378b0578f4935aec86430b5523f599a97753be329482a8e766471b505d1fd04961ad98ac0415f
-  data.tar.gz: 581d95bdc952a7be4d5645ea0948011f7c67ca6b145c3607774a9770997382fa36279b6029b4128d43909948658b956db64d0d185351eee1f6f756cbaa36bd7c
+  metadata.gz: b7a6c0845166b79e719e1fff667de0dfb38e132154a6acdf862d50cb82d7281dbecd53f4c4e756b5bc5e30ad3b6b3aa710eebb8220f0f496991fd4e01513238f
+  data.tar.gz: f3987a2a0a77233a37ecb1805b6e4bd0dce76ce2bf2c18fc58e62ee62bb9a573ac8851cf06f56d0b1bf80e8fe3a14eda1105fdd3f472c4f54694fd0811fd2bcd

data/README.md

@@ -1,6 +1,7 @@
 # Clickhouse::Activerecord
 
 A Ruby database ActiveRecord driver for ClickHouse. Support Rails >= 5.2.
+Tested on ClickHouse version 18.14.
 
 ## Installation
 
@@ -17,8 +18,22 @@ And then execute:
 Or install it yourself as:
 
     $ gem install clickhouse-activerecord
+    
+## Available database connection parameters
+```yml
+default: &default
+  adapter: clickhouse
+  database: database
+  host: localhost
+  port: 8123
+  username: username
+  password: password
+  ssl: true # optional for using ssl connection
+  debug: true # use for showing in to log technical information
+  migrations_paths: db/clickhouse # optional, default: db/migrate_clickhouse
+```
 
-## Usage
+## Usage in Rails 5
 
 Add your `database.yml` connection information with postfix `_clickhouse` for you environment:
 
@@ -26,10 +41,6 @@ Add your `database.yml` connection information with postfix `_clickhouse` for yo
 development_clickhouse:
   adapter: clickhouse
   database: database
-  host: localhost
-  username: username
-  password: password
-  debug: true # use for showing in to log technical information
 ```
 
 Add to your model:
@@ -54,13 +65,34 @@ Or global connection:
 development:
   adapter: clickhouse
   database: database
-  host: localhost
-  username: username
-  password: password
+```
+
+## Usage in Rails 6 with second database
+
+Add your `database.yml` connection information for you environment:
+
+```yml
+development:
+  primary:
+    ...
+    
+  clickhouse:
+    adapter: clickhouse
+    database: database
+```
+
+Connection [Multiple Databases with Active Record](https://guides.rubyonrails.org/active_record_multiple_databases.html) or short example:
+
+```ruby
+class Action < ActiveRecord::Base
+  connects_to database: { writing: :clickhouse, reading: :clickhouse }
+end
 ```
 
 ### Rake tasks
 
+**Note!** For Rails 6 you can use default rake tasks if you configure `migrations_paths` in your `database.yml`, for example: `rake db:migrate`
+
 Create / drop / purge / reset database:
  
     $ rake clickhouse:create

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

@@ -38,37 +38,6 @@ module ActiveRecord
           { options: sql.gsub(/^(?:.*?)ENGINE = (.*?)$/, '\\1') }
         end
 
-        # @todo copied from  ActiveRecord::ConnectionAdapters::SchemaStatements v5.2.2
-        # Why version column type of String, but insert to Integer?
-        def assume_migrated_upto_version(version, migrations_paths)
-          migrations_paths = Array(migrations_paths)
-          version = version.to_i
-          sm_table = quote_table_name(ActiveRecord::SchemaMigration.table_name)
-
-          migrated = ActiveRecord::SchemaMigration.all_versions.map(&:to_i)
-          versions = migration_context.migration_files.map do |file|
-            migration_context.parse_migration_filename(file).first.to_i
-          end
-
-          unless migrated.include?(version)
-            do_execute( "INSERT INTO #{sm_table} (version) VALUES (#{quote(version.to_s)})", 'SchemaMigration', format: nil)
-          end
-
-          inserting = (versions - migrated).select { |v| v < version }
-          if inserting.any?
-            if (duplicate = inserting.detect { |v| inserting.count(v) > 1 })
-              raise "Duplicate migration #{duplicate}. Please renumber your migrations to resolve the conflict."
-            end
-            if supports_multi_insert?
-              do_system_execute insert_versions_sql(inserting.map(&:to_s))
-            else
-              inserting.each do |v|
-                do_system_execute insert_versions_sql(v)
-              end
-            end
-          end
-        end
-
         # Not indexes on clickhouse
         def indexes(table_name, name = nil)
           []
@@ -86,21 +55,22 @@ module ActiveRecord
           end
         end
 
-        private
-
-        def apply_format(sql, format)
-          format ? "#{sql} FORMAT #{format}" : sql
-        end
-
-        def do_execute(sql, name = nil, format: 'JSONCompact')
+        def do_execute(sql, name = nil, format: 'JSONCompact', settings: {})
           log(sql, "#{adapter_name} #{name}") do
             formatted_sql = apply_format(sql, format)
-            res = @connection.post("/?#{@config.to_param}", formatted_sql)
+            request_params = @config || {}
+            res = @connection.post("/?#{request_params.merge(settings).to_param}", formatted_sql)
 
             process_response(res)
           end
         end
 
+        private
+
+        def apply_format(sql, format)
+          format ? "#{sql} FORMAT #{format}" : sql
+        end
+
         def process_response(res)
           case res.code.to_i
           when 200
@@ -121,7 +91,11 @@ module ActiveRecord
         end
 
         def create_table_definition(*args)
-          Clickhouse::TableDefinition.new(*args)
+          if ActiveRecord::version >= Gem::Version.new('6')
+            Clickhouse::TableDefinition.new(self, *args)
+          else
+            Clickhouse::TableDefinition.new(*args)
+          end
         end
 
         def new_column_from_field(table_name, field)

data/lib/active_record/connection_adapters/clickhouse_adapter.rb

@@ -18,6 +18,7 @@ module ActiveRecord
         config = config.symbolize_keys
         host = config[:host] || 'localhost'
         port = config[:port] || 8123
+        ssl = config[:ssl].present? ? config[:ssl] : port == 443
 
         if config.key?(:database)
           database = config[:database]
@@ -25,7 +26,7 @@ module ActiveRecord
           raise ArgumentError, 'No database specified. Missing argument: database.'
         end
 
-        ConnectionAdapters::ClickhouseAdapter.new(nil, logger, [host, port], { user: config[:username], password: config[:password], database: database }.compact, config[:debug])
+        ConnectionAdapters::ClickhouseAdapter.new(logger, [host, port, ssl], { user: config[:username], password: config[:password], database: database }.compact, config)
       end
     end
   end
@@ -92,21 +93,34 @@ module ActiveRecord
       include Clickhouse::SchemaStatements
 
       # Initializes and connects a Clickhouse adapter.
-      def initialize(connection, logger, connection_parameters, config, debug = false)
-        super(connection, logger)
+      def initialize(logger, connection_parameters, config, full_config)
+        super(nil, logger)
         @connection_parameters = connection_parameters
         @config = config
-        @debug = debug
+        @debug = full_config[:debug] || false
+        @full_config = full_config
 
-        if ActiveRecord::version >= Gem::Version.new('6')
+        @prepared_statements = false
+        if ActiveRecord::version == Gem::Version.new('6.0.0')
           @prepared_statement_status = Concurrent::ThreadLocalVar.new(false)
-        else
-          @prepared_statements = false
         end
 
         connect
       end
 
+      # Support SchemaMigration from v5.2.2 to v6+
+      def schema_migration # :nodoc:
+        if ActiveRecord::version >= Gem::Version.new('6')
+          super
+        else
+          ActiveRecord::SchemaMigration
+        end
+      end
+
+      def migrations_paths
+        @full_config[:migrations_paths] || 'db/migrate_clickhouse'
+      end
+
       def arel_visitor # :nodoc:
         ClickhouseActiverecord::Arel::Visitors::ToSql.new(self)
       end
@@ -217,8 +231,7 @@ module ActiveRecord
       private
 
       def connect
-        # for ssl port need use ssl
-        @connection = Net::HTTP.start(@connection_parameters[0], @connection_parameters[1], use_ssl: @connection_parameters[1] == 443)
+        @connection = Net::HTTP.start(@connection_parameters[0], @connection_parameters[1], use_ssl: @connection_parameters[2], verify_mode: OpenSSL::SSL::VERIFY_NONE)
       end
     end
   end

data/lib/clickhouse-activerecord/version.rb

@@ -1,3 +1,3 @@
 module ClickhouseActiverecord
-  VERSION = '0.3.8'
+  VERSION = '0.3.9'
 end

data/lib/generators/clickhouse_migration_generator.rb

@@ -6,6 +6,20 @@ class ClickhouseMigrationGenerator < ActiveRecord::Generators::MigrationGenerato
   def create_migration_file
     set_local_assigns!
     validate_file_name!
-    migration_template @migration_template, "db/migrate_clickhouse/#{file_name}.rb"
+    migration_template @migration_template, File.join(db_migrate_path, "#{file_name}.rb")
+  end
+
+  private
+
+  def db_migrate_path
+    if defined?(Rails.application) && Rails.application
+      configured_migrate_path || default_migrate_path
+    else
+      default_migrate_path
+    end
+  end
+
+  def default_migrate_path
+    "db/migrate_clickhouse"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clickhouse-activerecord
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.3.9
 platform: ruby
 authors:
 - Sergey Odintsov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-04 00:00:00.000000000 Z
+date: 2019-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -147,8 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: ClickHouse ActiveRecord