clickhouse-activerecord 1.6.1 → 1.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e606a08261b2238dab5e6fbd6fb826fb40631ea063d9dcfc25d99aab052d619
-  data.tar.gz: ad9281c124450ad0784c8442c4b20b3c8603f7028ca94f7aa1dbd73d8b0483d3
+  metadata.gz: 5bfabbcebb77881c7199f5895b1c3e4a7066c2eddaeec138432434f0a754fb70
+  data.tar.gz: a17ff604e9b01015f4a100f1e83267aad340c847541f8aeb0467d083afeb789a
 SHA512:
-  metadata.gz: 70e11a39c963dedc824a9b5b54b805902691f9ed335a33796524ffd50c2f1a3bdea65709accc9847239123973c1b3f77fd675ca0ac40022195c54f5c9410ce96
-  data.tar.gz: 768f6a409b98b66a80a6455d97fe4053f97dc60c35ee64d9a9a0310d64a6dbc00fe4b65bba90e7433114d536ed666f6716f2c1c05f13f34287f3e7f0905ebcb1
+  metadata.gz: 266b0794fe05ec58183b61cb7b7e8cefd99b44ce7fbc8a92810651f897dff514df09b48f16e8d50cdd394d7f00833039094caaf671c7e322a1a3b44c470b05df
+  data.tar.gz: afb3f2a22842ea4caef138ab206e73151fe237f89fa136c0fb2f4b1b160ff9e5594b4045224f8ab0c46512e1fe158eaf35cd698a66f4ff9d1542c69baebf9fa8

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### Version 1.6.3 (Feb 04, 2026)
+
+* Rename method `execute_streaming` to `execute_to_file`
+
+### Version 1.6.2 (Jan 30, 2026)
+
+* Add streaming request and save response to tmp file
+
 ### Version 1.6.1 (Jan 20, 2026)
 
 * Fix prepare rake task on ClickHouse 24.6

data/README.md

