Skip to content

Commit

Permalink
Merge branch 'current' into 1-2-deprecation
Browse files Browse the repository at this point in the history
  • Loading branch information
nghi-ly authored May 24, 2024
2 parents 0f86657 + eb0604f commit 8dd8710
Show file tree
Hide file tree
Showing 27 changed files with 413 additions and 323 deletions.
4 changes: 2 additions & 2 deletions website/docs/docs/build/custom-schemas.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ To customize this macro, copy the example code in the section [How does dbt gene

Be careful. dbt will ignore any custom `generate_schema_name` macros included in installed packages.

<expandable alt_header="Warning: Don't replace `default_schema` in the macro">
<Expandable alt_header="Warning: Don't replace `default_schema` in the macro">

If you're modifying how dbt generates schema names, don't just replace ```{{ default_schema }}_{{ custom_schema_name | trim }}``` with ```{{ custom_schema_name | trim }}``` in the ```generate_schema_name``` macro.

Expand All @@ -124,7 +124,7 @@ If you remove ```{{ default_schema }}```, it causes developers to override each
```

</expandable>
</Expandable>

### generate_schema_name arguments

Expand Down
4 changes: 2 additions & 2 deletions website/docs/docs/build/fill-nulls-advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,9 +126,9 @@ Now, if you combine the metrics in a `derived` metric, there will be a zero valu

## FAQs

<expandable alt_header="How to handle null values in derived metrics defined on top of multiple tables">
<Expandable alt_header="How to handle null values in derived metrics defined on top of multiple tables">

For additional examples and discussion on how to handle null values in derived metrics that use data from multiple tables, check out [MetricFlow issue #1031](https://github.com/dbt-labs/metricflow/issues/1031).

</expandable>
</Expandable>

4 changes: 2 additions & 2 deletions website/docs/docs/build/metricflow-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,13 +88,13 @@ You can use the `dbt sl` prefix before the command name to execute them in the d
When you make changes to metrics, make sure to run `dbt parse` at a minimum to update the dbt Semantic Layer. This updates the `semantic_manifest.json` file, reflecting your changes when querying metrics. By running `dbt parse`, you won't need to rebuild all the models.
:::

<expandable alt_header="How can I query or preview metrics with the dbt Cloud CLI?">
<Expandable alt_header="How can I query or preview metrics with the dbt Cloud CLI?">

Check out the following video for a short video demo of how to query or preview metrics with the dbt Cloud CLI:

<LoomVideo id='09e2b287f063497d888f4bed91469d79' />

</expandable>
</Expandable>

</TabItem>

Expand Down
4 changes: 2 additions & 2 deletions website/docs/docs/cloud/configure-cloud-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ As a tip, most command-line tools have a `--help` flag to show available command
:::

## FAQs
<expandable alt_header="How to create a .dbt directory and move your file">
<Expandable alt_header="How to create a .dbt directory and move your file">

If you've never had a `.dbt` directory, you should perform the following recommended steps to create one. If you already have a `.dbt` directory, move the `dbt_cloud.yml` file into it.
Expand Down Expand Up @@ -152,4 +152,4 @@ move %USERPROFILE%\Downloads\dbt_cloud.yml %USERPROFILE%\.dbt\dbt_cloud.yml
This command moves the `dbt_cloud.yml` from the `Downloads` folder to the `.dbt` folder. If your `dbt_cloud.yml` file is located elsewhere, adjust the path accordingly.
</expandable>
</Expandable>
4 changes: 2 additions & 2 deletions website/docs/docs/cloud/dbt-cloud-ide/develop-in-the-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ Nice job, you're ready to start developing and building models 🎉!
### Considerations
- To improve your experience using dbt Cloud, we suggest that you turn off ad blockers. This is because some project file names, such as `google_adwords.sql`, might resemble ad traffic and trigger ad blockers.
- To preserve performance, there's a file size limitation for repositories over 6 GB. If you have a repo over 6 GB, please contact [dbt Support](mailto:[email protected]) before running dbt Cloud.
- <expandable alt_header="About the start up process and work retention">
- <Expandable alt_header="About the start up process and work retention">

### Start-up process
There are three start-up states when using or launching the Cloud IDE:
Expand All @@ -120,7 +120,7 @@ Nice job, you're ready to start developing and building models 🎉!
- **Saved but uncommitted code &mdash;** When you save a file, the data gets stored in durable, long-term storage, but isn't synced back to git. To switch branches using the **Change branch** option, you must "Commit and sync" or "Revert" changes. Changing branches isn't available for saved-but-uncommitted code. This is to ensure your uncommitted changes don't get lost.
- **Committed code &mdash;** This is stored in the branch with your git provider and you can check out other (remote) branches.

</expandable>
</Expandable>

## Build and document your projects

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ This error might be because of a configuration issue in the Snowflake OAuth flow
* In the Snowflake OAuth flow, `role` in the profile config is not optional, as it does not inherit from the project connection config. So each user must supply their role, regardless of whether it is provided in the project connection.

#### Server error 500
If you experience a 500 server error when redirected from Snowflake to dbt Cloud, double-check that you have allow listed [dbt Cloud's IP addresses](/docs/cloud/about-cloud/access-regions-ip-addresses) on a Snowflake account level.
If you experience a 500 server error when redirected from Snowflake to dbt Cloud, double-check that you have allow-listed [dbt Cloud's IP addresses](/docs/cloud/about-cloud/access-regions-ip-addresses), or [VPC Endpoint ID (for PrivateLink connections)](/docs/cloud/secure/snowflake-privatelink#configuring-network-policies), on a Snowflake account level.

Enterprise customers who have single-tenant deployments will have a different range of IP addresses (network CIDR ranges) to allow list.

Expand Down
5 changes: 4 additions & 1 deletion website/docs/docs/collaborate/column-level-lineage.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,10 @@ When exploring your data products, navigating column lineage allows analytics en

## Caveats

Following are the CLL caveats/limitations.
Refer to the following CLL caveats or limitations as you navigate dbt Explorer.

### Column usage
Column-level lineage reflects the lineage from `select` statements in your models' SQL code. It doesn't reflect other usage like joins and filters.

### SQL parsing

Expand Down
96 changes: 48 additions & 48 deletions website/docs/docs/collaborate/dbt-explorer-faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,102 +9,102 @@ pagination_next: null

## Overview

<expandable alt_header="How does dbt Explorer help with data quality?" >
<Expandable alt_header="How does dbt Explorer help with data quality?" >

dbt Explorer makes it easy and intuitive to understand your entire lineage &mdash; from data source to the reporting layer &mdash; 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.

</expandable>
</Expandable>

<expandable alt_header="How is dbt Explorer priced?" >
<Expandable alt_header="How is dbt Explorer priced?" >

dbt Explorer is generally available to all regions and deployment types on the dbt Cloud [Enterprise and Team plans](https://www.getdbt.com/). 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.

</expandable>
</Expandable>

<expandable alt_header="What happened to dbt Docs?" >
<Expandable alt_header="What happened to dbt Docs?" >

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.

</expandable>
</Expandable>

## How dbt Explorer works

<expandable alt_header="Can I use dbt Explorer on-premises or with my self-hosted dbt Core deployment?" >
<Expandable alt_header="Can I use dbt Explorer on-premises or with my self-hosted dbt Core deployment?" >

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.

</expandable>
</Expandable>

<expandable alt_header="How does dbt Explorer support dbt Cloud environments?" >
<Expandable alt_header="How does dbt Explorer support dbt Cloud environments?" >

dbt Explorer supports a production or staging [deployment environment](/docs/deploy/deploy-environments) for each project you want to explore. It defaults to the latest production or staging state of a project. Users can only assign one production and one staging environment per dbt Cloud project.

Support for development (dbt Cloud CLI and dbt Cloud IDE) environments is coming soon.

</expandable>
</Expandable>

<expandable alt_header="How do I get started in Explorer? How does it update?" >
<Expandable alt_header="How do I get started in Explorer? How does it update?" >

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).

</expandable>
</Expandable>

<expandable alt_header="Is it possible to export dbt lineage to an external system or catalog?" >
<Expandable alt_header="Is it possible to export dbt lineage to an external system or catalog?" >

Yes. The lineage that powers dbt Explorer is also available through the Discovery API.

</expandable>
</Expandable>

<expandable alt_header="How does dbt Explorer integrate with third-party tools to show end-to-end lineage?" >
<Expandable alt_header="How does dbt Explorer integrate with third-party tools to show end-to-end lineage?" >

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.

</expandable>
</Expandable>


## Key features

<expandable alt_header="Does dbt Explorer support multi-project discovery (dbt Mesh)?" >
<Expandable alt_header="Does dbt Explorer support multi-project discovery (dbt Mesh)?" >

Yes. Refer to [Explore multiple projects](/docs/collaborate/explore-multiple-projects) to learn more.

</expandable>
</Expandable>

<expandable alt_header="What kind of search capabilities does dbt Explorer support?" >
<Expandable alt_header="What kind of search capabilities does dbt Explorer support?" >

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).

</expandable>
</Expandable>

<expandable alt_header="Can I view model execution information for a job that is currently being run?" >
<Expandable alt_header="Can I view model execution information for a job that is currently being run?" >

dbt Cloud updates the performance charts and metrics after a job run.

</expandable>
</Expandable>

<expandable alt_header="Can I analyze the number of successful model runs within a month?" >
<Expandable alt_header="Can I analyze the number of successful model runs within a month?" >

A chart of models built by month is available in the dbt Cloud dashboard.

</expandable>
</Expandable>

<expandable alt_header="Can model or column descriptions be edited within dbt Cloud?" >
<Expandable alt_header="Can model or column descriptions be edited within dbt Cloud?" >

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.

</expandable>
</Expandable>

<expandable alt_header="Where do recommendations come from? Can they be customized?" >
<Expandable alt_header="Where do recommendations come from? Can they be customized?" >

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).

</expandable>
</Expandable>

## Column-level lineage

<expandable alt_header="What are the best use cases for column-level lineage in dbt Explorer?" >
<Expandable alt_header="What are the best use cases for column-level lineage in dbt Explorer?" >

Column-level lineage in dbt Explorer can be used to improve many data development workflows, including:

Expand All @@ -113,61 +113,61 @@ Column-level lineage in dbt Explorer can be used to improve many data developmen
- **Impact analysis** &mdash; Trace transformations and usage to avoid introducing issues for consumers
- **Efficiency** &mdash; Prune unnecessary columns to reduce costs and data team overhead

</expandable>
</Expandable>

<expandable alt_header="Does the column-level lineage remain functional even if column names vary between models?" >
<Expandable alt_header="Does the column-level lineage remain functional even if column names vary between models?" >

Yes. Column-level lineage can handle name changes across instances of the column in the dbt project.

</expandable>
</Expandable>

<expandable alt_header="Can multiple projects leverage the same column definition?" >
<Expandable alt_header="Can multiple projects leverage the same column definition?" >

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.

</expandable>
</Expandable>


<expandable alt_header="Can column descriptions be propagated down in downstream lineage automatically?" >
<Expandable alt_header="Can column descriptions be propagated down in downstream lineage automatically?" >

Yes, a reused column, labeled as passthrough or rename, inherits its description from source and upstream model columns. In other words, source and upstream model columns propagate their descriptions downstream whenever they are not transformed, meaning you don’t need to manually define the description. Refer to [Inherited column descriptions](/docs/collaborate/column-level-lineage#inherited-column-descriptions) for more info.

</expandable>
</Expandable>

<expandable alt_header="Is column-level lineage also available in the development tab?" >
<Expandable alt_header="Is column-level lineage also available in the development tab?" >

Not currently, but we plan to incorporate column-level awareness across features in dbt Cloud in the future.

</expandable>
</Expandable>

## Availability, access, and permissions

<expandable alt_header="How can non-developers interact with dbt Explorer?" >
<Expandable alt_header="How can non-developers interact with dbt Explorer?" >

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.

</expandable>
</Expandable>

<expandable alt_header="Does dbt Explorer require a specific dbt Cloud plan?" >
<Expandable alt_header="Does dbt Explorer require a specific dbt Cloud plan?" >

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.

</expandable>
</Expandable>

<expandable alt_header="Will dbt Core users be able to leverage any of these new dbt Explorer features?" >
<Expandable alt_header="Will dbt Core users be able to leverage any of these new dbt Explorer features?" >

No. dbt Explorer is a dbt Cloud-only product experience.

</expandable>
</Expandable>

<expandable alt_header="Is it possible to access dbt Explorer using a read-only license?" >
<Expandable alt_header="Is it possible to access dbt Explorer using a read-only license?" >

Yes, users with read-only access can use the dbt Explorer. Specific feature availability within dbt Explorer will depend on your dbt Cloud plan.

</expandable>
</Expandable>

<expandable alt_header="Is there an easy way to share useful dbt Explorer content with people outside of dbt Cloud?" >
<Expandable alt_header="Is there an easy way to share useful dbt Explorer content with people outside of dbt Cloud?" >

The ability to embed and share views is being evaluated as a potential future capability.

</expandable>
</Expandable>
Loading

0 comments on commit 8dd8710

Please sign in to comment.