Skip to main content
Prerequisites:
  • Access to a ClickHouse instance and credentials
  • A project directory where you can add clisma.hcl
clisma is a ClickHouse migration tool with templating support and environment configuration.

​
Installation

npm install --save-dev clisma
Or install it globally: 
npm install -g clisma

​
Quickstart

1

Create a config

Create clisma.hcl in your project root:
env "local" {
  url = "http://default:password@localhost:8123/mydb"

  migrations {
    dir = "migrations/clickhouse"
  }
}
2

Create your first migration

clisma create
3

Run it

clisma run --env local
4

Check status

clisma status --env local

​
Advanced usage

You can pass variables and load environment files when you run migrations: 
clisma run --env local --var ttl_days=30 --env-file .env