Discover data with dbt Explorer

With dbt Explorer, you can view your project's resources (such as models, tests, and metrics) and their lineage to gain a better understanding of its latest production state. Navigate and manage your projects within dbt Cloud to help you and other data developers, analysts, and consumers discover and leverage your dbt resources.

On-demand learning

If you enjoy video courses, check out our dbt Explorer on-demand course and learn how to best explore your dbt project(s)!

Prerequisites

• You have a dbt Cloud account on the Team or Enterprise plan.
• You have set up a production or staging deployment environment for each project you want to explore.
• You have at least one successful job run in the deployment environment. Note that CI jobs do not update dbt Explorer.
• You are on the dbt Explorer page. To do this, select Explore from the navigation in dbt Cloud.

Overview page beta

Navigate the dbt Explorer overview page to access your project's resources and metadata, available in beta. The page includes the following sections:

• Search bar — Search for resources in your project by keyword. You can also use filters to refine your search results.
• Sidebar — Use the left sidebar to access model performance, project recommendations in the Project details section. Browse your project's resources, file tree, and database in the lower section of the sidebar.
• Lineage graph — Explore your project's or account's lineage graph to visualize the relationships between resources.
• Latest updates — View the latest changes or issues related to your project's resources, including the most recent job runs, changed properties, lineage, and issues.
• Marts and public models — View the marts and public models in your project.

Access dbt Explorer from dbt Cloud by clicking Explore in the navigation.

Generate metadata

dbt Explorer uses the metadata provided by the Discovery API to display the details about the state of your project. The metadata that's available depends on the deployment environment you've designated as production or staging in your dbt Cloud project.

• 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.
• 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 executed by the jobs.

To view in Explorer	You must successfully run
Model lineage, details, or results	dbt run or dbt build on a given model within a job in the environment
Columns and statistics for models, sources, and snapshots	dbt docs generate within a job in the environment
Test results	dbt test or dbt build within a job in the environment
Source freshness results	dbt source freshness within a job in the environment
Snapshot details	dbt snapshot or dbt build within a job in the environment
Seed details	dbt seed or dbt build within a job in the environment

Richer and more timely metadata will become available as dbt Cloud evolves.

Explore your project's lineage graph

dbt Explorer provides a visualization of your project’s DAG that you can interact with. To access the project's full lineage graph, select Overview in the left sidebar and click the Explore Lineage button on the main (center) section of the page.

If you don't see the project lineage graph immediately, click Render Lineage. It can take some time for the graph to render depending on the size of your project and your computer’s available memory. The graph of very large projects might not render so you can select a subset of nodes by using selectors, instead.

The nodes in the lineage graph represent the project’s resources and the edges represent the relationships between the nodes. Nodes are color-coded and include iconography according to their resource type.

By default, dbt Explorer shows the project's applied state lineage. That is, it shows models that have been successfully built and are available to query, not just the models defined in the project.

To explore the lineage graphs of tests and macros, view their resource details pages. By default, dbt Explorer excludes these resources from the full lineage graph unless a search query returns them as results.

 How can I interact with the full lineage graph?

• Hover over any item in the graph to display the resource’s name and type.

• Zoom in and out on the graph by mouse-scrolling.

• Grab and move the graph and the nodes.

• Right-click on a node (context menu) to:

  • Refocus on the node, including its upstream and downstream nodes
  • Refocus on the node and its downstream nodes only
  • Refocus on the node and it upstream nodes only
  • View the node's resource details page

• Select a resource to highlight its relationship with other resources in your project. A panel opens on the graph’s right-hand side that displays a high-level summary of the resource’s details. The side panel includes a General tab for information like description, materialized type, and other details. In the side panel's upper right corner:

  • Click the View Resource icon to view the resource details.
  • Click the Open in IDE icon to examine the resource using the dbt Cloud IDE.
  • Click the Copy Link to Page icon to copy the page's link to your clipboard.

• Use selectors (in the search bar) to select specific resources or a subset of the DAG. This can help narrow the focus on the resources that interest you. All selectors are available for use, except those requiring a state comparison (result, source status, and state). You can also use the --exclude and the --select flag (which is optional). Examples:

  • resource_type:model [RESOURCE_NAME] — Returns all models matching the name search
  • resource_type:metric,tag:nightly — Returns metrics with the tag nightly

• Use graph operators (in the search bar) to select specific resources or a subset of the DAG. This can help narrow the focus on the resources that interest you. Examples:

  • +orders — Returns all the upstream nodes of orders
  • +dim_customers,resource_type:source — Returns all sources that are upstream of dim_customers

• Use set operators (in the search bar) to select specific resources or a subset of the DAG. This can help narrow the focus on the resources that interest you. For example:

  • +snowplow_sessions +fct_orders — Use space-delineated arguments for a union operation. Returns resources that are upstream nodes of either snowplow_sessions or fct_orders.

