Skip to content

Commit

Permalink
add dbt build adn dbt docs generate to view all metadata
Browse files Browse the repository at this point in the history
this pr incorporates Roxi's feedback to make it extra clear that dbt build + dbt docs generate will generate all metadata. added a bullet and extra row to the table
  • Loading branch information
mirnawong1 authored Jan 29, 2025
1 parent 787fe7d commit f60e4f1
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion website/docs/docs/collaborate/explore-projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,15 @@ Navigate the dbt Explorer overview page to access your project's resources and m

dbt Explorer uses the metadata provided by the [Discovery API](/docs/dbt-cloud-apis/discovery-api) to display the details about [the state of your project](/docs/dbt-cloud-apis/project-state). The metadata that's available depends on the [deployment environment](/docs/deploy/deploy-environments) you've designated as _production_ or _staging_ in your dbt Cloud project.

- To ensure all metadata is available in dbt Explorer, run `dbt build` and `dbt docs generate` as part of your job in your production or staging environment. Running those two commands ensure all relevant metadata (like lineage, test results, documentation, and more) is available in dbt Explorer.
- dbt Explorer automatically retrieves the metadata updates after each job run in the production or staging deployment environment so it always has the latest results for your project. This includes deploy and merge jobs.
- Note that CI jobs do not update dbt Explorer. This is because they don't reflect the production state and don't provide the necessary metadata updates.
- Note that CI jobs don't update dbt Explorer. This is because they don't reflect the production state and don't provide the necessary metadata updates.
- To view a resource and its metadata, you must define the resource in your project and run a job in the production or staging environment.
- The resulting metadata depends on the [commands](/docs/deploy/job-commands) executed by the jobs.

| To view in Explorer | You must successfully run |
|---------------------|---------------------------|
| All metadata | [dbt build](/reference/commands/build) and [dbt docs generate](/reference/commands/cmd-docs) as part of a job in the environment
| Model lineage, details, or results | [dbt run](/reference/commands/run) or [dbt build](/reference/commands/build) on a given model within a job in the environment |
| Columns and statistics for models, sources, and snapshots| [dbt docs generate](/reference/commands/cmd-docs) within [a job](/docs/collaborate/build-and-view-your-docs) in the environment |
| Test results | [dbt test](/reference/commands/test) or [dbt build](/reference/commands/build) within a job in the environment |
Expand Down

0 comments on commit f60e4f1

Please sign in to comment.