clickhouse-activerecord 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 42e313d78ebe5e65c9d69dee42e516e2026c381f
+  data.tar.gz: abe79df94ae67c6ff8777a39f1e2a0fa1ddeb145
+SHA512:
+  metadata.gz: 76a8b83b2905276ca6be59fe477a7e85ecb6a33ea56c7c9c81d72512f5240dc7c2785f978c494938db824e77381e4bb80e7fd121adb3ca0f2d0b19897b1c64dc
+  data.tar.gz: 7493d61f0f820585a8de6a6c1b42fb6f4b7c2fccaad85162225e7fec8c045658c72bc2ca7146c99f97a0b5b79bf1a14517e2e025bedbcf0f4bb4ef935a232a12

data/.gitignore

@@ -0,0 +1,55 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+
+### JetBrains template
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff:
+.idea/
+.idea/**/tasks.xml
+.idea/dictionaries
+
+# Sensitive or high-churn files:
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.xml
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+
+# Gradle:
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Mongo Explorer plugin:
+.idea/**/mongoSettings.xml
+
+## File-based project format:
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+/out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at nixx.dj@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in clickhouse-activerecord.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 nixx
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,81 @@
+# Clickhouse::Activerecord
+
+A Ruby database ActiveRecord driver for ClickHouse.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'clickhouse-activerecord'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install clickhouse-activerecord
+
+## Usage
+
+Add your `database.yml` connection information with postfix `_clickhouse` for you environment:
+
+```yml
+development_clickhouse:
+  adapter: clickhouse
+  database: database
+  host: localhost
+  username: username
+  password: password
+```
+
+Add to your model:
+
+```ruby
+class Action < ActiveRecord::Base
+  establish_connection "#{Rails.env}_clickhouse".to_sym
+end
+```
+
+Or global connection, but schema dump don't works:
+
+```yml
+development:
+  adapter: clickhouse
+  database: database
+  host: localhost
+  username: username
+  password: password
+```
+
+Schema dump:
+
+    $ rake clickhouse:schema:dump
+    
+### Insert and select data
+
+```ruby
+Action.where(url: 'http://example.com', date: Date.current).where.not(name: nil).order(created_at: :desc).limit(10)
+=> #<ActiveRecord::Relation [#<Action *** >]>
+
+Action.create(url: 'http://example.com', date: Date.yesterday)
+=> true
+```
+
+NOTE: Creating tables in developing.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/pnixx/clickhouse-activerecord](https://github.com/pnixx/clickhouse-activerecord). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+require 'rubygems'
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+
+Dir.glob('lib/tasks/*.rake').each { |r| load r }

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "clickhouse/activerecord"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/clickhouse-activerecord.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'clickhouse-activerecord'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Sergey Odintsov']
+  spec.email         = ['nixx.dj@gmail.com']
+
+  spec.summary       = 'ClickHouse ActiveRecord'
+  spec.description   = 'ActiveRecord adapter for ClickHouse'
+  spec.homepage      = 'https://github.com/pnixx/clickhouse-activerecord'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |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 "bundler", ">= 1.13.4"
+  spec.add_dependency 'rails', '>= 4.1.8'
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/active_record/connection_adapters/clickhouse/oid/date.rb

@@ -0,0 +1,21 @@
+module ActiveRecord
+  module ConnectionAdapters
+    module Clickhouse
+      module OID # :nodoc:
+        class Date < Type::Date # :nodoc:
+
+          def type_cast_from_database(value)
+            value
+          end
+
+          # Type cast a value for schema dumping. This method is private, as we are
+          # hoping to remove it entirely.
+          def type_cast_for_schema(value) # :nodoc:
+            value.inspect
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/active_record/connection_adapters/clickhouse/oid/date_time.rb

@@ -0,0 +1,21 @@
+module ActiveRecord
+  module ConnectionAdapters
+    module Clickhouse
+      module OID # :nodoc:
+        class DateTime < Type::DateTime # :nodoc:
+
+          def type_cast_from_database(value)
+            value
+          end
+
+          # Type cast a value for schema dumping. This method is private, as we are
+          # hoping to remove it entirely.
+          def type_cast_for_schema(value) # :nodoc:
+            value.inspect
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/active_record/connection_adapters/clickhouse_adapter.rb

@@ -0,0 +1,207 @@
+require 'active_record/connection_adapters/abstract_adapter'
+require 'active_record/connection_adapters/clickhouse/oid/date'
+require 'active_record/connection_adapters/clickhouse/oid/date_time'
+
+module ActiveRecord
+  class Base
+    class << self
+      # Establishes a connection to the database that's used by all Active Record objects
+      def clickhouse_connection(config)
+        config = config.symbolize_keys
+        host = config[:host]
+        port = config[:port] || 8123
+
+        if config.key?(:database)
+          database = config[:database]
+        else
+          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)
+      end
+    end
+  end
+
+  module ConnectionAdapters
+
+    class ClickhouseColumn < Column
+      def initialize(name, default, cast_type, sql_type = nil, null = true)
+        super(name, default, cast_type, sql_type, null)
+        @default_function = 'now'
+      end
+
+      private
+
+      # Extracts the value from a PostgreSQL column default definition.
+      def extract_value_from_default(default)
+        case default
+          # Quoted types
+        when /\A[\(B]?'(.*)'.*::"?([\w. ]+)"?(?:\[\])?\z/m
+          # The default 'now'::date is CURRENT_DATE
+          if $1 == "now".freeze && $2 == "date".freeze
+            nil
+          else
+            $1.gsub("''".freeze, "'".freeze)
+          end
+          # Boolean types
+        when "true".freeze, "false".freeze
+          default
+          # Numeric types
+        when /\A\(?(-?\d+(\.\d*)?)\)?(::bigint)?\z/
+          $1
+          # Object identifier types
+        when /\A-?\d+\z/
+          $1
+        else
+          # Anything else is blank, some user type, or some function
+          # and we can't know the value of that, so return nil.
+          nil
+        end
+      end
+
+      def extract_default_function(default_value, default) # :nodoc:
+        default if has_default_function?(default_value, default)
+      end
+
+      def has_default_function?(default_value, default) # :nodoc:
+        !default_value && (%r{\w+\(.*\)} === default)
+      end
+
+    end
+
+    class ClickhouseAdapter < AbstractAdapter
+      ADAPTER_NAME = 'Clickhouse'.freeze
+
+      NATIVE_DATABASE_TYPES = {
+        string: { name: 'String', limit: 255 },
+        integer: { name: 'UInt32' },
+        float: { name: 'Float32' },
+        datetime: { name: 'DateTime' },
+        date: { name: 'Date' },
+        boolean: { name: 'UInt8' }
+      }.freeze
+
+      # Initializes and connects a Clickhouse adapter.
+      def initialize(connection, logger, connection_parameters, config)
+        super(connection, logger)
+        @connection_parameters = connection_parameters
+        @config = config
+
+        @visitor = Arel::Visitors::ToSql.new self
+
+        connect
+      end
+
+      def native_database_types #:nodoc:
+        NATIVE_DATABASE_TYPES
+      end
+
+      def valid_type?(type)
+        !native_database_types[type].nil?
+      end
+
+      def extract_limit(sql_type) # :nodoc:
+        case sql_type
+          when 'Nullable(String)'
+            255
+          else
+            super
+        end
+      end
+
+      def initialize_type_map(m) # :nodoc:
+        super
+        register_class_with_limit m, 'String', Type::String
+        register_class_with_limit m, 'Nullable(String)', Type::String
+        register_class_with_limit m, 'Uint8', Type::UnsignedInteger
+        register_class_with_limit m, 'Date',  Clickhouse::OID::Date
+        register_class_with_limit m, 'DateTime',  Clickhouse::OID::DateTime
+        m.alias_type 'UInt16', 'uint8'
+        m.alias_type 'UInt32', 'uint8'
+        m.alias_type 'UInt64', 'uint8'
+        m.alias_type 'Int8', 'int8'
+        m.alias_type 'Int16', 'int8'
+        m.alias_type 'Int32', 'int8'
+        m.alias_type 'Int64', 'int8'
+      end
+
+      # Queries the database and returns the results in an Array-like object
+      def query(sql, _name = nil)
+        res = @connection.get("/?#{@config.merge(query: "#{sql} FORMAT JSONCompact").to_param}")
+        raise ActiveRecord::ActiveRecordError, "Response code: #{res.code}:\n#{res.body}" unless res.code.to_i == 200
+        JSON.parse res.body
+      end
+
+      def execute(sql, name = nil)
+        log(sql, "#{adapter_name} #{name}") do
+          query sql, name
+        end
+      end
+
+      def exec_query(sql, name = nil, _binds = [])
+        result = execute(sql, name)
+        ActiveRecord::Result.new(result['meta'].map { |m| m['name'] }, result['data'])
+      end
+
+      # Executes insert +sql+ statement in the context of this connection using
+      # +binds+ as the bind substitutes. +name+ is logged along with
+      # the executed +sql+ statement.
+      def exec_insert(sql, name, _binds, _pk = nil, _sequence_name = nil)
+        log(sql, "#{adapter_name} #{name}") do
+          res = @connection.post("/?#{@config.to_param}", sql)
+          raise ActiveRecord::ActiveRecordError, "Response code: #{res.code}:\n#{res.body}" unless res.code.to_i == 200
+          true
+        end
+      end
+
+      def update(_arel, _name = nil, _binds = [])
+        raise ActiveRecord::ActiveRecordError, 'Clickhouse update is not supported'
+      end
+
+      def delete(_arel, _name = nil, _binds = [])
+        raise ActiveRecord::ActiveRecordError, 'Clickhouse delete is not supported'
+      end
+
+      # SCHEMA STATEMENTS ========================================
+
+      def tables(name = nil)
+        query('SHOW TABLES', name)['data'].flatten
+      end
+
+      def columns(table_name, _name = nil) #:nodoc:
+        table_structure(table_name).map do |field|
+          ClickhouseColumn.new(field[0], field[3].present? ? field[3] : nil, lookup_cast_type(field[1]), field[1], field[1].include?('Nullable'))
+        end
+      end
+
+      def indexes(_table_name, _name = nil) #:nodoc:
+        Rails.logger.warn 'Clickhouse indexes is not supported'
+        []
+      end
+
+      def primary_key(table_name) #:nodoc:
+        pk = table_structure(table_name).first
+        return 'id' if pk.present? && pk[0] == 'id'
+        false
+      end
+
+      protected
+
+      def table_structure(table_name)
+        data = query("DESCRIBE TABLE #{table_name}", table_name)['data']
+        raise(ActiveRecord::StatementInvalid, "Could not find table '#{table_name}'") if data.empty?
+        data
+      end
+
+      def last_inserted_id(result)
+        result
+      end
+
+      private
+
+      def connect
+        @connection = Net::HTTP.start(@connection_parameters[0], @connection_parameters[1])
+      end
+    end
+  end
+end

data/lib/clickhouse.rb

@@ -0,0 +1,7 @@
+require 'active_record/connection_adapters/clickhouse_adapter'
+
+require 'clickhouse/railtie' if defined?(Rails::Railtie)
+
+module Clickhouse
+
+end

data/lib/clickhouse/railtie.rb

@@ -0,0 +1,7 @@
+module Clickhouse
+  require 'rails'
+
+  class Railtie < Rails::Railtie
+    rake_tasks { load 'tasks/clickhouse.rake' }
+  end
+end

data/lib/tasks/clickhouse.rake

@@ -0,0 +1,23 @@
+namespace :clickhouse do
+
+  namespace :schema do
+
+    # todo not testing
+    # desc 'Load database schema'
+    # task load_schema: :environment do
+    #   ActiveRecord::Base.establish_connection(:"#{Rails.env}_clickhouse")
+    #   load("#{Rails.root}/db/clickhouse_schema.rb")
+    # end
+
+    desc 'Dump database schema'
+    task dump: :environment do
+      filename = "#{Rails.root}/db/clickhouse_schema.rb"
+      File.open(filename, 'w:utf-8') do |file|
+        ActiveRecord::Base.establish_connection(:"#{Rails.env}_clickhouse")
+        ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, file)
+      end
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: clickhouse-activerecord
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergey Odintsov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.13.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.13.4
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.8
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: ActiveRecord adapter for ClickHouse
+email:
+- nixx.dj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- clickhouse-activerecord.gemspec
+- lib/active_record/connection_adapters/clickhouse/oid/date.rb
+- lib/active_record/connection_adapters/clickhouse/oid/date_time.rb
+- lib/active_record/connection_adapters/clickhouse_adapter.rb
+- lib/clickhouse.rb
+- lib/clickhouse/railtie.rb
+- lib/tasks/clickhouse.rake
+homepage: https://github.com/pnixx/clickhouse-activerecord
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: ClickHouse ActiveRecord
+test_files: []
+has_rdoc: