diff --git a/get-started/setup-lightdash/connect-project.mdx b/get-started/setup-lightdash/connect-project.mdx index e27747f4..692fc7b4 100644 --- a/get-started/setup-lightdash/connect-project.mdx +++ b/get-started/setup-lightdash/connect-project.mdx @@ -45,6 +45,8 @@ We currently support: + + @@ -702,6 +704,59 @@ This controls what day is the start of the week in Lightdash. `Auto` sets it to *** +### DuckDB + +Lightdash supports DuckDB project connections through [MotherDuck](https://motherduck.com/). + +You can see more details in [dbt documentation](https://docs.getdbt.com/reference/resource-configs/duckdb-configs). + +##### Database + +This is your MotherDuck database name. + +For example, if your dbt profile uses `path: "md:analytics"`, the database value in Lightdash is `analytics`. + +##### Schema + +This is the schema in your MotherDuck database that Lightdash should use. + +##### Access token + +This is your MotherDuck access token. You can create one from your MotherDuck account settings. + +We recommend using a dedicated token for Lightdash with access only to the database(s) you want to query. + +##### Threads + +The number of threads dbt should use for this connection. If you're not sure what to use, start with `1`. + +##### Start of week + +This controls what day is the start of the week in Lightdash. `Auto` sets it to whatever the default is for your data warehouse. Or, you can customize it and select the day of the week from the drop-down menu. This will be taken into account when using 'WEEK' time interval in Lightdash. + +##### dbt version + +DuckDB connections in Lightdash require dbt `v1.8` or later. + +If you work with dbt locally, your `profiles.yml` should look similar to this: + +```yaml +my-motherduck-db: + target: prod + outputs: + prod: + type: duckdb + path: "md:analytics" + schema: main + threads: 4 + extensions: + - motherduck + settings: + motherduck_token: "{{ env_var('MOTHERDUCK_TOKEN') }}" +``` + +*** + ### Athena You can see more details in [dbt documentation](https://docs.getdbt.com/docs/core/connect-data-platform/athena-setup).