From 326af16079cb867dbc9eb9a99f76df8dc9a4da4c Mon Sep 17 00:00:00 2001 From: Amy Chen Date: Tue, 19 Dec 2023 10:01:05 -0500 Subject: [PATCH 01/60] upload the guide --- .../2023-12-20-partner-integration-guide.md | 102 ++++++++++++++++++ 1 file changed, 102 insertions(+) create mode 100644 website/blog/2023-12-20-partner-integration-guide.md diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md new file mode 100644 index 00000000000..0eed3302716 --- /dev/null +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -0,0 +1,102 @@ +--- +title: "How to integrate with dbt" +description: "This guide will cover the ways to integrate with dbt Cloud" +slug: integrating-with-dbtcloud + +authors: [amy_chen] + +tags: [dbt Cloud, Integrations, APIs] +hide_table_of_contents: false + +date: 2023-12-20 +is_featured: false +--- + + +## Overview + +Over the course of my 3 years running the Partner Engineering team at dbt Labs, the most common question I have been asked is “How do we integrate with dbt?”. Because those conversations often start out at the same place, I decided to create this guide so I’m no longer the blocker to fundamental information. This also allows us to skip the intro and get to the fun conversations like what a joint solution for our customers would look like so much faster. + +Now this guide does not include how to integrate with dbt Core. If you’re interested in creating an dbt Adapter, **[please check out this documentation instead.](/guides/dbt-ecosystem/adapter-development/1-what-are-adapters)** + +Instead we are going to focus on integrating with dbt Cloud. Integrating with dbt Cloud is a key requirement to become a dbt Labs technology partner, opening the door to a variety of collaborative commercial opportunities. + +Here I will cover how to get started, potential use cases you want to solve for, and points of integrations to do so. + +## New to dbt Cloud? + +If you're new to dbt and dbt Cloud, we recommend you and your software developers try our [Getting Started Quickstarts](quickstarts) after reading [What is dbt?](/docs/introduction). The documentation will help you familiarize yourself with how our users interact with dbt. By going through this, you will also create a sample dbt project to test your integration. + +If you require a partner dbt Cloud account to test on, we can upgrade an existing account or a trial account. **This account may only be used for development, training, and demonstration purposes.** Please speak to your partner manager if you're interested and provide the account id (provided in the URL). Our partner account has all of the enterprise level functionality and can be provided with a signed partnerships agreement. + +## Integration Points + +- [Discovery API (formerly referred to as Metadata API)](/docs/dbt-cloud-apis/discovery-api) + - **Overview**: This GraphQL API allows you to query the metadata that dbt Cloud generates every time you run a dbt Project. We have two schemas available (environment and job level). By default, we always recommend that you integrate with the environment level schema because it contains the latest state and historical run results of all the jobs run on the dbt Cloud project. The job level will only provide you the metadata of one job, giving you only a small snapshot of part of the project. +- [Administrative API (also referred to as the Admin API)](/docs/dbt-cloud-apis/admin-cloud-api) + - **Overview:** This REST API allows you to orchestrate dbt Cloud jobs runs and help you administer a dbt Cloud account. For metadata retrieval, we recommend integrating with the Discovery API instead. +- Webhooks + - **Overview:** Outbound webhooks can send notifications about your dbt Cloud jobs to other systems. These webhooks allow you to get the latest information on your dbt jobs in real time. + - [Link to documentation](/docs/deploy/webhooks) +- Semantic Layers/Metrics + - **Overview: Our Semantic Layer is made up of two parts: metrics definitions and the ability to interactively query the dbt metrics. For more details, here is a [basic overview](docs/use-dbt-semantic-layer/dbt-sl) and [our best practices](/guides/dbt-ecosystem/sl-partner-integration-guide).** + - Metrics definitions can be pulled from the Discovery API (linked above) or the Semantic Layer Driver/GraphQL API. The key difference is the Discovery API is not able to pull the semantic graph which provides the list of available dimensions that one can query per metric. That is only available via the SL Driver/APIs. The tradeoff is the SL Driver/APIs does not have access to the lineage of the entire dbt project (i.e how the dbt metrics dependencies on dbt models) + - [We have three available integration points for the Semantic Layer API.](/docs/dbt-cloud-apis/sl-api-overview) + +## dbt Cloud Hosting and Authentication + +To use the dbt Cloud APIs, you will need access to the customer’s access urls. Depending on their dbt Cloud setup, they will have a different access url. To find out more, here is the [documentation](/docs/cloud/about-cloud/regions-ip-addresses) to understand all the possible configurations. My recommendation is to allow the customer to provide their own url to simplify support. + +If the customer is on an Azure Single Tenant instance, they do not currently have access to the Discovery API or the Semantic Layer APIs. + +For authentication, we highly recommend that your integration uses account service tokens. You can read more about how to create a service token and what permission sets to provide it [here](/docs/dbt-cloud-apis/service-tokens). Please note depending on their plan type, they will have access to different permission sets. We **do not** recommend that users supply their user bearer tokens for authentication. This can cause issues if the user leaves the organization and provides you access to all the dbt Cloud accounts associated to the user rather than just the account (and related projects) that they want to integrate with. + +## Potential Use Cases + +- Event-based orchestration + - **Desired Action:** You wish to receive information that a scheduled dbt Cloud Job has been completed or kick off a dbt Cloud job. You can align your product schedule to the dbt Cloud run schedule. + - **Examples:** Kicking off a dbt Job after the ETL job of extracting and loading the data is completed. Or receiving a webhook after the job has been completed to kick off your reverse ETL job. + - **Integration Points:** Webhooks and/or Admin API +- dbt Lineage + - **Desired Action:** You wish to interpolate the dbt lineage metadata into your tool. + - **Example: In your tool, you wish to pull in the dbt DAG into your lineage diagram. [This is what you could pull and how to do this.](/docs/dbt-cloud-apis/discovery-use-cases-and-examples#whats-the-full-data-lineage)** + - **Integration Points:** Discovery API +- dbt Environment/Job metadata + - **Desired Action:** You wish to interpolate dbt Cloud job information into your tool, including the status of the jobs, the status of the tables executed in the run, what tests passed, etc. + - **Example:** In your Business Intelligence tool, stakeholders select from tables that a dbt model created. You show the last time the model passed its tests/last run to show that the tables are current and can be trusted. [This is what you could pull and how to do this.](/docs/dbt-cloud-apis/discovery-use-cases-and-examples#whats-the-latest-state-of-each-model) + - **Integration Points:** Discovery API +- dbt Model Documentation + - **Desired Action:** You wish to interpolate dbt Project Information, including model descriptions, column descriptions, etc. + - **Example:** You want to extract out the dbt model description so that you can display and help the stakeholder understand what they are selecting from. This way, the creators can easily pass on the information without updating another system. [This is what you could pull and how to do this.](/docs/dbt-cloud-apis/discovery-use-cases-and-examples#what-does-this-dataset-and-its-columns-mean) + - **Integration Points:** Discovery API + +**dbt Core only users will have no access to the above integration points.** For dbt metadata, oftentimes our partners will create a dbt core integration by using the [dbt artifacts](/product/semantic-layer/) files generated by each run and provided by the user. With our Discovery API, we are providing a dynamic way to get the latest up to date information, parsed out for you. + +## dbt Cloud Plans & Permissions + +[The dbt Cloud plan type](https://www.getdbt.com/pricing) will change what the user has access to. There are four different types of plans: + +- **Developer**: This is free and available to one user with a limited amount of successful models built. This plan cannot access the APIs, Webhooks, or Semantic Layer. Limited to 1 project. +- **Team:** This plan has access to the APIs, Webhooks, and Semantic Layer. You may have up to 8 users on the account and one dbt Cloud Project. This is limited to 15,000 successful models built. +- **Enterprise** (Multi-tenant/Multi-cell): This plan has access to the APIs, Webhooks, and Semantic Layer. They may have more than one dbt Cloud Project based on how many dbt projects/domains they have using dbt. Majority of our enterprise customers are on multi-tenant dbt Cloud instances. +- **Enterprise** (Single-tenant): This plan may have access to the APIs, Webhooks, and Semantic Layer. If you are working with a specific customer, let us know, and we can confirm if their instance has access. + +## Frequently Asked Questions + +- What is a dbt Cloud Project? + - A dbt Cloud project is made up of two connections: one to the git repository and one to the data warehouse/platform. Most customers will have only one dbt Cloud Project in their account but there are enterprise clients who might have more depending on their use cases.The project also encapsulates two types of environments at minimal: a development environment and deployment environment. + - Oftentimes folks refer to the [dbt Project](/docs/build/projects) as the code hosted in their git repository. +- What is a dbt Cloud Environment? + - [For an overview, check out this documentation.](/docs/environments-in-dbt) At minimal an project will have one deployment type environment that they will be executing jobs on. The development environment powers the dbt Cloud IDE and Cloud CLI. +- Can we write back to the dbt project? + - At this moment, we do not have a Write API. A dbt project is hosted in a git repository, so if you have a git provider integration, you can manually open up a Pull Request on the project to maintain the version control process. +- Can you provide column-level information in the lineage? + - Column-level lineage is currently in beta release with more information to come. +- How do I get a Partner Account? + - Contact your Partner Manager with your account id (in your URL) +- Why should I not use the Admin API to pull out the dbt artifacts for metadata? + - We recommend not integrating with the Admin API to extract the dbt artifacts documentation. This is because the Discovery API provides more extensive information, a user-friendly structure and more reliable integration point. +- How do I get access to the dbt Brand assets? + - Check out this [page](https://www.getdbt.com/brand-guidelines/). Please make sure you’re not using our old logo(hint: there should only be one hole in the logo). Please also note that the name dbt and the dbt logo are trademarked by dbt Labs, and that use is governed by our brand guidelines - which are fairly specific for commercial uses. If you have any questions about proper use of our marks, please ask for your partner manager. +- How do I engage with the partnerships team? + - Email partnerships@dbtlabs.com. \ No newline at end of file From 4b7af55488c0fe2b5d2a710f744b8052028664a4 Mon Sep 17 00:00:00 2001 From: Amy Chen Date: Tue, 19 Dec 2023 12:40:33 -0500 Subject: [PATCH 02/60] fix broken links --- .../2023-12-20-partner-integration-guide.md | 32 +++++++++---------- website/blog/authors.yml | 2 +- 2 files changed, 16 insertions(+), 18 deletions(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 0eed3302716..f51181bf588 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -11,13 +11,11 @@ hide_table_of_contents: false date: 2023-12-20 is_featured: false --- - - ## Overview Over the course of my 3 years running the Partner Engineering team at dbt Labs, the most common question I have been asked is “How do we integrate with dbt?”. Because those conversations often start out at the same place, I decided to create this guide so I’m no longer the blocker to fundamental information. This also allows us to skip the intro and get to the fun conversations like what a joint solution for our customers would look like so much faster. -Now this guide does not include how to integrate with dbt Core. If you’re interested in creating an dbt Adapter, **[please check out this documentation instead.](/guides/dbt-ecosystem/adapter-development/1-what-are-adapters)** +Now this guide does not include how to integrate with dbt Core. If you’re interested in creating an dbt Adapter, **[please check out this documentation instead.](https://docs.getdbt.com/guides/dbt-ecosystem/adapter-development/1-what-are-adapters)** Instead we are going to focus on integrating with dbt Cloud. Integrating with dbt Cloud is a key requirement to become a dbt Labs technology partner, opening the door to a variety of collaborative commercial opportunities. @@ -25,31 +23,31 @@ Here I will cover how to get started, potential use cases you want to solve for, ## New to dbt Cloud? -If you're new to dbt and dbt Cloud, we recommend you and your software developers try our [Getting Started Quickstarts](quickstarts) after reading [What is dbt?](/docs/introduction). The documentation will help you familiarize yourself with how our users interact with dbt. By going through this, you will also create a sample dbt project to test your integration. +If you're new to dbt and dbt Cloud, we recommend you and your software developers try our [Getting Started Quickstarts](https://docs.getdbt.com/quickstarts) after reading [What is dbt?](https://docs.getdbt.com/docs/introduction). The documentation will help you familiarize yourself with how our users interact with dbt. By going through this, you will also create a sample dbt project to test your integration. If you require a partner dbt Cloud account to test on, we can upgrade an existing account or a trial account. **This account may only be used for development, training, and demonstration purposes.** Please speak to your partner manager if you're interested and provide the account id (provided in the URL). Our partner account has all of the enterprise level functionality and can be provided with a signed partnerships agreement. ## Integration Points -- [Discovery API (formerly referred to as Metadata API)](/docs/dbt-cloud-apis/discovery-api) +- [Discovery API (formerly referred to as Metadata API)](https://docs.getdbt.com/docs/dbt-cloud-apis/discovery-api) - **Overview**: This GraphQL API allows you to query the metadata that dbt Cloud generates every time you run a dbt Project. We have two schemas available (environment and job level). By default, we always recommend that you integrate with the environment level schema because it contains the latest state and historical run results of all the jobs run on the dbt Cloud project. The job level will only provide you the metadata of one job, giving you only a small snapshot of part of the project. -- [Administrative API (also referred to as the Admin API)](/docs/dbt-cloud-apis/admin-cloud-api) +- [Administrative API (also referred to as the Admin API)](https://docs.getdbt.com/docs/dbt-cloud-apis/admin-cloud-api) - **Overview:** This REST API allows you to orchestrate dbt Cloud jobs runs and help you administer a dbt Cloud account. For metadata retrieval, we recommend integrating with the Discovery API instead. - Webhooks - **Overview:** Outbound webhooks can send notifications about your dbt Cloud jobs to other systems. These webhooks allow you to get the latest information on your dbt jobs in real time. - - [Link to documentation](/docs/deploy/webhooks) + - [Link to documentation](https://docs.getdbt.com/docs/deploy/webhooks) - Semantic Layers/Metrics - - **Overview: Our Semantic Layer is made up of two parts: metrics definitions and the ability to interactively query the dbt metrics. For more details, here is a [basic overview](docs/use-dbt-semantic-layer/dbt-sl) and [our best practices](/guides/dbt-ecosystem/sl-partner-integration-guide).** + - **Overview: Our Semantic Layer is made up of two parts: metrics definitions and the ability to interactively query the dbt metrics. For more details, here is a [basic overview](https://docs.getdbt.com/docs/use-dbt-semantic-layer/dbt-sl) and [our best practices](https://docs.getdbt.com/guides/dbt-ecosystem/sl-partner-integration-guide).** - Metrics definitions can be pulled from the Discovery API (linked above) or the Semantic Layer Driver/GraphQL API. The key difference is the Discovery API is not able to pull the semantic graph which provides the list of available dimensions that one can query per metric. That is only available via the SL Driver/APIs. The tradeoff is the SL Driver/APIs does not have access to the lineage of the entire dbt project (i.e how the dbt metrics dependencies on dbt models) - - [We have three available integration points for the Semantic Layer API.](/docs/dbt-cloud-apis/sl-api-overview) + - [We have three available integration points for the Semantic Layer API.](https://docs.getdbt.com/docs/dbt-cloud-apis/sl-api-overview) ## dbt Cloud Hosting and Authentication -To use the dbt Cloud APIs, you will need access to the customer’s access urls. Depending on their dbt Cloud setup, they will have a different access url. To find out more, here is the [documentation](/docs/cloud/about-cloud/regions-ip-addresses) to understand all the possible configurations. My recommendation is to allow the customer to provide their own url to simplify support. +To use the dbt Cloud APIs, you will need access to the customer’s access urls. Depending on their dbt Cloud setup, they will have a different access url. To find out more, here is the [documentation](https://docs.getdbt.com/docs/cloud/about-cloud/regions-ip-addresses) to understand all the possible configurations. My recommendation is to allow the customer to provide their own url to simplify support. If the customer is on an Azure Single Tenant instance, they do not currently have access to the Discovery API or the Semantic Layer APIs. -For authentication, we highly recommend that your integration uses account service tokens. You can read more about how to create a service token and what permission sets to provide it [here](/docs/dbt-cloud-apis/service-tokens). Please note depending on their plan type, they will have access to different permission sets. We **do not** recommend that users supply their user bearer tokens for authentication. This can cause issues if the user leaves the organization and provides you access to all the dbt Cloud accounts associated to the user rather than just the account (and related projects) that they want to integrate with. +For authentication, we highly recommend that your integration uses account service tokens. You can read more about how to create a service token and what permission sets to provide it [here](https://docs.getdbt.com/docs/dbt-cloud-apis/service-tokens). Please note depending on their plan type, they will have access to different permission sets. We **do not** recommend that users supply their user bearer tokens for authentication. This can cause issues if the user leaves the organization and provides you access to all the dbt Cloud accounts associated to the user rather than just the account (and related projects) that they want to integrate with. ## Potential Use Cases @@ -59,18 +57,18 @@ For authentication, we highly recommend that your integration uses account servi - **Integration Points:** Webhooks and/or Admin API - dbt Lineage - **Desired Action:** You wish to interpolate the dbt lineage metadata into your tool. - - **Example: In your tool, you wish to pull in the dbt DAG into your lineage diagram. [This is what you could pull and how to do this.](/docs/dbt-cloud-apis/discovery-use-cases-and-examples#whats-the-full-data-lineage)** + - **Example: In your tool, you wish to pull in the dbt DAG into your lineage diagram. [This is what you could pull and how to do this.](https://docs.getdbt.com/docs/dbt-cloud-apis/discovery-use-cases-and-examples#whats-the-full-data-lineage)** - **Integration Points:** Discovery API - dbt Environment/Job metadata - **Desired Action:** You wish to interpolate dbt Cloud job information into your tool, including the status of the jobs, the status of the tables executed in the run, what tests passed, etc. - - **Example:** In your Business Intelligence tool, stakeholders select from tables that a dbt model created. You show the last time the model passed its tests/last run to show that the tables are current and can be trusted. [This is what you could pull and how to do this.](/docs/dbt-cloud-apis/discovery-use-cases-and-examples#whats-the-latest-state-of-each-model) + - **Example:** In your Business Intelligence tool, stakeholders select from tables that a dbt model created. You show the last time the model passed its tests/last run to show that the tables are current and can be trusted. [This is what you could pull and how to do this.](https://docs.getdbt.com/docs/dbt-cloud-apis/discovery-use-cases-and-examples#whats-the-latest-state-of-each-model) - **Integration Points:** Discovery API - dbt Model Documentation - **Desired Action:** You wish to interpolate dbt Project Information, including model descriptions, column descriptions, etc. - - **Example:** You want to extract out the dbt model description so that you can display and help the stakeholder understand what they are selecting from. This way, the creators can easily pass on the information without updating another system. [This is what you could pull and how to do this.](/docs/dbt-cloud-apis/discovery-use-cases-and-examples#what-does-this-dataset-and-its-columns-mean) + - **Example:** You want to extract out the dbt model description so that you can display and help the stakeholder understand what they are selecting from. This way, the creators can easily pass on the information without updating another system. [This is what you could pull and how to do this.](https://docs.getdbt.com/docs/dbt-cloud-apis/discovery-use-cases-and-examples#what-does-this-dataset-and-its-columns-mean) - **Integration Points:** Discovery API -**dbt Core only users will have no access to the above integration points.** For dbt metadata, oftentimes our partners will create a dbt core integration by using the [dbt artifacts](/product/semantic-layer/) files generated by each run and provided by the user. With our Discovery API, we are providing a dynamic way to get the latest up to date information, parsed out for you. +**dbt Core only users will have no access to the above integration points.** For dbt metadata, oftentimes our partners will create a dbt core integration by using the [dbt artifacts](https://www.getdbt.com/product/semantic-layer/) files generated by each run and provided by the user. With our Discovery API, we are providing a dynamic way to get the latest up to date information, parsed out for you. ## dbt Cloud Plans & Permissions @@ -85,9 +83,9 @@ For authentication, we highly recommend that your integration uses account servi - What is a dbt Cloud Project? - A dbt Cloud project is made up of two connections: one to the git repository and one to the data warehouse/platform. Most customers will have only one dbt Cloud Project in their account but there are enterprise clients who might have more depending on their use cases.The project also encapsulates two types of environments at minimal: a development environment and deployment environment. - - Oftentimes folks refer to the [dbt Project](/docs/build/projects) as the code hosted in their git repository. + - Oftentimes folks refer to the [dbt Project](https://docs.getdbt.com/docs/build/projects) as the code hosted in their git repository. - What is a dbt Cloud Environment? - - [For an overview, check out this documentation.](/docs/environments-in-dbt) At minimal an project will have one deployment type environment that they will be executing jobs on. The development environment powers the dbt Cloud IDE and Cloud CLI. + - [For an overview, check out this documentation.](https://docs.getdbt.com/docs/environments-in-dbt) At minimal an project will have one deployment type environment that they will be executing jobs on. The development environment powers the dbt Cloud IDE and Cloud CLI. - Can we write back to the dbt project? - At this moment, we do not have a Write API. A dbt project is hosted in a git repository, so if you have a git provider integration, you can manually open up a Pull Request on the project to maintain the version control process. - Can you provide column-level information in the lineage? diff --git a/website/blog/authors.yml b/website/blog/authors.yml index cd2bd162935..82cc300bdc8 100644 --- a/website/blog/authors.yml +++ b/website/blog/authors.yml @@ -1,6 +1,6 @@ amy_chen: image_url: /img/blog/authors/achen.png - job_title: Staff Partner Engineer + job_title: Product Partnerships Manager links: - icon: fa-linkedin url: https://www.linkedin.com/in/yuanamychen/ From 0d4ec7716f917b12f54102b40e08a68dbda468cb Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 15:45:35 -0500 Subject: [PATCH 03/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index f51181bf588..df42765825d 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -13,7 +13,7 @@ is_featured: false --- ## Overview -Over the course of my 3 years running the Partner Engineering team at dbt Labs, the most common question I have been asked is “How do we integrate with dbt?”. Because those conversations often start out at the same place, I decided to create this guide so I’m no longer the blocker to fundamental information. This also allows us to skip the intro and get to the fun conversations like what a joint solution for our customers would look like so much faster. +Over the course of my three years running the Partner Engineering team at dbt Labs, the most common question I've been asked is, How do we integrate with dbt? Because those conversations often start out at the same place, I decided to create this guide so I’m no longer the blocker to fundamental information. This also allows us to skip the intro and get to the fun conversations so much faster, like what a joint solution for our customers would look like. Now this guide does not include how to integrate with dbt Core. If you’re interested in creating an dbt Adapter, **[please check out this documentation instead.](https://docs.getdbt.com/guides/dbt-ecosystem/adapter-development/1-what-are-adapters)** From 44bf2cf36d86912636a47af580551b5f2165c711 Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 15:45:53 -0500 Subject: [PATCH 04/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index df42765825d..d589bf76dd4 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -17,7 +17,7 @@ Over the course of my three years running the Partner Engineering team at dbt La Now this guide does not include how to integrate with dbt Core. If you’re interested in creating an dbt Adapter, **[please check out this documentation instead.](https://docs.getdbt.com/guides/dbt-ecosystem/adapter-development/1-what-are-adapters)** -Instead we are going to focus on integrating with dbt Cloud. Integrating with dbt Cloud is a key requirement to become a dbt Labs technology partner, opening the door to a variety of collaborative commercial opportunities. +Instead, we're going to focus on integrating with dbt Cloud. Integrating with dbt Cloud is a key requirement to become a dbt Labs technology partner, opening the door to a variety of collaborative commercial opportunities. Here I will cover how to get started, potential use cases you want to solve for, and points of integrations to do so. From c28ecb48016971a6e28e61c476ae12bfae85a550 Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 15:46:10 -0500 Subject: [PATCH 05/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index d589bf76dd4..5353ca996fd 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -19,7 +19,7 @@ Now this guide does not include how to integrate with dbt Core. If you’re inte Instead, we're going to focus on integrating with dbt Cloud. Integrating with dbt Cloud is a key requirement to become a dbt Labs technology partner, opening the door to a variety of collaborative commercial opportunities. -Here I will cover how to get started, potential use cases you want to solve for, and points of integrations to do so. +Here I'll cover how to get started, potential use cases you want to solve for, and points of integrations to do so. ## New to dbt Cloud? From 402aee56cf622a0ef9d8d12c53afd3a1db2e249e Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 15:46:31 -0500 Subject: [PATCH 06/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 5353ca996fd..a48f18ef7cc 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -23,7 +23,7 @@ Here I'll cover how to get started, potential use cases you want to solve for, a ## New to dbt Cloud? -If you're new to dbt and dbt Cloud, we recommend you and your software developers try our [Getting Started Quickstarts](https://docs.getdbt.com/quickstarts) after reading [What is dbt?](https://docs.getdbt.com/docs/introduction). The documentation will help you familiarize yourself with how our users interact with dbt. By going through this, you will also create a sample dbt project to test your integration. +If you're new to dbt and dbt Cloud, we recommend you and your software developers try our [Getting Started Quickstarts](/guides) after reading [What is dbt?](/docs/introduction). The documentation will help you familiarize yourself with how our users interact with dbt. By going through this, you will also create a sample dbt project to test your integration. If you require a partner dbt Cloud account to test on, we can upgrade an existing account or a trial account. **This account may only be used for development, training, and demonstration purposes.** Please speak to your partner manager if you're interested and provide the account id (provided in the URL). Our partner account has all of the enterprise level functionality and can be provided with a signed partnerships agreement. From 434e7c0ce23345b6d73146fd3ba7875df6751e4f Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 15:46:48 -0500 Subject: [PATCH 07/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index a48f18ef7cc..0db135cf9bf 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -27,7 +27,7 @@ If you're new to dbt and dbt Cloud, we recommend you and your software developer If you require a partner dbt Cloud account to test on, we can upgrade an existing account or a trial account. **This account may only be used for development, training, and demonstration purposes.** Please speak to your partner manager if you're interested and provide the account id (provided in the URL). Our partner account has all of the enterprise level functionality and can be provided with a signed partnerships agreement. -## Integration Points +## Integration points - [Discovery API (formerly referred to as Metadata API)](https://docs.getdbt.com/docs/dbt-cloud-apis/discovery-api) - **Overview**: This GraphQL API allows you to query the metadata that dbt Cloud generates every time you run a dbt Project. We have two schemas available (environment and job level). By default, we always recommend that you integrate with the environment level schema because it contains the latest state and historical run results of all the jobs run on the dbt Cloud project. The job level will only provide you the metadata of one job, giving you only a small snapshot of part of the project. From 74e6fbbd25ad0943ad354c0a406833e7738d5fb7 Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 15:47:13 -0500 Subject: [PATCH 08/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 0db135cf9bf..85424a1219a 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -29,7 +29,7 @@ If you require a partner dbt Cloud account to test on, we can upgrade an existin ## Integration points -- [Discovery API (formerly referred to as Metadata API)](https://docs.getdbt.com/docs/dbt-cloud-apis/discovery-api) +- [Discovery API (formerly referred to as Metadata API)](/docs/dbt-cloud-apis/discovery-api) - **Overview**: This GraphQL API allows you to query the metadata that dbt Cloud generates every time you run a dbt Project. We have two schemas available (environment and job level). By default, we always recommend that you integrate with the environment level schema because it contains the latest state and historical run results of all the jobs run on the dbt Cloud project. The job level will only provide you the metadata of one job, giving you only a small snapshot of part of the project. - [Administrative API (also referred to as the Admin API)](https://docs.getdbt.com/docs/dbt-cloud-apis/admin-cloud-api) - **Overview:** This REST API allows you to orchestrate dbt Cloud jobs runs and help you administer a dbt Cloud account. For metadata retrieval, we recommend integrating with the Discovery API instead. From 6d215a8d793ba675cb53242de01eda58e7c4559c Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 15:47:28 -0500 Subject: [PATCH 09/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 85424a1219a..ec70e770431 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -25,7 +25,7 @@ Here I'll cover how to get started, potential use cases you want to solve for, a If you're new to dbt and dbt Cloud, we recommend you and your software developers try our [Getting Started Quickstarts](/guides) after reading [What is dbt?](/docs/introduction). The documentation will help you familiarize yourself with how our users interact with dbt. By going through this, you will also create a sample dbt project to test your integration. -If you require a partner dbt Cloud account to test on, we can upgrade an existing account or a trial account. **This account may only be used for development, training, and demonstration purposes.** Please speak to your partner manager if you're interested and provide the account id (provided in the URL). Our partner account has all of the enterprise level functionality and can be provided with a signed partnerships agreement. +If you require a partner dbt Cloud account to test on, we can upgrade an existing account or a trial account. This account may only be used for development, training, and demonstration purposes. Please contact your partner manager if you're interested and provide the account ID (provided in the URL). Our partner account includes all of the enterprise level functionality and can be provided with a signed partnerships agreement. ## Integration points From 74a53e22e95c1bc38c493e6d1cb01b65c2d3aa77 Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 15:49:55 -0500 Subject: [PATCH 10/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index ec70e770431..af93fbdae34 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -30,7 +30,7 @@ If you require a partner dbt Cloud account to test on, we can upgrade an existin ## Integration points - [Discovery API (formerly referred to as Metadata API)](/docs/dbt-cloud-apis/discovery-api) - - **Overview**: This GraphQL API allows you to query the metadata that dbt Cloud generates every time you run a dbt Project. We have two schemas available (environment and job level). By default, we always recommend that you integrate with the environment level schema because it contains the latest state and historical run results of all the jobs run on the dbt Cloud project. The job level will only provide you the metadata of one job, giving you only a small snapshot of part of the project. + - **Overview** — This GraphQL API allows you to query the metadata that dbt Cloud generates every time you run a dbt project. We have two schemas available (environment and job level). By default, we always recommend that you integrate with the environment level schema because it contains the latest state and historical run results of all the jobs run on the dbt Cloud project. The job level will only provide you the metadata of one job, giving you only a small snapshot of part of the project. - [Administrative API (also referred to as the Admin API)](https://docs.getdbt.com/docs/dbt-cloud-apis/admin-cloud-api) - **Overview:** This REST API allows you to orchestrate dbt Cloud jobs runs and help you administer a dbt Cloud account. For metadata retrieval, we recommend integrating with the Discovery API instead. - Webhooks From ec77ce086f441682332a8924f54799fcea6160b3 Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 15:50:14 -0500 Subject: [PATCH 11/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index af93fbdae34..491b88acc12 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -15,7 +15,7 @@ is_featured: false Over the course of my three years running the Partner Engineering team at dbt Labs, the most common question I've been asked is, How do we integrate with dbt? Because those conversations often start out at the same place, I decided to create this guide so I’m no longer the blocker to fundamental information. This also allows us to skip the intro and get to the fun conversations so much faster, like what a joint solution for our customers would look like. -Now this guide does not include how to integrate with dbt Core. If you’re interested in creating an dbt Adapter, **[please check out this documentation instead.](https://docs.getdbt.com/guides/dbt-ecosystem/adapter-development/1-what-are-adapters)** +This guide doesn't include how to integrate with dbt Core. If you’re interested in creating a dbt adapter, please check out the [adapter development guide](/guides/dbt-ecosystem/adapter-development/1-what-are-adapters) instead. Instead, we're going to focus on integrating with dbt Cloud. Integrating with dbt Cloud is a key requirement to become a dbt Labs technology partner, opening the door to a variety of collaborative commercial opportunities. From d652d75ee0ed3e3c815748e6da6f04750061dca5 Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 15:50:32 -0500 Subject: [PATCH 12/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 491b88acc12..f4e06eb6fa6 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -33,7 +33,7 @@ If you require a partner dbt Cloud account to test on, we can upgrade an existin - **Overview** — This GraphQL API allows you to query the metadata that dbt Cloud generates every time you run a dbt project. We have two schemas available (environment and job level). By default, we always recommend that you integrate with the environment level schema because it contains the latest state and historical run results of all the jobs run on the dbt Cloud project. The job level will only provide you the metadata of one job, giving you only a small snapshot of part of the project. - [Administrative API (also referred to as the Admin API)](https://docs.getdbt.com/docs/dbt-cloud-apis/admin-cloud-api) - **Overview:** This REST API allows you to orchestrate dbt Cloud jobs runs and help you administer a dbt Cloud account. For metadata retrieval, we recommend integrating with the Discovery API instead. -- Webhooks +- [Webhooks](/docs/deploy/webhooks) - **Overview:** Outbound webhooks can send notifications about your dbt Cloud jobs to other systems. These webhooks allow you to get the latest information on your dbt jobs in real time. - [Link to documentation](https://docs.getdbt.com/docs/deploy/webhooks) - Semantic Layers/Metrics From bd6426d970aba27c9101e2305921e2aada1aa43d Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 15:50:47 -0500 Subject: [PATCH 13/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index f4e06eb6fa6..7ad14063a29 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -34,7 +34,7 @@ If you require a partner dbt Cloud account to test on, we can upgrade an existin - [Administrative API (also referred to as the Admin API)](https://docs.getdbt.com/docs/dbt-cloud-apis/admin-cloud-api) - **Overview:** This REST API allows you to orchestrate dbt Cloud jobs runs and help you administer a dbt Cloud account. For metadata retrieval, we recommend integrating with the Discovery API instead. - [Webhooks](/docs/deploy/webhooks) - - **Overview:** Outbound webhooks can send notifications about your dbt Cloud jobs to other systems. These webhooks allow you to get the latest information on your dbt jobs in real time. + - **Overview** — Outbound webhooks can send notifications about your dbt Cloud jobs to other systems. These webhooks allow you to get the latest information about your dbt jobs in real time. - [Link to documentation](https://docs.getdbt.com/docs/deploy/webhooks) - Semantic Layers/Metrics - **Overview: Our Semantic Layer is made up of two parts: metrics definitions and the ability to interactively query the dbt metrics. For more details, here is a [basic overview](https://docs.getdbt.com/docs/use-dbt-semantic-layer/dbt-sl) and [our best practices](https://docs.getdbt.com/guides/dbt-ecosystem/sl-partner-integration-guide).** From d29101c0776373d7149e12691e441fa08afc5067 Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 15:51:02 -0500 Subject: [PATCH 14/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 7ad14063a29..03af0c4e3d0 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -32,7 +32,7 @@ If you require a partner dbt Cloud account to test on, we can upgrade an existin - [Discovery API (formerly referred to as Metadata API)](/docs/dbt-cloud-apis/discovery-api) - **Overview** — This GraphQL API allows you to query the metadata that dbt Cloud generates every time you run a dbt project. We have two schemas available (environment and job level). By default, we always recommend that you integrate with the environment level schema because it contains the latest state and historical run results of all the jobs run on the dbt Cloud project. The job level will only provide you the metadata of one job, giving you only a small snapshot of part of the project. - [Administrative API (also referred to as the Admin API)](https://docs.getdbt.com/docs/dbt-cloud-apis/admin-cloud-api) - - **Overview:** This REST API allows you to orchestrate dbt Cloud jobs runs and help you administer a dbt Cloud account. For metadata retrieval, we recommend integrating with the Discovery API instead. + - **Overview** — This REST API allows you to orchestrate dbt Cloud jobs runs and help you administer a dbt Cloud account. For metadata retrieval, we recommend integrating with the Discovery API instead. - [Webhooks](/docs/deploy/webhooks) - **Overview** — Outbound webhooks can send notifications about your dbt Cloud jobs to other systems. These webhooks allow you to get the latest information about your dbt jobs in real time. - [Link to documentation](https://docs.getdbt.com/docs/deploy/webhooks) From dce49403d18df90d11561cd296315960b745864f Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 15:51:18 -0500 Subject: [PATCH 15/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 03af0c4e3d0..8891f89cd82 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -36,7 +36,7 @@ If you require a partner dbt Cloud account to test on, we can upgrade an existin - [Webhooks](/docs/deploy/webhooks) - **Overview** — Outbound webhooks can send notifications about your dbt Cloud jobs to other systems. These webhooks allow you to get the latest information about your dbt jobs in real time. - [Link to documentation](https://docs.getdbt.com/docs/deploy/webhooks) -- Semantic Layers/Metrics +- [Semantic Layers/Metrics](/docs/dbt-cloud-apis/sl-api-overview) - **Overview: Our Semantic Layer is made up of two parts: metrics definitions and the ability to interactively query the dbt metrics. For more details, here is a [basic overview](https://docs.getdbt.com/docs/use-dbt-semantic-layer/dbt-sl) and [our best practices](https://docs.getdbt.com/guides/dbt-ecosystem/sl-partner-integration-guide).** - Metrics definitions can be pulled from the Discovery API (linked above) or the Semantic Layer Driver/GraphQL API. The key difference is the Discovery API is not able to pull the semantic graph which provides the list of available dimensions that one can query per metric. That is only available via the SL Driver/APIs. The tradeoff is the SL Driver/APIs does not have access to the lineage of the entire dbt project (i.e how the dbt metrics dependencies on dbt models) - [We have three available integration points for the Semantic Layer API.](https://docs.getdbt.com/docs/dbt-cloud-apis/sl-api-overview) From e7a5cfcbf4497acd2ff82c03bbd9d0792835d571 Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 15:51:36 -0500 Subject: [PATCH 16/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 8891f89cd82..bd95135bf2e 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -38,7 +38,7 @@ If you require a partner dbt Cloud account to test on, we can upgrade an existin - [Link to documentation](https://docs.getdbt.com/docs/deploy/webhooks) - [Semantic Layers/Metrics](/docs/dbt-cloud-apis/sl-api-overview) - **Overview: Our Semantic Layer is made up of two parts: metrics definitions and the ability to interactively query the dbt metrics. For more details, here is a [basic overview](https://docs.getdbt.com/docs/use-dbt-semantic-layer/dbt-sl) and [our best practices](https://docs.getdbt.com/guides/dbt-ecosystem/sl-partner-integration-guide).** - - Metrics definitions can be pulled from the Discovery API (linked above) or the Semantic Layer Driver/GraphQL API. The key difference is the Discovery API is not able to pull the semantic graph which provides the list of available dimensions that one can query per metric. That is only available via the SL Driver/APIs. The tradeoff is the SL Driver/APIs does not have access to the lineage of the entire dbt project (i.e how the dbt metrics dependencies on dbt models) + - Metrics definitions can be pulled from the Discovery API (linked above) or the Semantic Layer Driver/GraphQL API. The key difference is that the Discovery API isn't able to pull the semantic graph, which provides the list of available dimensions that one can query per metric. That is only available with the SL Driver/APIs. The trade-off is that the SL Driver/APIs doesn't have access to the lineage of the entire dbt project (that is, how the dbt metrics dependencies on dbt models). - [We have three available integration points for the Semantic Layer API.](https://docs.getdbt.com/docs/dbt-cloud-apis/sl-api-overview) ## dbt Cloud Hosting and Authentication From 8c2b058c0815d11ba6db37883f0ed900757bd316 Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 15:51:59 -0500 Subject: [PATCH 17/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index bd95135bf2e..2e03723719f 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -41,7 +41,7 @@ If you require a partner dbt Cloud account to test on, we can upgrade an existin - Metrics definitions can be pulled from the Discovery API (linked above) or the Semantic Layer Driver/GraphQL API. The key difference is that the Discovery API isn't able to pull the semantic graph, which provides the list of available dimensions that one can query per metric. That is only available with the SL Driver/APIs. The trade-off is that the SL Driver/APIs doesn't have access to the lineage of the entire dbt project (that is, how the dbt metrics dependencies on dbt models). - [We have three available integration points for the Semantic Layer API.](https://docs.getdbt.com/docs/dbt-cloud-apis/sl-api-overview) -## dbt Cloud Hosting and Authentication +## dbt Cloud hosting and authentication To use the dbt Cloud APIs, you will need access to the customer’s access urls. Depending on their dbt Cloud setup, they will have a different access url. To find out more, here is the [documentation](https://docs.getdbt.com/docs/cloud/about-cloud/regions-ip-addresses) to understand all the possible configurations. My recommendation is to allow the customer to provide their own url to simplify support. From 294a6aefc70b741de2cae76477b473975c7b40f4 Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 15:52:16 -0500 Subject: [PATCH 18/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 2e03723719f..9940ade8c69 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -37,7 +37,7 @@ If you require a partner dbt Cloud account to test on, we can upgrade an existin - **Overview** — Outbound webhooks can send notifications about your dbt Cloud jobs to other systems. These webhooks allow you to get the latest information about your dbt jobs in real time. - [Link to documentation](https://docs.getdbt.com/docs/deploy/webhooks) - [Semantic Layers/Metrics](/docs/dbt-cloud-apis/sl-api-overview) - - **Overview: Our Semantic Layer is made up of two parts: metrics definitions and the ability to interactively query the dbt metrics. For more details, here is a [basic overview](https://docs.getdbt.com/docs/use-dbt-semantic-layer/dbt-sl) and [our best practices](https://docs.getdbt.com/guides/dbt-ecosystem/sl-partner-integration-guide).** + - **Overview** — Our Semantic Layer is made up of two parts: metrics definitions and the ability to interactively query the dbt metrics. For more details, here is a [basic overview](/docs/use-dbt-semantic-layer/dbt-sl) and [our best practices](/guides/dbt-ecosystem/sl-partner-integration-guide). - Metrics definitions can be pulled from the Discovery API (linked above) or the Semantic Layer Driver/GraphQL API. The key difference is that the Discovery API isn't able to pull the semantic graph, which provides the list of available dimensions that one can query per metric. That is only available with the SL Driver/APIs. The trade-off is that the SL Driver/APIs doesn't have access to the lineage of the entire dbt project (that is, how the dbt metrics dependencies on dbt models). - [We have three available integration points for the Semantic Layer API.](https://docs.getdbt.com/docs/dbt-cloud-apis/sl-api-overview) From 27b085a7a5b428e860db900d9c7f2046ada82ac5 Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 15:52:32 -0500 Subject: [PATCH 19/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 9940ade8c69..38c3e9b6d6c 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -39,7 +39,7 @@ If you require a partner dbt Cloud account to test on, we can upgrade an existin - [Semantic Layers/Metrics](/docs/dbt-cloud-apis/sl-api-overview) - **Overview** — Our Semantic Layer is made up of two parts: metrics definitions and the ability to interactively query the dbt metrics. For more details, here is a [basic overview](/docs/use-dbt-semantic-layer/dbt-sl) and [our best practices](/guides/dbt-ecosystem/sl-partner-integration-guide). - Metrics definitions can be pulled from the Discovery API (linked above) or the Semantic Layer Driver/GraphQL API. The key difference is that the Discovery API isn't able to pull the semantic graph, which provides the list of available dimensions that one can query per metric. That is only available with the SL Driver/APIs. The trade-off is that the SL Driver/APIs doesn't have access to the lineage of the entire dbt project (that is, how the dbt metrics dependencies on dbt models). - - [We have three available integration points for the Semantic Layer API.](https://docs.getdbt.com/docs/dbt-cloud-apis/sl-api-overview) + - Three integration points are available for the Semantic Layer API. ## dbt Cloud hosting and authentication From efe6c44a886fe5efa3fcf6ea04d54fe920d529f2 Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 15:52:52 -0500 Subject: [PATCH 20/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 38c3e9b6d6c..727c1187542 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -31,7 +31,7 @@ If you require a partner dbt Cloud account to test on, we can upgrade an existin - [Discovery API (formerly referred to as Metadata API)](/docs/dbt-cloud-apis/discovery-api) - **Overview** — This GraphQL API allows you to query the metadata that dbt Cloud generates every time you run a dbt project. We have two schemas available (environment and job level). By default, we always recommend that you integrate with the environment level schema because it contains the latest state and historical run results of all the jobs run on the dbt Cloud project. The job level will only provide you the metadata of one job, giving you only a small snapshot of part of the project. -- [Administrative API (also referred to as the Admin API)](https://docs.getdbt.com/docs/dbt-cloud-apis/admin-cloud-api) +- [Administrative (Admin) API](/docs/dbt-cloud-apis/admin-cloud-api) - **Overview** — This REST API allows you to orchestrate dbt Cloud jobs runs and help you administer a dbt Cloud account. For metadata retrieval, we recommend integrating with the Discovery API instead. - [Webhooks](/docs/deploy/webhooks) - **Overview** — Outbound webhooks can send notifications about your dbt Cloud jobs to other systems. These webhooks allow you to get the latest information about your dbt jobs in real time. From 1b6cc262871831682f14464d5a66863305d466fa Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 15:55:55 -0500 Subject: [PATCH 21/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 727c1187542..1abe7b396d4 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -43,7 +43,7 @@ If you require a partner dbt Cloud account to test on, we can upgrade an existin ## dbt Cloud hosting and authentication -To use the dbt Cloud APIs, you will need access to the customer’s access urls. Depending on their dbt Cloud setup, they will have a different access url. To find out more, here is the [documentation](https://docs.getdbt.com/docs/cloud/about-cloud/regions-ip-addresses) to understand all the possible configurations. My recommendation is to allow the customer to provide their own url to simplify support. +To use the dbt Cloud APIs, you'll need access to the customer’s access urls. Depending on their dbt Cloud setup, they'll have a different access URL. To find out more, refer to [Regions & IP addresses](/docs/cloud/about-cloud/regions-ip-addresses) to understand all the possible configurations. My recommendation is to allow the customer to provide their own URL to simplify support. If the customer is on an Azure Single Tenant instance, they do not currently have access to the Discovery API or the Semantic Layer APIs. From 325c554b4f14eb1aaf7baff221d6e82cb2538e85 Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 15:57:49 -0500 Subject: [PATCH 22/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 1abe7b396d4..9207dad4d55 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -45,7 +45,7 @@ If you require a partner dbt Cloud account to test on, we can upgrade an existin To use the dbt Cloud APIs, you'll need access to the customer’s access urls. Depending on their dbt Cloud setup, they'll have a different access URL. To find out more, refer to [Regions & IP addresses](/docs/cloud/about-cloud/regions-ip-addresses) to understand all the possible configurations. My recommendation is to allow the customer to provide their own URL to simplify support. -If the customer is on an Azure Single Tenant instance, they do not currently have access to the Discovery API or the Semantic Layer APIs. +If the customer is on an Azure single tenant instance, they don't currently have access to the Discovery API or the Semantic Layer APIs. For authentication, we highly recommend that your integration uses account service tokens. You can read more about how to create a service token and what permission sets to provide it [here](https://docs.getdbt.com/docs/dbt-cloud-apis/service-tokens). Please note depending on their plan type, they will have access to different permission sets. We **do not** recommend that users supply their user bearer tokens for authentication. This can cause issues if the user leaves the organization and provides you access to all the dbt Cloud accounts associated to the user rather than just the account (and related projects) that they want to integrate with. From 151e4da6d1707694e009fe69186174be927950d2 Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 15:59:04 -0500 Subject: [PATCH 23/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 9207dad4d55..a01430e38b8 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -47,7 +47,7 @@ To use the dbt Cloud APIs, you'll need access to the customer’s access urls. D If the customer is on an Azure single tenant instance, they don't currently have access to the Discovery API or the Semantic Layer APIs. -For authentication, we highly recommend that your integration uses account service tokens. You can read more about how to create a service token and what permission sets to provide it [here](https://docs.getdbt.com/docs/dbt-cloud-apis/service-tokens). Please note depending on their plan type, they will have access to different permission sets. We **do not** recommend that users supply their user bearer tokens for authentication. This can cause issues if the user leaves the organization and provides you access to all the dbt Cloud accounts associated to the user rather than just the account (and related projects) that they want to integrate with. +For authentication, we highly recommend that your integration uses account service tokens. You can read more about [how to create a service token and what permission sets to provide it](/docs/dbt-cloud-apis/service-tokens). Please note that depending on their plan type, they'll have access to different permission sets. We _do not_ recommend that users supply their user bearer tokens for authentication. This can cause issues if the user leaves the organization and provides you access to all the dbt Cloud accounts associated to the user rather than just the account (and related projects) that they want to integrate with. ## Potential Use Cases From cec34b0fdf0d6a94e46fd78bf2e09a9fbc9304b6 Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 15:59:18 -0500 Subject: [PATCH 24/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index a01430e38b8..1fac6ab730f 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -52,7 +52,7 @@ For authentication, we highly recommend that your integration uses account servi ## Potential Use Cases - Event-based orchestration - - **Desired Action:** You wish to receive information that a scheduled dbt Cloud Job has been completed or kick off a dbt Cloud job. You can align your product schedule to the dbt Cloud run schedule. + - **Desired action** — You want to receive information that a scheduled dbt Cloud job has been completed or has kicked off a dbt Cloud job. You can align your product schedule to the dbt Cloud run schedule. - **Examples:** Kicking off a dbt Job after the ETL job of extracting and loading the data is completed. Or receiving a webhook after the job has been completed to kick off your reverse ETL job. - **Integration Points:** Webhooks and/or Admin API - dbt Lineage From 71db8f23bade59a08184a0b6a9d43b6b2604b267 Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 15:59:29 -0500 Subject: [PATCH 25/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 1fac6ab730f..d39876f5de0 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -54,7 +54,7 @@ For authentication, we highly recommend that your integration uses account servi - Event-based orchestration - **Desired action** — You want to receive information that a scheduled dbt Cloud job has been completed or has kicked off a dbt Cloud job. You can align your product schedule to the dbt Cloud run schedule. - **Examples:** Kicking off a dbt Job after the ETL job of extracting and loading the data is completed. Or receiving a webhook after the job has been completed to kick off your reverse ETL job. - - **Integration Points:** Webhooks and/or Admin API + - **Integration points** — Webhooks and/or Admin API - dbt Lineage - **Desired Action:** You wish to interpolate the dbt lineage metadata into your tool. - **Example: In your tool, you wish to pull in the dbt DAG into your lineage diagram. [This is what you could pull and how to do this.](https://docs.getdbt.com/docs/dbt-cloud-apis/discovery-use-cases-and-examples#whats-the-full-data-lineage)** From 1f17b84f1e98a47c4215343bbadfa324b488de80 Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 15:59:41 -0500 Subject: [PATCH 26/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index d39876f5de0..e74ed030c19 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -55,7 +55,7 @@ For authentication, we highly recommend that your integration uses account servi - **Desired action** — You want to receive information that a scheduled dbt Cloud job has been completed or has kicked off a dbt Cloud job. You can align your product schedule to the dbt Cloud run schedule. - **Examples:** Kicking off a dbt Job after the ETL job of extracting and loading the data is completed. Or receiving a webhook after the job has been completed to kick off your reverse ETL job. - **Integration points** — Webhooks and/or Admin API -- dbt Lineage +- dbt lineage - **Desired Action:** You wish to interpolate the dbt lineage metadata into your tool. - **Example: In your tool, you wish to pull in the dbt DAG into your lineage diagram. [This is what you could pull and how to do this.](https://docs.getdbt.com/docs/dbt-cloud-apis/discovery-use-cases-and-examples#whats-the-full-data-lineage)** - **Integration Points:** Discovery API From f0638c430a7ea9a2150c5a765621397749ac05f9 Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 15:59:53 -0500 Subject: [PATCH 27/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index e74ed030c19..b499373ca4f 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -56,7 +56,7 @@ For authentication, we highly recommend that your integration uses account servi - **Examples:** Kicking off a dbt Job after the ETL job of extracting and loading the data is completed. Or receiving a webhook after the job has been completed to kick off your reverse ETL job. - **Integration points** — Webhooks and/or Admin API - dbt lineage - - **Desired Action:** You wish to interpolate the dbt lineage metadata into your tool. + - **Desired action** — You want to interpolate the dbt lineage metadata into your tool. - **Example: In your tool, you wish to pull in the dbt DAG into your lineage diagram. [This is what you could pull and how to do this.](https://docs.getdbt.com/docs/dbt-cloud-apis/discovery-use-cases-and-examples#whats-the-full-data-lineage)** - **Integration Points:** Discovery API - dbt Environment/Job metadata From 50f4b3c800eb5d7c2c71783c53073c8299abccc7 Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 16:00:09 -0500 Subject: [PATCH 28/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index b499373ca4f..bd9649866ae 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -53,7 +53,7 @@ For authentication, we highly recommend that your integration uses account servi - Event-based orchestration - **Desired action** — You want to receive information that a scheduled dbt Cloud job has been completed or has kicked off a dbt Cloud job. You can align your product schedule to the dbt Cloud run schedule. - - **Examples:** Kicking off a dbt Job after the ETL job of extracting and loading the data is completed. Or receiving a webhook after the job has been completed to kick off your reverse ETL job. + - **Examples** — Kicking off a dbt job after the ETL job of extracting and loading the data is completed. Or receiving a webhook after the job has been completed to kick off your reverse ETL job. - **Integration points** — Webhooks and/or Admin API - dbt lineage - **Desired action** — You want to interpolate the dbt lineage metadata into your tool. From f235d7278e78b39c9c2459a420f6f53381967c4e Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 16:00:22 -0500 Subject: [PATCH 29/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index bd9649866ae..50562816369 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -49,7 +49,7 @@ If the customer is on an Azure single tenant instance, they don't currently have For authentication, we highly recommend that your integration uses account service tokens. You can read more about [how to create a service token and what permission sets to provide it](/docs/dbt-cloud-apis/service-tokens). Please note that depending on their plan type, they'll have access to different permission sets. We _do not_ recommend that users supply their user bearer tokens for authentication. This can cause issues if the user leaves the organization and provides you access to all the dbt Cloud accounts associated to the user rather than just the account (and related projects) that they want to integrate with. -## Potential Use Cases +## Potential use cases - Event-based orchestration - **Desired action** — You want to receive information that a scheduled dbt Cloud job has been completed or has kicked off a dbt Cloud job. You can align your product schedule to the dbt Cloud run schedule. From d9a9b6c2db809a8c168c30288caed3b8947ca9a4 Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 16:00:52 -0500 Subject: [PATCH 30/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 1 - 1 file changed, 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 50562816369..2be52eee2dc 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -35,7 +35,6 @@ If you require a partner dbt Cloud account to test on, we can upgrade an existin - **Overview** — This REST API allows you to orchestrate dbt Cloud jobs runs and help you administer a dbt Cloud account. For metadata retrieval, we recommend integrating with the Discovery API instead. - [Webhooks](/docs/deploy/webhooks) - **Overview** — Outbound webhooks can send notifications about your dbt Cloud jobs to other systems. These webhooks allow you to get the latest information about your dbt jobs in real time. - - [Link to documentation](https://docs.getdbt.com/docs/deploy/webhooks) - [Semantic Layers/Metrics](/docs/dbt-cloud-apis/sl-api-overview) - **Overview** — Our Semantic Layer is made up of two parts: metrics definitions and the ability to interactively query the dbt metrics. For more details, here is a [basic overview](/docs/use-dbt-semantic-layer/dbt-sl) and [our best practices](/guides/dbt-ecosystem/sl-partner-integration-guide). - Metrics definitions can be pulled from the Discovery API (linked above) or the Semantic Layer Driver/GraphQL API. The key difference is that the Discovery API isn't able to pull the semantic graph, which provides the list of available dimensions that one can query per metric. That is only available with the SL Driver/APIs. The trade-off is that the SL Driver/APIs doesn't have access to the lineage of the entire dbt project (that is, how the dbt metrics dependencies on dbt models). From e64fede56647042d7dd0e1d3b57a102ad56da35c Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 16:01:22 -0500 Subject: [PATCH 31/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 2be52eee2dc..5440a5d9f23 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -56,7 +56,7 @@ For authentication, we highly recommend that your integration uses account servi - **Integration points** — Webhooks and/or Admin API - dbt lineage - **Desired action** — You want to interpolate the dbt lineage metadata into your tool. - - **Example: In your tool, you wish to pull in the dbt DAG into your lineage diagram. [This is what you could pull and how to do this.](https://docs.getdbt.com/docs/dbt-cloud-apis/discovery-use-cases-and-examples#whats-the-full-data-lineage)** + - **Example** — In your tool, you want to pull in the dbt DAG into your lineage diagram. For details on what you could pull and how to do this, refer to [Use cases and examples for the Discovery API](/docs/dbt-cloud-apis/discovery-use-cases-and-examples). - **Integration Points:** Discovery API - dbt Environment/Job metadata - **Desired Action:** You wish to interpolate dbt Cloud job information into your tool, including the status of the jobs, the status of the tables executed in the run, what tests passed, etc. From c6bae5ec52d0e38a0611e9bde3fa921845f2bc2c Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 16:01:33 -0500 Subject: [PATCH 32/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 5440a5d9f23..2ac518fda6e 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -58,7 +58,7 @@ For authentication, we highly recommend that your integration uses account servi - **Desired action** — You want to interpolate the dbt lineage metadata into your tool. - **Example** — In your tool, you want to pull in the dbt DAG into your lineage diagram. For details on what you could pull and how to do this, refer to [Use cases and examples for the Discovery API](/docs/dbt-cloud-apis/discovery-use-cases-and-examples). - **Integration Points:** Discovery API -- dbt Environment/Job metadata +- dbt environment/job metadata - **Desired Action:** You wish to interpolate dbt Cloud job information into your tool, including the status of the jobs, the status of the tables executed in the run, what tests passed, etc. - **Example:** In your Business Intelligence tool, stakeholders select from tables that a dbt model created. You show the last time the model passed its tests/last run to show that the tables are current and can be trusted. [This is what you could pull and how to do this.](https://docs.getdbt.com/docs/dbt-cloud-apis/discovery-use-cases-and-examples#whats-the-latest-state-of-each-model) - **Integration Points:** Discovery API From ff218889307cb820046359b0b27b70f06303545e Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 16:01:56 -0500 Subject: [PATCH 33/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 2ac518fda6e..d89d32381bf 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -57,7 +57,7 @@ For authentication, we highly recommend that your integration uses account servi - dbt lineage - **Desired action** — You want to interpolate the dbt lineage metadata into your tool. - **Example** — In your tool, you want to pull in the dbt DAG into your lineage diagram. For details on what you could pull and how to do this, refer to [Use cases and examples for the Discovery API](/docs/dbt-cloud-apis/discovery-use-cases-and-examples). - - **Integration Points:** Discovery API + - **Integration points** — Discovery API - dbt environment/job metadata - **Desired Action:** You wish to interpolate dbt Cloud job information into your tool, including the status of the jobs, the status of the tables executed in the run, what tests passed, etc. - **Example:** In your Business Intelligence tool, stakeholders select from tables that a dbt model created. You show the last time the model passed its tests/last run to show that the tables are current and can be trusted. [This is what you could pull and how to do this.](https://docs.getdbt.com/docs/dbt-cloud-apis/discovery-use-cases-and-examples#whats-the-latest-state-of-each-model) From 6af40a3884fce985487fdca5642b2c346178aaef Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 16:07:02 -0500 Subject: [PATCH 34/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index d89d32381bf..b938dca050c 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -93,7 +93,7 @@ For authentication, we highly recommend that your integration uses account servi - Contact your Partner Manager with your account id (in your URL) - Why should I not use the Admin API to pull out the dbt artifacts for metadata? - We recommend not integrating with the Admin API to extract the dbt artifacts documentation. This is because the Discovery API provides more extensive information, a user-friendly structure and more reliable integration point. -- How do I get access to the dbt Brand assets? +- How do I get access to the dbt brand assets? - Check out this [page](https://www.getdbt.com/brand-guidelines/). Please make sure you’re not using our old logo(hint: there should only be one hole in the logo). Please also note that the name dbt and the dbt logo are trademarked by dbt Labs, and that use is governed by our brand guidelines - which are fairly specific for commercial uses. If you have any questions about proper use of our marks, please ask for your partner manager. - How do I engage with the partnerships team? - Email partnerships@dbtlabs.com. \ No newline at end of file From 3c91a599841f2e7c1bf8efdd3ba9ba5e05a408c2 Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 16:07:10 -0500 Subject: [PATCH 35/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index b938dca050c..27541fa232b 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -94,6 +94,6 @@ For authentication, we highly recommend that your integration uses account servi - Why should I not use the Admin API to pull out the dbt artifacts for metadata? - We recommend not integrating with the Admin API to extract the dbt artifacts documentation. This is because the Discovery API provides more extensive information, a user-friendly structure and more reliable integration point. - How do I get access to the dbt brand assets? - - Check out this [page](https://www.getdbt.com/brand-guidelines/). Please make sure you’re not using our old logo(hint: there should only be one hole in the logo). Please also note that the name dbt and the dbt logo are trademarked by dbt Labs, and that use is governed by our brand guidelines - which are fairly specific for commercial uses. If you have any questions about proper use of our marks, please ask for your partner manager. + - Check out our [Brand guidelines](https://www.getdbt.com/brand-guidelines/) page. Please make sure you’re not using our old logo (hint: there should only be one hole in the logo). Please also note that the name dbt and the dbt logo are trademarked by dbt Labs, and that use is governed by our brand guidelines, which are fairly specific for commercial uses. If you have any questions about proper use of our marks, please ask your partner manager. - How do I engage with the partnerships team? - Email partnerships@dbtlabs.com. \ No newline at end of file From b8d54492535a21217827ae763b38ed6a341a52ee Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 16:07:17 -0500 Subject: [PATCH 36/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 27541fa232b..e28b9ccf9d1 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -92,7 +92,7 @@ For authentication, we highly recommend that your integration uses account servi - How do I get a Partner Account? - Contact your Partner Manager with your account id (in your URL) - Why should I not use the Admin API to pull out the dbt artifacts for metadata? - - We recommend not integrating with the Admin API to extract the dbt artifacts documentation. This is because the Discovery API provides more extensive information, a user-friendly structure and more reliable integration point. + - We recommend not integrating with the Admin API to extract the dbt artifacts documentation. This is because the Discovery API provides more extensive information, a user-friendly structure, and a more reliable integration point. - How do I get access to the dbt brand assets? - Check out our [Brand guidelines](https://www.getdbt.com/brand-guidelines/) page. Please make sure you’re not using our old logo (hint: there should only be one hole in the logo). Please also note that the name dbt and the dbt logo are trademarked by dbt Labs, and that use is governed by our brand guidelines, which are fairly specific for commercial uses. If you have any questions about proper use of our marks, please ask your partner manager. - How do I engage with the partnerships team? From 298cd464fb60f6a93bc5525dd47a9e73c67125be Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 16:07:22 -0500 Subject: [PATCH 37/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index e28b9ccf9d1..fd269137235 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -90,7 +90,7 @@ For authentication, we highly recommend that your integration uses account servi - Can you provide column-level information in the lineage? - Column-level lineage is currently in beta release with more information to come. - How do I get a Partner Account? - - Contact your Partner Manager with your account id (in your URL) + - Contact your Partner Manager with your account ID (in your URL). - Why should I not use the Admin API to pull out the dbt artifacts for metadata? - We recommend not integrating with the Admin API to extract the dbt artifacts documentation. This is because the Discovery API provides more extensive information, a user-friendly structure, and a more reliable integration point. - How do I get access to the dbt brand assets? From 1635cecbb0c2dc1cc4011896cee03aa3d2cd0a6b Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 16:07:27 -0500 Subject: [PATCH 38/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index fd269137235..7c4cdef78c5 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -91,7 +91,7 @@ For authentication, we highly recommend that your integration uses account servi - Column-level lineage is currently in beta release with more information to come. - How do I get a Partner Account? - Contact your Partner Manager with your account ID (in your URL). -- Why should I not use the Admin API to pull out the dbt artifacts for metadata? +- Why shouldn't I use the Admin API to pull out the dbt artifacts for metadata? - We recommend not integrating with the Admin API to extract the dbt artifacts documentation. This is because the Discovery API provides more extensive information, a user-friendly structure, and a more reliable integration point. - How do I get access to the dbt brand assets? - Check out our [Brand guidelines](https://www.getdbt.com/brand-guidelines/) page. Please make sure you’re not using our old logo (hint: there should only be one hole in the logo). Please also note that the name dbt and the dbt logo are trademarked by dbt Labs, and that use is governed by our brand guidelines, which are fairly specific for commercial uses. If you have any questions about proper use of our marks, please ask your partner manager. From 2f2666897b966fcd909d6ccabe6ae1f99260c391 Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 16:07:43 -0500 Subject: [PATCH 39/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 7c4cdef78c5..9869ffd5bda 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -60,7 +60,7 @@ For authentication, we highly recommend that your integration uses account servi - **Integration points** — Discovery API - dbt environment/job metadata - **Desired Action:** You wish to interpolate dbt Cloud job information into your tool, including the status of the jobs, the status of the tables executed in the run, what tests passed, etc. - - **Example:** In your Business Intelligence tool, stakeholders select from tables that a dbt model created. You show the last time the model passed its tests/last run to show that the tables are current and can be trusted. [This is what you could pull and how to do this.](https://docs.getdbt.com/docs/dbt-cloud-apis/discovery-use-cases-and-examples#whats-the-latest-state-of-each-model) + - **Example** — In your Business Intelligence tool, stakeholders select from tables that a dbt model created. You show the last time the model passed its tests/last run to show that the tables are current and can be trusted. For details on what you could pull and how to do this, refer to [What's the latest state of each model](/docs/dbt-cloud-apis/discovery-use-cases-and-examples#whats-the-latest-state-of-each-model). - **Integration Points:** Discovery API - dbt Model Documentation - **Desired Action:** You wish to interpolate dbt Project Information, including model descriptions, column descriptions, etc. From eefe9e0052890abf23e561212020cfdd4df457f2 Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 16:07:50 -0500 Subject: [PATCH 40/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 9869ffd5bda..ec6a6e7c365 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -61,7 +61,7 @@ For authentication, we highly recommend that your integration uses account servi - dbt environment/job metadata - **Desired Action:** You wish to interpolate dbt Cloud job information into your tool, including the status of the jobs, the status of the tables executed in the run, what tests passed, etc. - **Example** — In your Business Intelligence tool, stakeholders select from tables that a dbt model created. You show the last time the model passed its tests/last run to show that the tables are current and can be trusted. For details on what you could pull and how to do this, refer to [What's the latest state of each model](/docs/dbt-cloud-apis/discovery-use-cases-and-examples#whats-the-latest-state-of-each-model). - - **Integration Points:** Discovery API + - **Integration points** — Discovery API - dbt Model Documentation - **Desired Action:** You wish to interpolate dbt Project Information, including model descriptions, column descriptions, etc. - **Example:** You want to extract out the dbt model description so that you can display and help the stakeholder understand what they are selecting from. This way, the creators can easily pass on the information without updating another system. [This is what you could pull and how to do this.](https://docs.getdbt.com/docs/dbt-cloud-apis/discovery-use-cases-and-examples#what-does-this-dataset-and-its-columns-mean) From c521160cee9e779f8aec9028db7c24a652fb955d Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 16:07:57 -0500 Subject: [PATCH 41/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index ec6a6e7c365..ff39616b5fb 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -59,7 +59,7 @@ For authentication, we highly recommend that your integration uses account servi - **Example** — In your tool, you want to pull in the dbt DAG into your lineage diagram. For details on what you could pull and how to do this, refer to [Use cases and examples for the Discovery API](/docs/dbt-cloud-apis/discovery-use-cases-and-examples). - **Integration points** — Discovery API - dbt environment/job metadata - - **Desired Action:** You wish to interpolate dbt Cloud job information into your tool, including the status of the jobs, the status of the tables executed in the run, what tests passed, etc. + - **Desired action** — You want to interpolate the dbt Cloud job information into your tool, including the status of the jobs, the status of the tables executed in the run, what tests passed, etc. - **Example** — In your Business Intelligence tool, stakeholders select from tables that a dbt model created. You show the last time the model passed its tests/last run to show that the tables are current and can be trusted. For details on what you could pull and how to do this, refer to [What's the latest state of each model](/docs/dbt-cloud-apis/discovery-use-cases-and-examples#whats-the-latest-state-of-each-model). - **Integration points** — Discovery API - dbt Model Documentation From ed73c02048c5b075c99338257573551be369be0d Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 16:08:03 -0500 Subject: [PATCH 42/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index ff39616b5fb..9fe53141dc5 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -63,7 +63,7 @@ For authentication, we highly recommend that your integration uses account servi - **Example** — In your Business Intelligence tool, stakeholders select from tables that a dbt model created. You show the last time the model passed its tests/last run to show that the tables are current and can be trusted. For details on what you could pull and how to do this, refer to [What's the latest state of each model](/docs/dbt-cloud-apis/discovery-use-cases-and-examples#whats-the-latest-state-of-each-model). - **Integration points** — Discovery API - dbt Model Documentation - - **Desired Action:** You wish to interpolate dbt Project Information, including model descriptions, column descriptions, etc. + - **Desired action** — You want to interpolate the dbt project Information, including model descriptions, column descriptions, etc. - **Example:** You want to extract out the dbt model description so that you can display and help the stakeholder understand what they are selecting from. This way, the creators can easily pass on the information without updating another system. [This is what you could pull and how to do this.](https://docs.getdbt.com/docs/dbt-cloud-apis/discovery-use-cases-and-examples#what-does-this-dataset-and-its-columns-mean) - **Integration Points:** Discovery API From f9d6b1e611cb6f33b4a73af9092c60b71ea71afb Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 16:08:14 -0500 Subject: [PATCH 43/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 9fe53141dc5..2b482eca245 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -67,7 +67,7 @@ For authentication, we highly recommend that your integration uses account servi - **Example:** You want to extract out the dbt model description so that you can display and help the stakeholder understand what they are selecting from. This way, the creators can easily pass on the information without updating another system. [This is what you could pull and how to do this.](https://docs.getdbt.com/docs/dbt-cloud-apis/discovery-use-cases-and-examples#what-does-this-dataset-and-its-columns-mean) - **Integration Points:** Discovery API -**dbt Core only users will have no access to the above integration points.** For dbt metadata, oftentimes our partners will create a dbt core integration by using the [dbt artifacts](https://www.getdbt.com/product/semantic-layer/) files generated by each run and provided by the user. With our Discovery API, we are providing a dynamic way to get the latest up to date information, parsed out for you. +dbt Core only users will have no access to the above integration points. For dbt metadata, oftentimes our partners will create a dbt Core integration by using the [dbt artifact](https://www.getdbt.com/product/semantic-layer/) files generated by each run and provided by the user. With the Discovery API, we are providing a dynamic way to get the latest information parsed out for you. ## dbt Cloud Plans & Permissions From fbc844d651b710c4376795a13340ce3f5ddafdda Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 16:08:20 -0500 Subject: [PATCH 44/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 2b482eca245..ab03edd69f7 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -73,7 +73,7 @@ dbt Core only users will have no access to the above integration points. For dbt [The dbt Cloud plan type](https://www.getdbt.com/pricing) will change what the user has access to. There are four different types of plans: -- **Developer**: This is free and available to one user with a limited amount of successful models built. This plan cannot access the APIs, Webhooks, or Semantic Layer. Limited to 1 project. +- **Developer** — This is free and available to one user with a limited amount of successful models built. This plan can't access the APIs, Webhooks, or Semantic Layer and is limited to just one project. - **Team:** This plan has access to the APIs, Webhooks, and Semantic Layer. You may have up to 8 users on the account and one dbt Cloud Project. This is limited to 15,000 successful models built. - **Enterprise** (Multi-tenant/Multi-cell): This plan has access to the APIs, Webhooks, and Semantic Layer. They may have more than one dbt Cloud Project based on how many dbt projects/domains they have using dbt. Majority of our enterprise customers are on multi-tenant dbt Cloud instances. - **Enterprise** (Single-tenant): This plan may have access to the APIs, Webhooks, and Semantic Layer. If you are working with a specific customer, let us know, and we can confirm if their instance has access. From f2ccece9f687926159d0a4797b9fe905095ead58 Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 16:08:35 -0500 Subject: [PATCH 45/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index ab03edd69f7..dd5ae6bad35 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -69,7 +69,7 @@ For authentication, we highly recommend that your integration uses account servi dbt Core only users will have no access to the above integration points. For dbt metadata, oftentimes our partners will create a dbt Core integration by using the [dbt artifact](https://www.getdbt.com/product/semantic-layer/) files generated by each run and provided by the user. With the Discovery API, we are providing a dynamic way to get the latest information parsed out for you. -## dbt Cloud Plans & Permissions +## dbt Cloud plans & permissions [The dbt Cloud plan type](https://www.getdbt.com/pricing) will change what the user has access to. There are four different types of plans: From dbb3924f965f4f5343d9a70e1ce55f76e59b6f1b Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 16:08:42 -0500 Subject: [PATCH 46/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index dd5ae6bad35..666ecd53f8d 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -75,7 +75,7 @@ dbt Core only users will have no access to the above integration points. For dbt - **Developer** — This is free and available to one user with a limited amount of successful models built. This plan can't access the APIs, Webhooks, or Semantic Layer and is limited to just one project. - **Team:** This plan has access to the APIs, Webhooks, and Semantic Layer. You may have up to 8 users on the account and one dbt Cloud Project. This is limited to 15,000 successful models built. -- **Enterprise** (Multi-tenant/Multi-cell): This plan has access to the APIs, Webhooks, and Semantic Layer. They may have more than one dbt Cloud Project based on how many dbt projects/domains they have using dbt. Majority of our enterprise customers are on multi-tenant dbt Cloud instances. +- **Enterprise** (multi-tenant/multi-cell) — This plan provides access to the APIs, webhooks, and Semantic Layer. You can have more than one dbt Cloud project based on how many dbt projects/domains they have using dbt. The majority of our enterprise customers are on multi-tenant dbt Cloud instances. - **Enterprise** (Single-tenant): This plan may have access to the APIs, Webhooks, and Semantic Layer. If you are working with a specific customer, let us know, and we can confirm if their instance has access. ## Frequently Asked Questions From 4358a4d752b06c8ec8bdebb9545fece1934101fc Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 16:08:49 -0500 Subject: [PATCH 47/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 666ecd53f8d..fd1c4a9a6f8 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -80,7 +80,7 @@ dbt Core only users will have no access to the above integration points. For dbt ## Frequently Asked Questions -- What is a dbt Cloud Project? +- What is a dbt Cloud project? - A dbt Cloud project is made up of two connections: one to the git repository and one to the data warehouse/platform. Most customers will have only one dbt Cloud Project in their account but there are enterprise clients who might have more depending on their use cases.The project also encapsulates two types of environments at minimal: a development environment and deployment environment. - Oftentimes folks refer to the [dbt Project](https://docs.getdbt.com/docs/build/projects) as the code hosted in their git repository. - What is a dbt Cloud Environment? From 5748cbe3d11f7c0129761c35b98bbeafa4f053d6 Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 16:09:18 -0500 Subject: [PATCH 48/60] Update website/blog/2023-12-20-partner-integration-guide.md --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index fd1c4a9a6f8..561d030385f 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -78,7 +78,7 @@ dbt Core only users will have no access to the above integration points. For dbt - **Enterprise** (multi-tenant/multi-cell) — This plan provides access to the APIs, webhooks, and Semantic Layer. You can have more than one dbt Cloud project based on how many dbt projects/domains they have using dbt. The majority of our enterprise customers are on multi-tenant dbt Cloud instances. - **Enterprise** (Single-tenant): This plan may have access to the APIs, Webhooks, and Semantic Layer. If you are working with a specific customer, let us know, and we can confirm if their instance has access. -## Frequently Asked Questions +## FAQs - What is a dbt Cloud project? - A dbt Cloud project is made up of two connections: one to the git repository and one to the data warehouse/platform. Most customers will have only one dbt Cloud Project in their account but there are enterprise clients who might have more depending on their use cases.The project also encapsulates two types of environments at minimal: a development environment and deployment environment. From c64ddc589fb98bd97cb8f756a8c81f6c2dabf93a Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 16:09:27 -0500 Subject: [PATCH 49/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 561d030385f..09b488a1b77 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -81,7 +81,7 @@ dbt Core only users will have no access to the above integration points. For dbt ## FAQs - What is a dbt Cloud project? - - A dbt Cloud project is made up of two connections: one to the git repository and one to the data warehouse/platform. Most customers will have only one dbt Cloud Project in their account but there are enterprise clients who might have more depending on their use cases.The project also encapsulates two types of environments at minimal: a development environment and deployment environment. + - A dbt Cloud project is made up of two connections: one to the Git repository and one to the data warehouse/platform. Most customers will have only one dbt Cloud project in their account but there are enterprise clients who might have more depending on their use cases. The project also encapsulates two types of environments at minimal: a development environment and deployment environment. - Oftentimes folks refer to the [dbt Project](https://docs.getdbt.com/docs/build/projects) as the code hosted in their git repository. - What is a dbt Cloud Environment? - [For an overview, check out this documentation.](https://docs.getdbt.com/docs/environments-in-dbt) At minimal an project will have one deployment type environment that they will be executing jobs on. The development environment powers the dbt Cloud IDE and Cloud CLI. From 3cf7408d6850b5d5ef76fd982dd89863d22f456e Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 16:09:33 -0500 Subject: [PATCH 50/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 09b488a1b77..116b966ab26 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -83,7 +83,7 @@ dbt Core only users will have no access to the above integration points. For dbt - What is a dbt Cloud project? - A dbt Cloud project is made up of two connections: one to the Git repository and one to the data warehouse/platform. Most customers will have only one dbt Cloud project in their account but there are enterprise clients who might have more depending on their use cases. The project also encapsulates two types of environments at minimal: a development environment and deployment environment. - Oftentimes folks refer to the [dbt Project](https://docs.getdbt.com/docs/build/projects) as the code hosted in their git repository. -- What is a dbt Cloud Environment? +- What is a dbt Cloud environment? - [For an overview, check out this documentation.](https://docs.getdbt.com/docs/environments-in-dbt) At minimal an project will have one deployment type environment that they will be executing jobs on. The development environment powers the dbt Cloud IDE and Cloud CLI. - Can we write back to the dbt project? - At this moment, we do not have a Write API. A dbt project is hosted in a git repository, so if you have a git provider integration, you can manually open up a Pull Request on the project to maintain the version control process. From 1b766c9071a8bb40a7e0d316fe8a867c4b14c308 Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 16:09:41 -0500 Subject: [PATCH 51/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 116b966ab26..2dd7b6765e1 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -86,7 +86,7 @@ dbt Core only users will have no access to the above integration points. For dbt - What is a dbt Cloud environment? - [For an overview, check out this documentation.](https://docs.getdbt.com/docs/environments-in-dbt) At minimal an project will have one deployment type environment that they will be executing jobs on. The development environment powers the dbt Cloud IDE and Cloud CLI. - Can we write back to the dbt project? - - At this moment, we do not have a Write API. A dbt project is hosted in a git repository, so if you have a git provider integration, you can manually open up a Pull Request on the project to maintain the version control process. + - At this moment, we don't have a Write API. A dbt project is hosted in a Git repository, so if you have a Git provider integration, you can manually open a pull request (PR) on the project to maintain the version control process. - Can you provide column-level information in the lineage? - Column-level lineage is currently in beta release with more information to come. - How do I get a Partner Account? From ea0ae3caab2db33a7bcb2a0a4bbcb6f980b7f28d Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 16:09:48 -0500 Subject: [PATCH 52/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 2dd7b6765e1..1e9e41c4993 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -84,7 +84,7 @@ dbt Core only users will have no access to the above integration points. For dbt - A dbt Cloud project is made up of two connections: one to the Git repository and one to the data warehouse/platform. Most customers will have only one dbt Cloud project in their account but there are enterprise clients who might have more depending on their use cases. The project also encapsulates two types of environments at minimal: a development environment and deployment environment. - Oftentimes folks refer to the [dbt Project](https://docs.getdbt.com/docs/build/projects) as the code hosted in their git repository. - What is a dbt Cloud environment? - - [For an overview, check out this documentation.](https://docs.getdbt.com/docs/environments-in-dbt) At minimal an project will have one deployment type environment that they will be executing jobs on. The development environment powers the dbt Cloud IDE and Cloud CLI. + - For an overview, check out [About environments](https://docs.getdbt.com/docs/environments-in-dbt). At a minimum, a project will have one deployment type environment that they will be executing jobs on. The development environment powers the dbt Cloud IDE and Cloud CLI. - Can we write back to the dbt project? - At this moment, we don't have a Write API. A dbt project is hosted in a Git repository, so if you have a Git provider integration, you can manually open a pull request (PR) on the project to maintain the version control process. - Can you provide column-level information in the lineage? From 872c676f423ebb9338c8f4839059878172e5e1ec Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 16:09:56 -0500 Subject: [PATCH 53/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 1e9e41c4993..a145bd71744 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -62,7 +62,7 @@ For authentication, we highly recommend that your integration uses account servi - **Desired action** — You want to interpolate the dbt Cloud job information into your tool, including the status of the jobs, the status of the tables executed in the run, what tests passed, etc. - **Example** — In your Business Intelligence tool, stakeholders select from tables that a dbt model created. You show the last time the model passed its tests/last run to show that the tables are current and can be trusted. For details on what you could pull and how to do this, refer to [What's the latest state of each model](/docs/dbt-cloud-apis/discovery-use-cases-and-examples#whats-the-latest-state-of-each-model). - **Integration points** — Discovery API -- dbt Model Documentation +- dbt model documentation - **Desired action** — You want to interpolate the dbt project Information, including model descriptions, column descriptions, etc. - **Example:** You want to extract out the dbt model description so that you can display and help the stakeholder understand what they are selecting from. This way, the creators can easily pass on the information without updating another system. [This is what you could pull and how to do this.](https://docs.getdbt.com/docs/dbt-cloud-apis/discovery-use-cases-and-examples#what-does-this-dataset-and-its-columns-mean) - **Integration Points:** Discovery API From f177a6dc7ff8624dde7e68fdf8960203651b9e58 Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 16:10:01 -0500 Subject: [PATCH 54/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index a145bd71744..859edcd0a3f 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -65,7 +65,7 @@ For authentication, we highly recommend that your integration uses account servi - dbt model documentation - **Desired action** — You want to interpolate the dbt project Information, including model descriptions, column descriptions, etc. - **Example:** You want to extract out the dbt model description so that you can display and help the stakeholder understand what they are selecting from. This way, the creators can easily pass on the information without updating another system. [This is what you could pull and how to do this.](https://docs.getdbt.com/docs/dbt-cloud-apis/discovery-use-cases-and-examples#what-does-this-dataset-and-its-columns-mean) - - **Integration Points:** Discovery API + - **Integration points** — Discovery API dbt Core only users will have no access to the above integration points. For dbt metadata, oftentimes our partners will create a dbt Core integration by using the [dbt artifact](https://www.getdbt.com/product/semantic-layer/) files generated by each run and provided by the user. With the Discovery API, we are providing a dynamic way to get the latest information parsed out for you. From 57ac462015dc064b320ba4b96466b85a3d82441a Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 16:10:11 -0500 Subject: [PATCH 55/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 859edcd0a3f..8823e90b8b7 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -64,7 +64,7 @@ For authentication, we highly recommend that your integration uses account servi - **Integration points** — Discovery API - dbt model documentation - **Desired action** — You want to interpolate the dbt project Information, including model descriptions, column descriptions, etc. - - **Example:** You want to extract out the dbt model description so that you can display and help the stakeholder understand what they are selecting from. This way, the creators can easily pass on the information without updating another system. [This is what you could pull and how to do this.](https://docs.getdbt.com/docs/dbt-cloud-apis/discovery-use-cases-and-examples#what-does-this-dataset-and-its-columns-mean) + - **Example** — You want to extract the dbt model description so you can display and help the stakeholder understand what they are selecting from. This way, the creators can easily pass on the information without updating another system. For details on what you could pull and how to do this, refer to [What does this dataset and its columns mean](/docs/dbt-cloud-apis/discovery-use-cases-and-examples#what-does-this-dataset-and-its-columns-mean). - **Integration points** — Discovery API dbt Core only users will have no access to the above integration points. For dbt metadata, oftentimes our partners will create a dbt Core integration by using the [dbt artifact](https://www.getdbt.com/product/semantic-layer/) files generated by each run and provided by the user. With the Discovery API, we are providing a dynamic way to get the latest information parsed out for you. From 715394bf4a08b039d62baff45f2f592aaf72bb10 Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 16:10:16 -0500 Subject: [PATCH 56/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 8823e90b8b7..8b198743dbc 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -74,7 +74,7 @@ dbt Core only users will have no access to the above integration points. For dbt [The dbt Cloud plan type](https://www.getdbt.com/pricing) will change what the user has access to. There are four different types of plans: - **Developer** — This is free and available to one user with a limited amount of successful models built. This plan can't access the APIs, Webhooks, or Semantic Layer and is limited to just one project. -- **Team:** This plan has access to the APIs, Webhooks, and Semantic Layer. You may have up to 8 users on the account and one dbt Cloud Project. This is limited to 15,000 successful models built. +- **Team** — This plan provides access to the APIs, webhooks, and Semantic Layer. You can have up to eight users on the account and one dbt Cloud Project. This is limited to 15,000 successful models built. - **Enterprise** (multi-tenant/multi-cell) — This plan provides access to the APIs, webhooks, and Semantic Layer. You can have more than one dbt Cloud project based on how many dbt projects/domains they have using dbt. The majority of our enterprise customers are on multi-tenant dbt Cloud instances. - **Enterprise** (Single-tenant): This plan may have access to the APIs, Webhooks, and Semantic Layer. If you are working with a specific customer, let us know, and we can confirm if their instance has access. From 68f3a68afbfc7d9887da3a07c856387a31141c4d Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 16:10:21 -0500 Subject: [PATCH 57/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 8b198743dbc..1f9d587b0f1 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -76,7 +76,7 @@ dbt Core only users will have no access to the above integration points. For dbt - **Developer** — This is free and available to one user with a limited amount of successful models built. This plan can't access the APIs, Webhooks, or Semantic Layer and is limited to just one project. - **Team** — This plan provides access to the APIs, webhooks, and Semantic Layer. You can have up to eight users on the account and one dbt Cloud Project. This is limited to 15,000 successful models built. - **Enterprise** (multi-tenant/multi-cell) — This plan provides access to the APIs, webhooks, and Semantic Layer. You can have more than one dbt Cloud project based on how many dbt projects/domains they have using dbt. The majority of our enterprise customers are on multi-tenant dbt Cloud instances. -- **Enterprise** (Single-tenant): This plan may have access to the APIs, Webhooks, and Semantic Layer. If you are working with a specific customer, let us know, and we can confirm if their instance has access. +- **Enterprise** (single tenant): This plan might have access to the APIs, webhooks, and Semantic Layer. If you're working with a specific customer, let us know and we can confirm if their instance has access. ## FAQs From 509f5a8a4aac7b7a924ad1736de2b4dc34d890f7 Mon Sep 17 00:00:00 2001 From: Amy Chen <46451573+amychen1776@users.noreply.github.com> Date: Wed, 20 Dec 2023 16:10:26 -0500 Subject: [PATCH 58/60] Update website/blog/2023-12-20-partner-integration-guide.md Co-authored-by: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 1f9d587b0f1..22fbbbafbb7 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -82,7 +82,7 @@ dbt Core only users will have no access to the above integration points. For dbt - What is a dbt Cloud project? - A dbt Cloud project is made up of two connections: one to the Git repository and one to the data warehouse/platform. Most customers will have only one dbt Cloud project in their account but there are enterprise clients who might have more depending on their use cases. The project also encapsulates two types of environments at minimal: a development environment and deployment environment. - - Oftentimes folks refer to the [dbt Project](https://docs.getdbt.com/docs/build/projects) as the code hosted in their git repository. + - Folks commonly refer to the [dbt project](https://docs.getdbt.com/docs/build/projects) as the code hosted in their Git repository. - What is a dbt Cloud environment? - For an overview, check out [About environments](https://docs.getdbt.com/docs/environments-in-dbt). At a minimum, a project will have one deployment type environment that they will be executing jobs on. The development environment powers the dbt Cloud IDE and Cloud CLI. - Can we write back to the dbt project? From d459a08ed34f042bc4d4962eeb2f075be7408d0a Mon Sep 17 00:00:00 2001 From: Amy Chen Date: Wed, 20 Dec 2023 17:27:40 -0500 Subject: [PATCH 59/60] fix links --- .../2023-12-20-partner-integration-guide.md | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 22fbbbafbb7..1c1ea8f893c 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -15,7 +15,7 @@ is_featured: false Over the course of my three years running the Partner Engineering team at dbt Labs, the most common question I've been asked is, How do we integrate with dbt? Because those conversations often start out at the same place, I decided to create this guide so I’m no longer the blocker to fundamental information. This also allows us to skip the intro and get to the fun conversations so much faster, like what a joint solution for our customers would look like. -This guide doesn't include how to integrate with dbt Core. If you’re interested in creating a dbt adapter, please check out the [adapter development guide](/guides/dbt-ecosystem/adapter-development/1-what-are-adapters) instead. +This guide doesn't include how to integrate with dbt Core. If you’re interested in creating a dbt adapter, please check out the [adapter development guide](https://docs.getdbt.com/guides/dbt-ecosystem/adapter-development/1-what-are-adapters) instead. Instead, we're going to focus on integrating with dbt Cloud. Integrating with dbt Cloud is a key requirement to become a dbt Labs technology partner, opening the door to a variety of collaborative commercial opportunities. @@ -23,30 +23,30 @@ Here I'll cover how to get started, potential use cases you want to solve for, a ## New to dbt Cloud? -If you're new to dbt and dbt Cloud, we recommend you and your software developers try our [Getting Started Quickstarts](/guides) after reading [What is dbt?](/docs/introduction). The documentation will help you familiarize yourself with how our users interact with dbt. By going through this, you will also create a sample dbt project to test your integration. +If you're new to dbt and dbt Cloud, we recommend you and your software developers try our [Getting Started Quickstarts](https://docs.getdbt.com/guides) after reading [What is dbt?](https://docs.getdbt.com/docs/introduction). The documentation will help you familiarize yourself with how our users interact with dbt. By going through this, you will also create a sample dbt project to test your integration. If you require a partner dbt Cloud account to test on, we can upgrade an existing account or a trial account. This account may only be used for development, training, and demonstration purposes. Please contact your partner manager if you're interested and provide the account ID (provided in the URL). Our partner account includes all of the enterprise level functionality and can be provided with a signed partnerships agreement. ## Integration points -- [Discovery API (formerly referred to as Metadata API)](/docs/dbt-cloud-apis/discovery-api) +- [Discovery API (formerly referred to as Metadata API)](https://docs.getdbt.com/docs/dbt-cloud-apis/discovery-api) - **Overview** — This GraphQL API allows you to query the metadata that dbt Cloud generates every time you run a dbt project. We have two schemas available (environment and job level). By default, we always recommend that you integrate with the environment level schema because it contains the latest state and historical run results of all the jobs run on the dbt Cloud project. The job level will only provide you the metadata of one job, giving you only a small snapshot of part of the project. -- [Administrative (Admin) API](/docs/dbt-cloud-apis/admin-cloud-api) +- [Administrative (Admin) API](https://docs.getdbt.com/docs/dbt-cloud-apis/admin-cloud-api) - **Overview** — This REST API allows you to orchestrate dbt Cloud jobs runs and help you administer a dbt Cloud account. For metadata retrieval, we recommend integrating with the Discovery API instead. -- [Webhooks](/docs/deploy/webhooks) +- [Webhooks](https://docs.getdbt.com/docs/deploy/webhooks) - **Overview** — Outbound webhooks can send notifications about your dbt Cloud jobs to other systems. These webhooks allow you to get the latest information about your dbt jobs in real time. -- [Semantic Layers/Metrics](/docs/dbt-cloud-apis/sl-api-overview) - - **Overview** — Our Semantic Layer is made up of two parts: metrics definitions and the ability to interactively query the dbt metrics. For more details, here is a [basic overview](/docs/use-dbt-semantic-layer/dbt-sl) and [our best practices](/guides/dbt-ecosystem/sl-partner-integration-guide). +- [Semantic Layers/Metrics](https://docs.getdbt.com/docs/dbt-cloud-apis/sl-api-overview) + - **Overview** — Our Semantic Layer is made up of two parts: metrics definitions and the ability to interactively query the dbt metrics. For more details, here is a [basic overview](https://docs.getdbt.com/docs/use-dbt-semantic-layer/dbt-sl) and [our best practices](https://docs.getdbt.com/guides/dbt-ecosystem/sl-partner-integration-guide). - Metrics definitions can be pulled from the Discovery API (linked above) or the Semantic Layer Driver/GraphQL API. The key difference is that the Discovery API isn't able to pull the semantic graph, which provides the list of available dimensions that one can query per metric. That is only available with the SL Driver/APIs. The trade-off is that the SL Driver/APIs doesn't have access to the lineage of the entire dbt project (that is, how the dbt metrics dependencies on dbt models). - Three integration points are available for the Semantic Layer API. ## dbt Cloud hosting and authentication -To use the dbt Cloud APIs, you'll need access to the customer’s access urls. Depending on their dbt Cloud setup, they'll have a different access URL. To find out more, refer to [Regions & IP addresses](/docs/cloud/about-cloud/regions-ip-addresses) to understand all the possible configurations. My recommendation is to allow the customer to provide their own URL to simplify support. +To use the dbt Cloud APIs, you'll need access to the customer’s access urls. Depending on their dbt Cloud setup, they'll have a different access URL. To find out more, refer to [Regions & IP addresses](https://docs.getdbt.com/docs/cloud/about-cloud/regions-ip-addresses) to understand all the possible configurations. My recommendation is to allow the customer to provide their own URL to simplify support. If the customer is on an Azure single tenant instance, they don't currently have access to the Discovery API or the Semantic Layer APIs. -For authentication, we highly recommend that your integration uses account service tokens. You can read more about [how to create a service token and what permission sets to provide it](/docs/dbt-cloud-apis/service-tokens). Please note that depending on their plan type, they'll have access to different permission sets. We _do not_ recommend that users supply their user bearer tokens for authentication. This can cause issues if the user leaves the organization and provides you access to all the dbt Cloud accounts associated to the user rather than just the account (and related projects) that they want to integrate with. +For authentication, we highly recommend that your integration uses account service tokens. You can read more about [how to create a service token and what permission sets to provide it](https://docs.getdbt.com/docs/dbt-cloud-apis/service-tokens). Please note that depending on their plan type, they'll have access to different permission sets. We _do not_ recommend that users supply their user bearer tokens for authentication. This can cause issues if the user leaves the organization and provides you access to all the dbt Cloud accounts associated to the user rather than just the account (and related projects) that they want to integrate with. ## Potential use cases @@ -56,15 +56,15 @@ For authentication, we highly recommend that your integration uses account servi - **Integration points** — Webhooks and/or Admin API - dbt lineage - **Desired action** — You want to interpolate the dbt lineage metadata into your tool. - - **Example** — In your tool, you want to pull in the dbt DAG into your lineage diagram. For details on what you could pull and how to do this, refer to [Use cases and examples for the Discovery API](/docs/dbt-cloud-apis/discovery-use-cases-and-examples). + - **Example** — In your tool, you want to pull in the dbt DAG into your lineage diagram. For details on what you could pull and how to do this, refer to [Use cases and examples for the Discovery API](https://docs.getdbt.com/docs/dbt-cloud-apis/discovery-use-cases-and-examples). - **Integration points** — Discovery API - dbt environment/job metadata - **Desired action** — You want to interpolate the dbt Cloud job information into your tool, including the status of the jobs, the status of the tables executed in the run, what tests passed, etc. - - **Example** — In your Business Intelligence tool, stakeholders select from tables that a dbt model created. You show the last time the model passed its tests/last run to show that the tables are current and can be trusted. For details on what you could pull and how to do this, refer to [What's the latest state of each model](/docs/dbt-cloud-apis/discovery-use-cases-and-examples#whats-the-latest-state-of-each-model). + - **Example** — In your Business Intelligence tool, stakeholders select from tables that a dbt model created. You show the last time the model passed its tests/last run to show that the tables are current and can be trusted. For details on what you could pull and how to do this, refer to [What's the latest state of each model](https://docs.getdbt.com/docs/dbt-cloud-apis/discovery-use-cases-and-examples#whats-the-latest-state-of-each-model). - **Integration points** — Discovery API - dbt model documentation - **Desired action** — You want to interpolate the dbt project Information, including model descriptions, column descriptions, etc. - - **Example** — You want to extract the dbt model description so you can display and help the stakeholder understand what they are selecting from. This way, the creators can easily pass on the information without updating another system. For details on what you could pull and how to do this, refer to [What does this dataset and its columns mean](/docs/dbt-cloud-apis/discovery-use-cases-and-examples#what-does-this-dataset-and-its-columns-mean). + - **Example** — You want to extract the dbt model description so you can display and help the stakeholder understand what they are selecting from. This way, the creators can easily pass on the information without updating another system. For details on what you could pull and how to do this, refer to [What does this dataset and its columns mean](https://docs.getdbt.com/docs/dbt-cloud-apis/discovery-use-cases-and-examples#what-does-this-dataset-and-its-columns-mean). - **Integration points** — Discovery API dbt Core only users will have no access to the above integration points. For dbt metadata, oftentimes our partners will create a dbt Core integration by using the [dbt artifact](https://www.getdbt.com/product/semantic-layer/) files generated by each run and provided by the user. With the Discovery API, we are providing a dynamic way to get the latest information parsed out for you. From 4fa9d370ce42701a72dcd8b457e87cdc5e2fdbaa Mon Sep 17 00:00:00 2001 From: Ly Nguyen <107218380+nghi-ly@users.noreply.github.com> Date: Wed, 20 Dec 2023 15:14:13 -0800 Subject: [PATCH 60/60] Update website/blog/2023-12-20-partner-integration-guide.md --- website/blog/2023-12-20-partner-integration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/blog/2023-12-20-partner-integration-guide.md b/website/blog/2023-12-20-partner-integration-guide.md index 1c1ea8f893c..b546f258f6c 100644 --- a/website/blog/2023-12-20-partner-integration-guide.md +++ b/website/blog/2023-12-20-partner-integration-guide.md @@ -23,7 +23,7 @@ Here I'll cover how to get started, potential use cases you want to solve for, a ## New to dbt Cloud? -If you're new to dbt and dbt Cloud, we recommend you and your software developers try our [Getting Started Quickstarts](https://docs.getdbt.com/guides) after reading [What is dbt?](https://docs.getdbt.com/docs/introduction). The documentation will help you familiarize yourself with how our users interact with dbt. By going through this, you will also create a sample dbt project to test your integration. +If you're new to dbt and dbt Cloud, we recommend you and your software developers try our [Getting Started Quickstarts](https://docs.getdbt.com/guides) after reading [What is dbt](https://docs.getdbt.com/docs/introduction). The documentation will help you familiarize yourself with how our users interact with dbt. By going through this, you will also create a sample dbt project to test your integration. If you require a partner dbt Cloud account to test on, we can upgrade an existing account or a trial account. This account may only be used for development, training, and demonstration purposes. Please contact your partner manager if you're interested and provide the account ID (provided in the URL). Our partner account includes all of the enterprise level functionality and can be provided with a signed partnerships agreement.