zifter/ClickHouse Migrations
Apply file-based schema migrations to ClickHouse from a directory of .sql files.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| migrations-dir | Path to the directory with migration files | no | ./migrations |
| db-url | ClickHouse connection URL (clickhouse://user:password@host:port/db). Takes precedence over the individual db-* inputs. | no | "" |
| db-host | ClickHouse host | no | localhost |
| db-port | ClickHouse port. Leave empty to use the driver default (9000 for clickhouse-driver, 8123 for clickhouse-connect). | no | "" |
| db-user | ClickHouse user | no | default |
| db-password | ClickHouse password | no | "" |
| db-name | ClickHouse database name | no | "" |
| cluster-name | ClickHouse cluster name (for ON CLUSTER / replicated deployments) | no | "" |
| driver | ClickHouse driver: 'clickhouse-driver' (native TCP) or 'clickhouse-connect' (official HTTP). Both are bundled; db-url is clickhouse-driver only. | no | clickhouse-driver |
| extra-args | Additional raw CLI arguments, e.g. '--dry-run --secure --create-db-if-not-exists' | no | "" |
| version | Version of clickhouse-migrations to install from PyPI (defaults to the latest) | no | "" |
| python-version | Python version used to run the tool | no | 3.13 |
Outputs
no outputs