Configuration Overview

chkit is configured through clickhouse.config.ts.

Core Fields

• schema: glob path to schema files
• outDir: root folder for generated artifacts
• migrationsDir: SQL migration file folder
• metaDir: state folder (snapshot.json, journal.json)
• plugins: plugin registrations
• clickhouse: live connection options
• check: CI gate behavior
• safety: destructive migration safety behavior

Example

import { defineConfig } from '@chkit/core'

export default defineConfig({
  schema: './src/db/schema/**/*.ts',
  outDir: './chkit',
  migrationsDir: './chkit/migrations',
  metaDir: './chkit/meta',
  clickhouse: {
    url: process.env.CLICKHOUSE_URL ?? 'http://localhost:8123',
    username: process.env.CLICKHOUSE_USER ?? 'default',
    password: process.env.CLICKHOUSE_PASSWORD ?? '',
    database: process.env.CLICKHOUSE_DB ?? 'default',
  },
})