• View resource details by selecting a node (double-clicking) in the graph.

• Click Lenses (lower right corner of the graph) to use Explorer's lenses feature.

Example of full lineage graph

Example of exploring the order_items model in the project's lineage graph:

Example of full lineage graph

Lenses

The Lenses feature is available from your project's lineage graph (lower right corner). Lenses are like map layers for your DAG. Lenses make it easier to understand your project’s contextual metadata at scale, especially to distinguish a particular model or a subset of models.

When you apply a lens, tags become visible on the nodes in the lineage graph, indicating the layer value along with coloration based on that value. If you're significantly zoomed out, only the tags and their colors are visible in the graph.

Lenses are helpful to analyze a subset of the DAG if you're zoomed in, or to find models/issues from a larger vantage point.

 List of available lenses

A resource in your project is characterized by resource type, materialization type, or model layer, as well as its latest run or latest test status. Lenses are available for the following metadata:

• Relationship: Organizes resources by resource type, such as models, tests, seeds, and more. Resource type uses the resource_type selector.
• Materialization Type: Identifies the strategy for building the dbt models in your data platform.
• Latest Status: The status from the latest execution of the resource in the current environment. For example, diagnosing a failed DAG region.
• Model Layer: The modeling layer that the model belongs to according to best practices guide. For example, discovering marts models to analyze.
  • Marts — A model with the prefix fct_ or dim_ or a model that lives in the /marts/ subdirectory.
  • Intermediate — A model with the prefix int_. Or, a model that lives in the /int/ or /intermediate/ subdirectory.
  • Staging — A model with the prefix stg_. Or, a model that lives in the /staging/ subdirectory.
• Test Status: The status from the latest execution of the tests that ran again this resource. In the case that a model has multiple tests with different results, the lens reflects the 'worst case' status.

Example of lenses

Example of applying the Materialization Type lens with the lineage graph zoomed out. In this view, each model name has a color according to the materialization type legend at the bottom, which specifies the materialization type. This color-coding helps to quickly identify the materialization types of different models.

Example of the Materialization type lens

Example of applying the Tests Status lens, where each model name displays the tests status according to the legend at the bottom, which specifies the test status.

Example of the Test Status lens

Keyword search

You can locate resources in your project by performing a keyword search in the search bar. All resource names, column names, resource descriptions, warehouse relations, and code matching your search criteria will be displayed as a list on the main (center) section of the page. When searching for an exact column name, the results show all relational nodes containing that column in their schemas. If there's a match, a notice in the search result indicates the resource contains the specified column. Also, you can apply filters to further refine your search results.

 Search features

• Partial keyword search — This is also referred to as fuzzy search.
• Exclude keywords — Prepend a minus sign (-) to the keyword you want to exclude from search results. For example, -user will exclude all matches of that keyword from search results.
• Boolean operators — Use Boolean operators to enhance your keyword search. For example, the search results for users OR github will include matches for either keyword.
• Phrase search — Surround a string of keywords with double quotation marks to search for that exact phrase (for example, "stg users"). To learn more, refer to Phrase search on Wikipedia.
• SQL keyword search — Use SQL keywords in your search. For example, the search results int github users joined will include matches that contain that specific string of keywords (similar to phrase searching).

 Filters side panel

The Filters side panel becomes available after you perform a keyword search. Use this panel to further refine the results from your keyword search. By default, Explorer searches across all resources in the project. You can filter on:

• Resource type (like models, sources, and so on)
• Model access (like public, private)
• Model layer (like marts, staging)
• Model materialization (like view, table)
• Tags (supports multi-select)

Under the the Models option, you can filter on model properties (access or materialization type). Also available are Advanced options, where you can limit the search results to column name, model code, and more.

Example of keyword search

Example of results from searching on the keyword item and applying the filters models, description, and code:

Example of keyword search

Browse with the sidebar

From the sidebar, you can browse your project's resources, its file tree, and the database.

• Resources tab — All resources in the project organized by type. Select any resource type in the list and all those resources in the project will display as a table in the main section of the page. For a description on the different resource types (like models, metrics, and so on), refer to About dbt projects.
• File Tree tab — All resources in the project organized by the file in which they are defined. This mirrors the file tree in your dbt project repository.
• Database tab — All resources in the project organized by the database and schema in which they are built. This mirrors your data platform's structure that represents the applied state of your project.

Example of tabs in sidebar

Open in IDE

If you have been assigned a developer license, you can open the resource in the IDE directly from Explorer. For example, the IDE opens all the corresponding files for the model. This includes the model's SQL or Python definition and any YAML files that include an entry for that model. The feature is available from the full lineage graph and the resource's details view.

