dbt-clickhouse

dbt-clickhouse

This plugin ports dbt functionality to Clickhouse.

Documentation

See the ClickHouse website for the full documentation entry.

Installation

Use your favorite Python package manager to install the app from PyPI, e.g.

pip install dbt-core dbt-clickhouse

NOTE: 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

Supported features

• Table materialization
• View materialization
• Incremental materialization
• Microbatch incremental materialization
• Materialized View materializations (uses the TO form 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...)

All features up to dbt-core 1.10 are supported, including --sample flag and all deprecation warnings 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.

This adapter is still not available for use inside dbt Cloud, but we expect to make it available soon. Please reach out to support to get more information on this.

Contributing

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.

Original Author

ClickHouse wants to thank @silentsokolov for creating this connector and for their valuable contributions.