diff --git a/website/docs/docs/collaborate/column-level-lineage.md b/website/docs/docs/collaborate/column-level-lineage.md index 42f27cda970..510dbc8929f 100644 --- a/website/docs/docs/collaborate/column-level-lineage.md +++ b/website/docs/docs/collaborate/column-level-lineage.md @@ -3,15 +3,12 @@ title: "Column-level lineage" description: "Use dbt Explorer's column-level lineage to gain insights about your data at a granular level." --- -# Column-level lineage +# Column-level lineage dbt Explorer now offers column-level lineage (CLL) for the resources in your dbt project. Analytics engineers can quickly and easily gain insight into the provenance of their data products at a more granular level. For each column in a resource (model, source, or snapshot) in a dbt project, Explorer provides end-to-end lineage for the data in that column given how it's used. CLL is available to dbt Cloud Enterprise accounts that can use Explorer. It’s also available through the [Discovery API](/docs/dbt-cloud-apis/discovery-api). -:::tip Check out our beta -Explorer's CLL is currently available as a [public beta](/docs/dbt-versions/product-lifecycles#dbt-cloud) for Enterprise plan accounts. Please check it out! -::: ## Access the column-level lineage diff --git a/website/docs/docs/collaborate/dbt-explorer-faqs.md b/website/docs/docs/collaborate/dbt-explorer-faqs.md new file mode 100644 index 00000000000..e214a9735de --- /dev/null +++ b/website/docs/docs/collaborate/dbt-explorer-faqs.md @@ -0,0 +1,176 @@ +--- +title: "dbt Explorer FAQs" +sidebar_label: "dbt Explorer FAQs" +description: "Learn more with the FAQs about dbt Explorer, how it works, how to interact with it, and more." +pagination_next: null +--- + +[dbt Explorer](/docs/collaborate/explore-projects) is dbt Cloud’s new knowledge base and lineage visualization experience. It offers an interactive and high-level view of your company’s entire data estate, where you can dive deep into the context you need to understand and improve lineage so your teams can trust the data they’re using to make decisions. + +## Overview + + + +dbt Explorer makes it easy and intuitive to understand your entire lineage — from data source to the reporting layer — so you can troubleshoot, improve, and optimize your pipelines. With built-in features like project recommendations and model performance analysis, you can be sure you have appropriate test and documentation coverage across your estate and quickly spot and remediate slow-running models. With column-level lineage, you can quickly identify the potential downstream impacts of table changes or work backwards to quickly understand the root cause of an incident. dbt Explorer gives teams the insights they need to improve data quality proactively, ensuring pipelines stay performant and data trust remains solid. + + + + + +With the current Preview, dbt Explorer is available to everyone on the dbt Cloud Enterprise and Team plans. Certain features within dbt Explorer, such as multi-project lineage and column-level lineage, are only available on the Enterprise plan. dbt Explorer can be accessed by users with developer and read-only seats during the Preview period. + + + + + +dbt Explorer is the default documentation experience for dbt Cloud customers. dbt Docs is still available but doesn't offer the same speed, metadata, or visibility as dbt Explorer and will become a legacy feature. + + + +## How dbt Explorer works + + + +No. dbt Explorer and all of its features are only available as a dbt Cloud user experience. dbt Explorer reflects the metadata from your dbt Cloud project(s) and their runs. + + + + + +dbt Explorer defaults to the latest production state of a project. Support for staging and development (Cloud CLI and IDE) environments is coming soon. Users can only assign a single production and staging environment per dbt Cloud project. + + + + + +Simply select **Explore** from the dbt Cloud top navigation bar. dbt Explorer automatically updates after each dbt Cloud run in the given project’s environment (production, by default). The dbt commands you run within the environment will generate and update the metadata in dbt Explorer, so make sure to run the correct combination of commands within the jobs of the environment; for more details, refer to [Generate metadata](/docs/collaborate/explore-projects#generate-metadata). + + + + + +Yes. The lineage that powers dbt Explorer is also available through the Discovery API. + + + + + +dbt Explorer reflects all the lineage defined within the dbt project. Our vision for dbt Explorer is to incorporate additional metadata from external tools like data loaders (sources) and BI/analytics tools (exposures) integrated with dbt Cloud, all seamlessly incorporated into the lineage of the dbt Cloud project. + + + + +## Key features + + + +Yes. Refer to [Explore multiple projects](/docs/collaborate/explore-multiple-projects) to learn more. + + + + + +Resource search capabilities include using keywords, partial strings (fuzzy search), and set operators like `OR`. Meanwhile, lineage search supports using dbt selectors. For details, refer to [Keyword search](/docs/collaborate/explore-projects#search-resources). + + + + + +dbt Cloud updates the performance charts and metrics after a job run. + + + + + +A chart of models built by month is available in the dbt Cloud dashboard. + + + + + +Yes. Today, you can edit descriptions in the dbt Cloud IDE or CLI by changing the YAML files within the dbt project. In the future, dbt Explorer will support more ways of editing descriptions. + + + + + +Recommendations largely mirror the best practice rules from the `dbt_project_evaluator` package. At this time, recommendations can’t be customized. In the future, dbt Explorer will likely support recommendation customization capabilities (for example, in project code). + + + +## Column-level lineage + + + +Column-level lineage in dbt Explorer can be used to improve many data development workflows, including: + +- **Audit** — Visualize how data moves through and is used in your dbt project +- **Root cause** — Improve time to detect and resolve data quality issues, tracking back to the source +- **Impact analysis** — Trace transformations and usage to avoid introducing issues for consumers +- **Efficiency** — Prune unnecessary columns to reduce costs and data team overhead + + + + + +Yes. Column-level lineage can handle name changes across instances of the column in the dbt project. + + + + + +No. Cross-project column lineage is supported in the sense of viewing how a public model is used across projects, but not on a column-level. + + + + + +Yes. Column-level lineage is available through a beta endpoint using the [Discovery API](/docs/dbt-cloud-apis/discovery-api) to dbt Cloud Enterprise plan customers. + + + + + +Not currently, but this type of functionality is planned for future releases. + + + + + +Not currently, but we plan to incorporate column-level awareness across features in dbt Cloud in the future. + + + + + +## Availability, access, and permissions + + + +Read-only users can consume metadata in dbt Explorer. More bespoke experiences and exploration avenues for analysts and less-technical contributors will be provided in the future. + + + + + +dbt Explorer is available on the dbt Cloud Team and Enterprise plans. Certain features within dbt Explorer, like multi-project lineage and column-level lineage, are only available on the Enterprise plan. + + + + + +No. dbt Explorer is a dbt Cloud-only product experience. + + + + + +Yes, during the current Preview period. + + + + + +The ability to embed and share views is being evaluated as a potential future capability. + + \ No newline at end of file diff --git a/website/docs/docs/collaborate/explore-multiple-projects.md b/website/docs/docs/collaborate/explore-multiple-projects.md index 2ec7f573957..cdf7d4878fc 100644 --- a/website/docs/docs/collaborate/explore-multiple-projects.md +++ b/website/docs/docs/collaborate/explore-multiple-projects.md @@ -2,9 +2,10 @@ title: "Explore multiple projects" sidebar_label: "Explore multiple projects" description: "Learn about project-level lineage in dbt Explorer and its uses." -pagination_next: null --- +# Explore multiple projects + You can also view all the different projects and public models in the account, where the public models are defined, and how they are used to gain a better understanding about your cross-project resources. The resource-level lineage graph for a given project displays the cross-project relationships in the DAG. The different icons indicate whether you’re looking at an upstream producer project (parent) or a downstream consumer project (child). diff --git a/website/docs/docs/collaborate/model-performance.md b/website/docs/docs/collaborate/model-performance.md index a7e18b044ca..36c9d981e15 100644 --- a/website/docs/docs/collaborate/model-performance.md +++ b/website/docs/docs/collaborate/model-performance.md @@ -4,6 +4,8 @@ sidebar_label: "Model performance" description: "Learn about the performance of your models so you can make improvements to save time and money." --- +# Model performance + dbt Explorer provides metadata on dbt Cloud runs for in-depth model performance and quality analysis. This feature assists in reducing infrastructure costs and saving time for data teams by highlighting where to fine-tune projects and deployments — such as model refactoring or job configuration adjustments. diff --git a/website/docs/docs/collaborate/project-recommendations.md b/website/docs/docs/collaborate/project-recommendations.md index 7a4ca4bb961..17ad7a94e4f 100644 --- a/website/docs/docs/collaborate/project-recommendations.md +++ b/website/docs/docs/collaborate/project-recommendations.md @@ -3,6 +3,8 @@ title: "Project recommendations" sidebar_label: "Project recommendations" description: "dbt Explorer provides recommendations that you can take to improve the quality of your dbt project." --- + +# Project recommendations dbt Explorer provides recommendations about your project from the `dbt_project_evaluator` [package](https://hub.getdbt.com/dbt-labs/dbt_project_evaluator/latest/) using metadata from the Discovery API. diff --git a/website/sidebars.js b/website/sidebars.js index 5e002ff0148..71e8afc6ae9 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -455,6 +455,7 @@ const sidebarSettings = { "docs/collaborate/model-performance", "docs/collaborate/project-recommendations", "docs/collaborate/explore-multiple-projects", + "docs/collaborate/dbt-explorer-faqs", ], }, {