chc-r8 0.3.2

data/lib/click_house/client.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+require 'addressable'
+require 'json'
+require 'active_support/deprecation'
+require 'active_support/time'
+require 'active_support/notifications'
+require 'active_support/core_ext/string'
+require 'active_support/core_ext/object/blank'
+require_relative "client/version"
+require_relative "client/database"
+require_relative "client/configuration"
+require_relative "client/bind_index_manager"
+require_relative "client/quoting"
+require_relative "client/arel_engine"
+require_relative "client/query_like"
+require_relative "client/query"
+require_relative "client/redactor"
+require_relative "client/query_builder"
+require_relative "client/formatter"
+require_relative "client/response"
+
+module ClickHouse
+  module Client
+    class << self
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      def configure
+        yield(configuration)
+        configuration.validate!
+      end
+    end
+
+    Error = Class.new(StandardError)
+    ConfigurationError = Class.new(Error)
+    DatabaseError = Class.new(Error)
+    QueryError = Class.new(Error)
+
+    def self.database_configured?(database, configuration = self.configuration)
+      !!configuration.databases[database]
+    end
+
+    # Executes a SELECT database query
+    def self.select(query, database, configuration = self.configuration)
+      instrumented_execute(query, database, configuration) do |response, instrument|
+        parsed_response = configuration.json_parser.parse(response.body)
+
+        instrument[:statistics] = parsed_response['statistics']&.symbolize_keys
+
+        Formatter.format(parsed_response)
+      end
+    end
+
+    # Executes any kinds of database query without returning any data (INSERT, DELETE)
+    def self.execute(query, database, configuration = self.configuration)
+      instrumented_execute(query, database, configuration) do |response, instrument|
+        expose_summary(response.headers, instrument)
+      end
+
+      true
+    end
+
+    # Inserts a gzip-compressed CSV to ClickHouse
+    #
+    # Usage:
+    #
+    # Create a compressed CSV file:
+    # > File.binwrite("my_csv.csv", ActiveSupport::Gzip.compress("id\n10\n20"))
+    #
+    # Invoke the INSERT query:
+    # > ClickHouse::Client.insert_csv('INSERT INTO events (id) FORMAT CSV', File.open("my_csv.csv"), :main)
+    def self.insert_csv(query, io, database, configuration = self.configuration)
+      db = lookup_database(configuration, database)
+
+      headers = db.headers.merge(
+        'Transfer-Encoding' => 'chunked',
+        'Content-Length' => File.size(io).to_s,
+        'Content-Encoding' => 'gzip'
+      )
+
+      query = ClickHouse::Client::Query.build(query)
+      ActiveSupport::Notifications.instrument('sql.click_house', { query:, database: }) do |instrument|
+        response = configuration.http_post_proc.call(
+          db.build_custom_uri(extra_variables: { query: query.to_sql }).to_s,
+          headers,
+          io
+        )
+        raise DatabaseError, response.body unless response.success?
+
+        expose_summary(response.headers, instrument)
+      end
+
+      true
+    end
+
+    private_class_method def self.expose_summary(headers, instrument)
+      return unless headers['x-clickhouse-summary']
+
+      instrument[:statistics] =
+        configuration.json_parser.parse(headers['x-clickhouse-summary']).symbolize_keys
+    end
+
+    private_class_method def self.lookup_database(configuration, database)
+      configuration.databases[database].tap do |db|
+        raise ConfigurationError, "The database '#{database}' is not configured" unless db
+      end
+    end
+
+    private_class_method def self.instrumented_execute(query, database, configuration)
+      db = lookup_database(configuration, database)
+
+      query = ClickHouse::Client::Query.build(query)
+
+      log_contents = configuration.log_proc.call(query)
+      configuration.logger.info(log_contents)
+
+      ActiveSupport::Notifications.instrument('sql.click_house', { query:, database: }) do |instrument|
+        # Use a multipart POST request where the placeholders are sent with the param_ prefix
+        # See: https://github.com/ClickHouse/ClickHouse/issues/8842
+        query_with_params = query.prepared_placeholders.transform_keys { |key| "param_#{key}" }
+        query_with_params['query'] = query.to_sql
+
+        response = configuration.http_post_proc.call(
+          db.uri.to_s,
+          db.headers,
+          query_with_params
+        )
+
+        raise DatabaseError, response.body unless response.success?
+
+        yield response, instrument
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: chc-r8
+version: !ruby/object:Gem::Version
+  version: 0.3.2
+platform: ruby
+authors:
+- group::optimize
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: gitlab-styles
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.0.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This Gem provides a simple way to query ClickHouse databases using the
+  HTTP interface.
+email:
+- engineering@gitlab.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/publish.yml"
+- ".gitlab-ci.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- click_house-client.gemspec
+- lib/click_house/client.rb
+- lib/click_house/client/arel_engine.rb
+- lib/click_house/client/bind_index_manager.rb
+- lib/click_house/client/configuration.rb
+- lib/click_house/client/database.rb
+- lib/click_house/client/formatter.rb
+- lib/click_house/client/query.rb
+- lib/click_house/client/query_builder.rb
+- lib/click_house/client/query_like.rb
+- lib/click_house/client/quoting.rb
+- lib/click_house/client/redactor.rb
+- lib/click_house/client/response.rb
+- lib/click_house/client/version.rb
+homepage: https://gitlab.com/gitlab-org/ruby/gems/clickhouse-client
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.1
+specification_version: 4
+summary: GitLab's client to interact with ClickHouse
+test_files: []