CH.Toolkit.Cli 0.0.1-preview.3

CH.Toolkit.Cli

Command-line tool for CH.Toolkit schema migrations. This is a .NET global tool, not a library.

Installation

dotnet tool install -g CH.Toolkit.Cli

Commands

• ch-toolkit init -- initialize a new project with a ch-toolkit.json config file
• ch-toolkit add-migration -- diff the current database against your desired schema and generate a C# migration
• ch-toolkit migrate -- apply all pending migrations to the database
• ch-toolkit status -- show applied and pending migration status
• ch-toolkit sql -- generate SQL preview from migration files (for review only)
• ch-toolkit scaffold -- reverse-engineer schema from an existing ClickHouse database

Global Options

• --connection -- ClickHouse connection string (overrides config file)
• --database -- target database name (overrides config file)
• --cluster -- cluster name for ON CLUSTER DDL (overrides config file)

Configuration

Settings are read from ch-toolkit.json in the working directory (created by init). CLI flags override config file values.

Dependencies

Introspection, Migrations + System.CommandLine, ClickHouse.Driver

Example

ch-toolkit init --connection "Host=localhost;Port=9000" --database analytics
ch-toolkit add-migration --name AddEventsTable
ch-toolkit migrate
ch-toolkit status

See the root README for full documentation.