Here's an example of the Open in IDE icon in the upper right corner of the resource details page. The icon is inactive (grayed out) if you haven't been assigned a developer license.

Example of icon for Open in IDE

View model versions

If models in the project are versioned, you can see which version of the model is being applied — prerelease, latest, and old — in the title of the model’s details page and in the model list from the sidebar.

View resource details

You can view the definition and latest run results of any resource in your project. To find a resource and view its details, you can interact with the lineage graph, use search, or browse the catalog.

The details (metadata) available to you depends on the resource’s type, its definition, and the commands that run within jobs in the production environment.

In the upper right corner of the resource details page, you can:

• Click the Open in IDE icon to examine the resource using the dbt Cloud IDE.
• Click the Share icon to copy the page's link to your clipboard.

 What details are available for a model?

• Status bar (below the page title) — Information on the last time the model ran, whether the run was successful, how the data is materialized, number of rows, and the size of the model.
• General tab includes:
  • Lineage graph — The model’s lineage graph that you can interact with. The graph includes one upstream node and one downstream node from the model. Click the Expand icon in the graph's upper right corner to view the model in full lineage graph mode.
  • Description section — A description of the model.
  • Recent section — Information on the last time the model ran, how long it ran for, whether the run was successful, the job ID, and the run ID.
  • Tests section — Tests for the model, including a status indicator for the latest test status. A ✅ denotes a passing test.
  • Details section — Key properties like the model’s relation name (for example, how it’s represented and how you can query it in the data platform: database.schema.identifier); model governance attributes like access, group, and if contracted; and more.
  • Relationships section — The nodes the model Depends On, is Referenced by, and (if applicable) is Used by for projects that have declared the models' project as a dependency.
• Code tab — The source code and compiled code for the model.
• Columns tab — The available columns in the model. This tab also shows tests results (if any) that you can select to view the test's details page. A ✅ denotes a passing test. To filter the columns in the resource, you can use the search bar that's located at the top of the columns view.

 What details are available for an exposure?

• Status bar (below the page title) — Information on the last time the exposure was updated.
• General tab includes:
  • Status section — The status on data freshness and data quality.
  • Lineage graph — The exposure’s lineage graph. Click the Expand icon in the graph's upper right corner to view the exposure in full lineage graph mode.
  • Description section — A description of the exposure.
  • Details section — Details like exposure type, maturity, owner information, and more.
  • Relationships section — The nodes the exposure Depends On.

 What details are available for a test?

• Status bar (below the page title) — Information on the last time the test ran, whether the test passed, test name, test target, and column name. Defaults to all if not specified.
• Test Type (next to the Status bar) — Information on the different test types available: Unit test or Data test. Defaults to all if not specified.

When you select a test, the following details are available:

• General tab includes:
  • Lineage graph — The test’s lineage graph that you can interact with. The graph includes one upstream node and one downstream node from the test resource. Click the Expand icon in the graph's upper right corner to view the test in full lineage graph mode.
  • Description section — A description of the test.
  • Recent section — Information on the last time the test ran, how long it ran for, whether the test passed, the job ID, and the run ID.
  • Details section — Details like schema, severity, package, and more.
  • Relationships section — The nodes the test Depends On.
• Code tab — The source code and compiled code for the test.

Example of the Tests view:

Example of Test Type details

 What details are available for each source table within a source collection?

• Status bar (below the page title) — Information on the last time the source was updated and the number of tables the source uses.
• General tab includes:
  • Lineage graph — The source’s lineage graph that you can interact with. The graph includes one upstream node and one downstream node from the source. Click the Expand icon in the graph's upper right corner to view the source in full lineage graph mode.
  • Description section — A description of the source.
  • Source freshness section — Information on whether refreshing the data was successful, the last time the source was loaded, the timestamp of when a run generated data, and the run ID.
  • Details section — Details like database, schema, and more.
  • Relationships section — A table that lists all the sources used with their freshness status, the timestamp of when freshness was last checked, and the timestamp of when the source was last loaded.
• Columns tab — The available columns in the source. This tab also shows tests results (if any) that you can select to view the test's details page. A ✅ denotes a passing test.

Example of model details

Example of the details view for the model customers:

Example of resource details

Staging environment

dbt Explorer supports views for staging deployment environments, in addition to the production environment. This gives you a unique view into your pre-production data workflows, with the same tools available in production, while providing an extra layer of scrutiny.

You can explore the metadata from your production or staging environment to inform your data development lifecycle. Just set a single environment per dbt Cloud project as “production” or “staging," and ensure the proper metadata has been generated then you’ll be able to view it in Explorer. Refer to Generating metadata for more details.

Explore in a staging environment

Related content

• Enterprise permissions
• About model governance
• Blog on What is data mesh?