Installation and Quickstart

Prerequisites:

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

Create a config

Create clisma.hcl in your project root:

env "local" {
  url = "http://default:password@localhost:8123/mydb"

  migrations {
    dir = "migrations/clickhouse"
  }
}

Create your first migration

clisma create

Run it

clisma run --env local

Check status

clisma status --env local

You can pass variables and load environment files when you run migrations:

clisma run --env local --var ttl_days=30 --env-file .env