Clickhouse rails

Build Status codecov

Install

  1. Add to Gemfile

    gem 'clickhouse-rails'

  2. Run bundle

    $ bundle install

  3. Init config files and folders

    $ rails g clickhouse:install

  4. Change clickhouse.yml at config/clickhouse.yml path

Usage

  1. Create migrations

    $ rails g clickhouse:migration add_tmp_table
  create  db/clickhouse/migrate/002_add_tmp_table.rb

  2. Edit file like this:

    # db/clickhouse/migrate/002_add_tmp_table.rb
class AddTmpTable < Clickhouse::Rails::Migrations::Base
def self.up
create_table :tmp do |t|
  t.date   :date
  t.uint16 :id

  t.engine "MergeTree(date, (date), 8192)"
end
end
end

  3. Run migrations

    $ rake clickhouse:db:migrate

You can create class of clickhouse table:

# app/models/custom_table.rb
class CustomTable
  include Clickhouse::Table
end

TODO:

  1. Rollback migrations
  2. Alter table