Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions docs/_snippets/cli/clickhouse-cli.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
### ClickHouse connection profile

After installing Elementary's dbt package upon running `dbt deps`,
you can generate Elementary's profile for usage with `edr` by running the following command within your project:

```shell
dbt run-operation elementary.generate_elementary_cli_profile
```

The command will print to the terminal a partially filled template of the profile that's needed for `edr` to work.

```yml Clickhouse
## CLICKHOUSE ##
## By default, edr expects the profile name 'elementary'. ##
## Configure the database and schema of elementary models. ##
## Check where 'elementary_test_results' is to find it. ##

elementary:
outputs:
default:
type: clickhouse
host: [hostname]
user: [username]
password: [password]
port: [port]
schema: [schema name] # elementary schema, usually [schema name]_elementary
threads: [1 or more]
# sslmode: [optional, set the sslmode used to connect to the database]
```

Note: Anomaly detection is not supported for Clickhouse.

We support the same format and connection methods (user password, key pair authentication, SSO) as dbt. Please refer to
dbt's documentation of [Clickhouse profile](https://docs.getdbt.com/reference/warehouse-setups/clickhouse-setup) for
further details.
1 change: 1 addition & 0 deletions docs/_snippets/install-cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ pip install 'elementary-data[redshift]'
pip install 'elementary-data[databricks]'
pip install 'elementary-data[athena]'
pip install 'elementary-data[trino]'
pip install 'elementary-data[clickhouse]'
## Postgres doesn't require this step
```

Expand Down
6 changes: 6 additions & 0 deletions docs/_snippets/oss/adapters-cards.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,12 @@
</svg>
}
></Card>
<Card
title={<span>dbt-clickhouse <span style={{ fontSize: '0.8em', color: '#666', fontStyle: 'italic' }}>(partial support)</span></span>}
icon={
<svg height="35" viewBox="0 0 9 8" width="40" xmlns="http://www.w3.org/2000/svg"><path d="m0 7h1v1h-1z" fill="#f00"/><path d="m0 0h1v7h-1zm2 0h1v8h-1zm2 0h1v8h-1zm2 0h1v8h-1zm2 3.25h1v1.5h-1z" fill="#fc0"/></svg>
}
></Card>
<Card
title="dbt-trino"
icon={
Expand Down
18 changes: 18 additions & 0 deletions docs/_snippets/profiles/all-profiles.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,24 @@ elementary:
threads: [number of threads like 8]
```

```yml Clickhouse
## Clickhouse ##
## By default, edr expects the profile name 'elementary'. ##
## Configure the database and schema of elementary models. ##
## Check where 'elementary_test_results' is to find it. ##

elementary:
outputs:
default:
type: clickhouse
schema: [schema name] # elementary schema, usually [schema name]_elementary
host: [hostname]
port: [port]
user: [username]
password: [password]
threads: [number of threads like 8]
```

```yml Trino
## Trino ##
## By default, edr expects the profile name 'elementary'. ##
Expand Down
15 changes: 15 additions & 0 deletions docs/oss/integrations/clickhouse.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: "Clickhouse"
---

<Tabs>
<Tab title="Elementary CLI">
<Snippet file="cli/clickhouse-cli.mdx" />
</Tab>
</Tabs>

### Have a question?

We are available
on [Slack](https://elementary-data.com/community), reach out
for any kind of help!
Loading