You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: get-started/setup-lightdash/connect-project.mdx
+43-2Lines changed: 43 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ title: "Update your project connection"
5
5
To setup your Lightdash connection you'll need to:
6
6
7
7
1.[Connect to your data warehouse](/get-started/setup-lightdash/connect-project#1-connect-to-a-warehouse)
8
-
2.[Connect to your dbt project](/get-started/setup-lightdash/connect-project#3-import-a-dbt-project)
8
+
2.[Connect to your dbt project](/get-started/setup-lightdash/connect-project#2-import-a-dbt-project)
9
9
10
10
<Tip>
11
11
You can see a list of every time your project is compiled by visiting the [project compilation history](/references/project-compilation-history) page.
@@ -661,6 +661,18 @@ This controls what day is the start of the week in Lightdash. `Auto` sets it to
661
661
662
662
Connecting Lightdash to a hosted dbt project means that you'll be able to keep your Lightdash instance in sync with the changes in your dbt project.
663
663
664
+
The most common way to connect to dbt is to connect to a git repository where your dbt project is hosted. You can also connect directly using the CLI, or using the dbt Cloud connection type which leverages the dbt Cloud API.
665
+
666
+
<Accordion title="I'm using dbt Cloud, should I connect using my git repository or through dbt Cloud?">
667
+
668
+
Generally, **we recommend connecting via git repository for most users**, unless you specifically need to use features that are only available when connecting via dbt Cloud.
669
+
670
+
For example, if you are using [cross project references](https://docs.getdbt.com/docs/mesh/govern/project-dependencies#how-to-write-cross-project-ref) in dbt Cloud, you'll *need* to use that connection type, or Lightdash won't be able to compile your projects.
671
+
672
+
If you connect via git repository, you need to make sure that your environment version in dbt Cloud is set to ['Compatible'](https://docs.getdbt.com/docs/dbt-versions/cloud-release-tracks).
673
+
674
+
</Accordion>
675
+
664
676
To connect your dbt project, head to your project connection settings in Lightdash:
665
677
666
678
<Frame>
@@ -685,6 +697,8 @@ Pick your repository type and follow the guide below:
685
697
686
698
<Card title="Bitbucket" href="#bitbucket" />
687
699
700
+
<Card title="dbt Cloud" href="#dbt-cloud" />
701
+
688
702
<Card title="CLI" href="#cli" />
689
703
690
704
</CardGroup>
@@ -891,7 +905,34 @@ If you've [customized the domain for your Bitbucket server](https://confluence.a
891
905
892
906
***
893
907
894
-
### CLI
908
+
### dbt Cloud
909
+
910
+
The dbt Cloud connection type bypasses any git connection, instead directly accessing metadata from your dbt Cloud project using the dbt Cloud API.
911
+
912
+
This means a number of features are **not** available, including:
* [Preview environments](https://docs.lightdash.com/references/preview-projects#lightdash-app) created in the UI from git branches
915
+
* Automatic refreshes on new commits to your git repo - you'll need to manually trigger refreshes in Lightdash when you make changes to your dbt project.
916
+
917
+
##### Service Token
918
+
919
+
To connect Lightdash to your dbt Cloud project, you'll need to create a [dbt Cloud service token](https://docs.getdbt.com/docs/dbt-cloud-apis/service-tokens) with the 'Metadata Only' permission.
920
+
921
+
##### Environment ID
922
+
923
+
This is the identifier for your dbt Cloud environment. You can find this in the URL when you're in your dbt Cloud environment. Lightdash will use this to identify which environment it should be built from, so commonly you'll point to your production environment here.
924
+
925
+
##### Webhook for dbt
926
+
927
+
This webhook is an optional extra for those using the dbt Cloud CI steps. If you set up a webhook that triggers when your dbt Cloud CI job completed, you can paste the webhook address and Lightdash will automatically spin up a preview for the given CI environment.
928
+
929
+
##### Discovery API Endpoint
930
+
931
+
The dbt specific endpoint for your dbt Cloud instance. You can find details on this in the [dbt Cloud API documentation](https://docs.getdbt.com/docs/dbt-cloud-apis/discovery-querying#discovery-api-endpoints).
932
+
933
+
***
934
+
935
+
### CLI <a id="-cli" />
895
936
896
937
The `CLI` connection type is the default type for projects that were created using the CLI via the `lightdash deploy --create` command.
0 commit comments