-
Notifications
You must be signed in to change notification settings - Fork 944
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'mwong-update-build-docs' into update-doc-faq
- Loading branch information
Showing
16 changed files
with
126 additions
and
57 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -17,6 +17,10 @@ The following fields are required when creating a Snowflake connection | |
|
||
**Note:** A crucial part of working with dbt atop Snowflake is ensuring that users (in development environments) and/or service accounts (in deployment to production environments) have the correct permissions to take actions on Snowflake! Here is documentation of some [example permissions to configure Snowflake access](/reference/database-permissions/snowflake-permissions). | ||
|
||
## Authentication methods | ||
|
||
This section describes the different authentication methods available for connecting dbt Cloud to Snowflake. | ||
|
||
### Username / Password | ||
|
||
**Available in:** Development environments, Deployment environments | ||
|
@@ -27,7 +31,7 @@ username (specifically, the `login_name`) and the corresponding user's Snowflake | |
to authenticate dbt Cloud to run queries against Snowflake on behalf of a Snowflake user. | ||
|
||
**Note**: The schema field in the **Developer Credentials** section is a required field. | ||
<Lightbox src="/img/docs/dbt-cloud/snowflake-userpass-auth.png" title="Snowflake username/password authentication"/> | ||
<Lightbox src="/img/docs/dbt-cloud/snowflake-userpass-auth.png" width="70%" title="Snowflake username/password authentication"/> | ||
|
||
### Key pair | ||
|
||
|
@@ -65,12 +69,22 @@ The `Keypair` auth method uses Snowflake's [Key Pair Authentication](https://doc | |
The OAuth auth method permits dbt Cloud to run development queries on behalf of | ||
a Snowflake user without the configuration of Snowflake password in dbt Cloud. For | ||
more information on configuring a Snowflake OAuth connection in dbt Cloud, please see [the docs on setting up Snowflake OAuth](/docs/cloud/manage-access/set-up-snowflake-oauth). | ||
<Lightbox src="/img/docs/dbt-cloud/dbt-cloud-enterprise/database-connection-snowflake-oauth.png" title="Configuring Snowflake OAuth connection"/> | ||
<Lightbox src="/img/docs/dbt-cloud/dbt-cloud-enterprise/database-connection-snowflake-oauth.png" width="70%" title="Configuring Snowflake OAuth connection"/> | ||
|
||
## Configuration | ||
|
||
To learn how to optimize performance with data platform-specific configurations in dbt Cloud, refer to [Snowflake-specific configuration](/reference/resource-configs/snowflake-configs). | ||
|
||
### Custom domain URL support | ||
|
||
To connect to Snowflake through a custom domain (vanity URL) instead of the account locator, use [extended attributes](/docs/dbt-cloud-environments#extended-attributes) to configure the `host` parameter with the custom domain: | ||
|
||
```yaml | ||
host: https://custom_domain_to_snowflake.com | ||
``` | ||
|
||
This configuration may conflict with Snowflake OAuth when used with PrivateLink. IF users can't reach Snowflake authentication servers from a networking standpoint, please [contact dbt Support](mailto:[email protected]) to find a workaround with this architecture. | ||
## Troubleshooting | ||
<!--might need to turn this into details toggle if more troubleshooting items arise --> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
title: "Access dbt Explorer from dbt Cloud features" | ||
sidebar_label: "Access from dbt Cloud" | ||
description: "Learn where and how to directly access and interact with dbt Explorer from dbt Cloud features and products." | ||
--- | ||
|
||
Access dbt Explorer from other features and products inside dbt Cloud, ensuring you have a seamless experience navigating between resources and lineage in your project. | ||
|
||
This page explains how to access dbt Explorer from various dbt Cloud features, including the dbt Cloud IDE and jobs. While the primary way to navigate to dbt Explorer is through the **Explore** link in the navigation, you can also access it from other dbt Cloud features. | ||
|
||
### dbt Cloud IDE | ||
You can enhance your project navigation and editing experience by directly accessing resources from the [dbt Cloud IDE](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud) to dbt Explorer for model, seed, or snapshot files. This workflow offers a seamless transition between the IDE and Explorer, allowing you to quickly navigate between viewing project metadata and making updates to your models or other resources without switching contexts. | ||
|
||
#### Access dbt Explorer from the IDE | ||
- In your model, seed, or snapshot file, click the **View in Explorer** icon to the right of your file breadcrumb (under the file name tab). | ||
- This opens the model, seed, or snapshot file in a new tab, allowing you to view resources/lineage directly in Explorer. | ||
|
||
<Lightbox src="/img/docs/collaborate/dbt-explorer/explorer-from-ide.jpg" title="Access dbt Explorer from the IDE by clicking on the 'View in Explorer' icon next to the file breadcrumbs. " /> | ||
|
||
### Lineage tab in jobs | ||
The **Lineage tab** in dbt Cloud jobs displays the lineage associated with the [job run](/docs/deploy/jobs). Access dbt Explorer directly from this tab, allowing you understand dependencies/relationships of resources in your project. | ||
|
||
#### Access dbt Explorer from the lineage tab | ||
- From a job, select the **Lineage tab**. | ||
- Double-click the node in the lineage to open a new tab and view its metadata directly in dbt Explorer. | ||
|
||
<Lightbox src="/img/docs/collaborate/dbt-explorer/explorer-from-lineage.gif" title="Access dbt Explorer from the lineage tab by double-clicking on the lineage node." /> | ||
|
||
### Model timing tab in jobs <Lifecycle status="enterprise,team"/> | ||
The [model timing tab](/docs/deploy/run-visibility#model-timing) in dbt Cloud jobs displays the composition, order, and time taken by each model in a job run. | ||
|
||
Access dbt Explorer directly from the **modeling timing tab**, which helps you investigate resources, diagnose performance bottlenecks, understand dependencies/relationships of slow-running models, and potentially make changes to improve their performance. | ||
|
||
#### Access dbt Explorer from the model timing tab | ||
- From a job, select the **model timing tab**. | ||
- Hover over a resource and click on **View on Explorer** to view the resource metadata directly in dbt Explorer. | ||
|
||
<Lightbox src="/img/docs/collaborate/dbt-explorer/explorer-from-model-timing.jpg" title="Access dbt Explorer from the model timing tab by hovering over the resource and clicking 'View in Explorer'." /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.