This plugin ports dbt functionality to Clickhouse.
We have not tested extensively against older versions of Clickhouse. The plugin uses syntax that requires version 20.11 or newer.
Use your favorite Python package manager to install the app from PyPI, e.g.
pip install dbt-clickhouse- Table materialization
- View materialization
- Incremental materialization
- Seeds
- Sources
- Docs generate
- Snapshots (experimental)
- Ephemeral materialization
The dbt model database.schema.table is not compatible with Clickhouse because Clickhouse does not support a schema.
So we use a simple model schema.table, where schema is the Clickhouse's database. Please, don't use default database!
| Option | Description | Required? |
|---|---|---|
| engine | The table engine (type of table) to use when creating tables | Optional (default: MergeTree()) |
| order_by | A tuple of column names or arbitrary expressions. This allows you to create a small sparse index that helps find data faster. | Optional (default: tuple()) |
| partition_by | A partition is a logical combination of records in a table by a specified criterion. The partition key can be any expression from the table columns. | Optional |
| on_cluster | In a cluster setup, it is possible to run such queries in a distributed manner with the ON CLUSTER clause. (Not work with Snapshots) | Optional |
your_profile_name:
target: dev
outputs:
dev:
type: clickhouse
schema: [database name]
host: [db.clickhouse.com]
# optional
port: [port] # default 9000
user: [user]
password: [abc123]