diff --git a/docs/_snippets/cli/clickhouse-cli.mdx b/docs/_snippets/cli/clickhouse-cli.mdx new file mode 100644 index 000000000..1348f10dc --- /dev/null +++ b/docs/_snippets/cli/clickhouse-cli.mdx @@ -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. diff --git a/docs/_snippets/install-cli.mdx b/docs/_snippets/install-cli.mdx index 214d87b8d..550a69c1b 100644 --- a/docs/_snippets/install-cli.mdx +++ b/docs/_snippets/install-cli.mdx @@ -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 ``` diff --git a/docs/_snippets/oss/adapters-cards.mdx b/docs/_snippets/oss/adapters-cards.mdx index 298862230..f82a40ef3 100644 --- a/docs/_snippets/oss/adapters-cards.mdx +++ b/docs/_snippets/oss/adapters-cards.mdx @@ -246,6 +246,12 @@ } > + dbt-clickhouse (partial support)} + icon={ + + } + > + + + + + +### Have a question? + +We are available +on [Slack](https://elementary-data.com/community), reach out +for any kind of help!