@@ -235,6 +235,14 @@ Action.with(ActionView.select(Arel.sql('min(date)')) => :min_date).where(Arel.sq
 #=> #<ActiveRecord::Relation [#<Action *** >]>
 ```
 
+### Streaming request
+
+```ruby
+path = Action.connection.execute_to_file(Action.where(date: Date.current), format: 'CSVWithNames')
+# Clickhouse Stream (10.3ms)  SELECT actions.* FROM actions WHERE actions.date = '2017-11-29'
+file = File.open(path)
+```
+
 
 ### Migration Data Types
 

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

@@ -53,6 +53,19 @@ module ActiveRecord
           end
         end
 
+        # Execute an SQL query and save the result to a file in stream mode
+        # @return [String]
+        def execute_to_file(sql, name = nil, format: @response_format, settings: {})
+          with_response_format(format) do
+            log(sql, [adapter_name, 'Stream', name].compact.join(' ')) do
+              statement = Statement.new(sql, format: @response_format)
+              request(statement, settings: settings) do |response|
+                return statement.streaming_response(response)
+              end
+            end
+          end
+        end
+
         def exec_insert(sql, name = nil, _binds = [], _pk = nil, _sequence_name = nil, returning: nil)
           new_sql = sql.sub(/ (DEFAULT )?VALUES/, " VALUES")
           with_response_format(nil) { execute(new_sql, name) }
@@ -268,8 +281,8 @@ module ActiveRecord
 
         def raw_execute(sql, settings: {}, except_params: [])
           statement = Statement.new(sql, format: @response_format)
-          statement.response = request(statement, settings: settings, except_params: except_params)
-          statement.processed_response
+          response = request(statement, settings: settings, except_params: except_params)
+          statement.processed_response(response)
         end
 
         # Make HTTP request to ClickHouse server
@@ -277,12 +290,13 @@ module ActiveRecord
         # @param [Hash] settings
         # @param [Array] except_params
         # @return [Net::HTTPResponse]
-        def request(statement, settings: {}, except_params: [])
+        def request(statement, settings: {}, except_params: [], &block)
           @lock.synchronize do
-            @connection.post("/?#{settings_params(settings, except: except_params)}",
-                             statement.formatted_sql,
-                             'Content-Type' => 'application/x-www-form-urlencoded',
-                             'User-Agent' => ClickhouseAdapter::USER_AGENT)
+            req = Net::HTTP::Post.new("/?#{settings_params(settings, except: except_params)}", {
+              'Content-Type' => 'application/x-www-form-urlencoded',
+              'User-Agent' => ClickhouseAdapter::USER_AGENT,
+            })
+            @connection.request(req, statement.formatted_sql, &block)
           end
         end
 

data/lib/active_record/connection_adapters/clickhouse/statement/response_processor.rb

@@ -8,14 +8,18 @@ module ActiveRecord
 
           DB_EXCEPTION_REGEXP = /\ACode:\s+\d+\.\s+DB::Exception:/.freeze
 
+          # @param [Net::HTTPResponse] raw_response
+          # @param [String, nil] format
+          # @param [String] sql
           def initialize(raw_response, format, sql)
             @raw_response = raw_response
-            @body = raw_response.body
             @format = format
             @sql = sql
           end
 
+          # @return [String, Hash, Array, nil]
           def process
+            @body = @raw_response.body
             if success?
               process_successful_response
             else
@@ -25,12 +29,28 @@ module ActiveRecord
             @body
           end
 
+          # @return [String, nil]
+          def streaming_process
+            file = Tempfile.new('clickhouse-activerecord', binmode: true)
+            if success?
+              @raw_response.read_body do |chunk|
+                file.write(chunk)
+              end
+              file.close
+              file.path
+            else
+              @body = @raw_response.body
+              raise_database_error!
+            end
+          end
+
           private
 
           def success?
             @raw_response.code.to_i == 200
           end
 
+          # @return [String, Hash, Array]
           def process_successful_response
             raise_generic!(@sql) if @body.include?('DB::Exception') && @body.match?(DB_EXCEPTION_REGEXP)
 

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

@@ -9,19 +9,27 @@ module ActiveRecord
       class Statement
 
         attr_reader :format
-        attr_writer :response
 
         def initialize(sql, format:)
           @sql = sql
           @format = format
         end
 
+        # @return [String]
         def formatted_sql
           @formatted_sql ||= FormatManager.new(@sql, format: @format).apply
         end
 
-        def processed_response
-          ResponseProcessor.new(@response, @format, @sql).process
+        # @param [Net::HTTPResponse] response
+        # @return [String, Hash, Array, nil]
+        def processed_response(response)
+          ResponseProcessor.new(response, @format, @sql).process
+        end
+
+        # @param [Net::HTTPResponse] response
+        # @return [String, nil]
+        def streaming_response(response)
+          ResponseProcessor.new(response, @format, @sql).streaming_process
         end
 
       end

data/lib/clickhouse-activerecord/minitest.rb

@@ -4,10 +4,13 @@ module ClickhouseActiverecord
   module TestHelper
     def before_setup
       super
+      original_connection_config = ActiveRecord::Base.connection_db_config
       ActiveRecord::Base.configurations.configurations.select { |x| x.env_name == Rails.env && x.adapter == 'clickhouse' }.each do |config|
         ActiveRecord::Base.establish_connection(config)
         ActiveRecord::Base.connection.truncate_tables(*ActiveRecord::Base.connection.tables)
       end
+    ensure
+      ActiveRecord::Base.establish_connection(original_connection_config) if original_connection_config
     end
   end
 end

data/lib/clickhouse-activerecord/rspec.rb

@@ -2,9 +2,11 @@
 
 RSpec.configure do |config|
   config.before do
-    ActiveRecord::Base.configurations.configurations.select { |x| x.env_name == Rails.env && x.adapter == 'clickhouse' }.each do |config|
-      ActiveRecord::Base.establish_connection(config)
+    original_connection_config = ActiveRecord::Base.connection_db_config
+    ActiveRecord::Base.configurations.configurations.select { |x| x.env_name == Rails.env && x.adapter == 'clickhouse' }.each do |db_config|
+      ActiveRecord::Base.establish_connection(db_config)
       ActiveRecord::Base.connection.truncate_tables(*ActiveRecord::Base.connection.tables)
     end
+    ActiveRecord::Base.establish_connection(original_connection_config)
   end
 end

data/lib/clickhouse-activerecord/version.rb

@@ -1,3 +1,3 @@
 module ClickhouseActiverecord
-  VERSION = '1.6.1'
+  VERSION = '1.6.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clickhouse-activerecord
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.6.3
 platform: ruby
 authors:
 - Sergey Odintsov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-01-20 00:00:00.000000000 Z
+date: 2026-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler