diff --git a/docs/oss/general/troubleshooting.mdx b/docs/oss/general/troubleshooting.mdx index db27fdf21..81202bda2 100644 --- a/docs/oss/general/troubleshooting.mdx +++ b/docs/oss/general/troubleshooting.mdx @@ -162,7 +162,8 @@ source virtualenv_elementary/bin/activate python3 -m ensurepip --upgrade python3 -m pip install --upgrade pip python3 -m pip install elementary-data -python3 -m pip install elementary-data[] +## Only if you use dbt Core 1.x (not needed for dbt v2 / Fusion): +python3 -m pip install 'elementary-data[dbt1-]' ``` diff --git a/docs/snippets/install-cli.mdx b/docs/snippets/install-cli.mdx index 21ca6c256..2ed832c0c 100644 --- a/docs/snippets/install-cli.mdx +++ b/docs/snippets/install-cli.mdx @@ -1,26 +1,41 @@ ## Install Elementary CLI -To install the monitor module run: +The installation depends on the dbt version your project runs on. + +### dbt v2 (Fusion) + +Install the CLI without any extra: ```shell pip install elementary-data ``` -Run one of the following commands based on your platform (no need to run all): +Then install dbt v2 itself (the `dbt` or `dbt-oss` package) by following [dbt's installation guide](https://docs.getdbt.com/docs/local/install-dbt). dbt v2 has adapters built in, so no warehouse-specific package is needed. + +### dbt Core 1.x + +Install the CLI with the `dbt1-` extra matching your platform (no need to run all): + +```shell +pip install 'elementary-data[dbt1-snowflake]' +pip install 'elementary-data[dbt1-bigquery]' +pip install 'elementary-data[dbt1-redshift]' +pip install 'elementary-data[dbt1-databricks]' +pip install 'elementary-data[dbt1-athena]' +pip install 'elementary-data[dbt1-trino]' +pip install 'elementary-data[dbt1-clickhouse]' +pip install 'elementary-data[dbt1-duckdb]' +pip install 'elementary-data[dbt1-dremio]' +pip install 'elementary-data[dbt1-spark]' +pip install 'elementary-data[dbt1-postgres]' +``` + +The extra installs dbt Core 1.x and the warehouse adapter alongside the CLI. The legacy extras without the `dbt1-` prefix (e.g. `elementary-data[snowflake]`) are still supported and install the same packages. + +For Vertica, install `elementary-data` and the `dbt-vertica` adapter directly: ```shell -pip install 'elementary-data[snowflake]' -pip install 'elementary-data[bigquery]' -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]' -pip install 'elementary-data[duckdb]' -pip install 'elementary-data[dremio]' -pip install 'elementary-data[spark]' -pip install 'elementary-data[vertica]' -## Postgres doesn't require this step +pip install elementary-data dbt-vertica ``` Run `edr --help` in order to ensure the installation was successful.