This plugin ports dbt functionality to Clickhouse.
See the ClickHouse website for the full documentation entry.
The documentation source is maintained in docs.
Use your favorite Python package manager to install the app from PyPI, e.g.
pip install dbt-core dbt-clickhouseNOTE: Beginning in v1.8, dbt-core and adapters are decoupled. Therefore, the installation mentioned above explicitly includes both dbt-core and the desired adapter.If you use a version prior to 1.8.0 the pip installation command should look like this:
pip install dbt-clickhouse- Table materialization
- View materialization
- Incremental materialization
- Microbatch incremental materialization
- Materialized View materializations (uses the
TOform of MATERIALIZED VIEW, experimental) - Seeds
- Sources
- Docs generate
- Tests
- Snapshots
- Most dbt-utils macros (now included in dbt-core)
- Ephemeral materialization
- Distributed table materialization (experimental)
- Distributed incremental materialization (experimental)
- Contracts
- ClickHouse-specific column configurations (Codec, TTL...)
- ClickHouse-specific table settings (indexes, projections...)
Features up to dbt-core 1.12 are supported, including the --sample flag, and all deprecation warnings are fixed for future releases. Catalog integrations (e.g., Iceberg) introduced in dbt 1.10 are not yet natively supported in the adapter, but workarounds are available. See the Catalog Support section for details.
ClickHouse also works with dbt OSS and dbt v2 (Beta) and with the dbt platform (Private Beta). See the dbt OSS, dbt v2 and dbt platform documentation for availability and known limitations.
We welcome contributions from the community to help improve the dbt-ClickHouse adapter. Whether you’re fixing a bug, adding a new feature, or enhancing documentation, your efforts are greatly appreciated!
Please take a moment to read our Contribution Guide to get started. The guide provides detailed instructions on setting up your environment, running tests, and submitting pull requests.
ClickHouse wants to thank @silentsokolov for creating this connector and for their valuable contributions.