Skip to content

Commit

Permalink
Native support for Azure Synapse adapter in dbt Cloud (#5435)
Browse files Browse the repository at this point in the history
## What are you changing in this pull request and why?

Preview launch of native support for Azure Synapse Analytics (ASA) in
dbt Cloud plus other changes for May 14 launch

- Full [Azure docs
plan](https://www.notion.so/dbtlabs/Preview-Azure-Synapse-Analytics-in-dbt-Cloud-f24d9aff4b08472c8d3f586a091cfb62?pvs=4)
in Notion
- Removed "ASA coming soon" callouts
- Add redirect to fix 404 with
`https://docs.getdbt.com/docs/verified-adapters` (a deleted page)
- Microsoft Fabric GA. Removed all remaining "Public Preview" callouts

## Checklist
- [x] Review the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md)
so my content adheres to these guidelines.
- [x] For [docs
versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#about-versioning),
review how to [version a whole
page](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version)
and [version a block of
content](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-blocks-of-content).
- [x] Needs review from PM

Adding:
~~- [ ] Add page in `website/sidebars.js`~~ N/A
- [x] Provide a unique filename for new pages
- [x] Run link testing locally with `npm run build` to update the links
that point to deleted pages

---------

Co-authored-by: John Rock <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Matt Shaver <[email protected]>
Co-authored-by: Leona B. Campbell <[email protected]>
Co-authored-by: Amy Chen <[email protected]>
  • Loading branch information
6 people authored May 13, 2024
1 parent 95c1d2c commit 9100d28
Show file tree
Hide file tree
Showing 14 changed files with 414 additions and 21 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,15 @@ pagination_prev: null
dbt Cloud can connect with a variety of data platform providers including:
- [AlloyDB](/docs/cloud/connect-data-platform/connect-redshift-postgresql-alloydb)
- [Amazon Redshift](/docs/cloud/connect-data-platform/connect-redshift-postgresql-alloydb)
- [Apache Spark](/docs/cloud/connect-data-platform/connect-apache-spark)
- [Apache Spark](/docs/cloud/connect-data-platform/connect-apache-spark)
- [Azure Synapse Analytics](/docs/cloud/connect-data-platform/connect-azure-synapse-analytics) <Lifecycle status='public preview' />
- [Databricks](/docs/cloud/connect-data-platform/connect-databricks)
- [Google BigQuery](/docs/cloud/connect-data-platform/connect-bigquery)
- [Microsoft Fabric](/docs/cloud/connect-data-platform/connect-microsoft-fabric)
- [PostgreSQL](/docs/cloud/connect-data-platform/connect-redshift-postgresql-alloydb)
- [Snowflake](/docs/cloud/connect-data-platform/connect-snowflake)
- [Starburst or Trino](/docs/cloud/connect-data-platform/connect-starburst-trino)

import MSCallout from '/snippets/_microsoft-adapters-soon.md';

<MSCallout />

You can connect to your database in dbt Cloud by clicking the gear in the top right and selecting **Account Settings**. From the Account Settings page, click **+ New Project**.

<Lightbox src="/img/docs/dbt-cloud/cloud-configuring-dbt-cloud/choose-a-connection.png" title="Choose a connection"/>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
title: "Connect Azure Synapse Analytics"
description: "Configure Azure Synapse Analytics connection."
sidebar_label: "Connect Azure Synapse Analytics"
---

# Connect Azure Synapse Analytics <Lifecycle status='public preview' />

## Supported authentication methods
The supported authentication methods are:
- Microsoft Entra ID service principal
- Active Directory password
- SQL server authentication

### Microsoft Entra ID service principal
The following are the required fields for setting up a connection with Azure Synapse Analytics using Microsoft Entra ID service principal authentication.

| Field | Description |
| --- | --- |
| **Server** | The service principal's **Synapse host name** value (without the trailing string `, 1433`) for the Synapse test endpoint. |
| **Port** | The port to connect to Azure Synapse Analytics. You can use `1433` (the default), which is the standard SQL server port number. |
| **Database** | The service principal's **database** value for the Synapse test endpoint. |
| **Authentication** | Choose **Service Principal** from the dropdown. |
| **Tenant ID** | The service principal's **Directory (tenant) ID**. |
| **Client ID** | The service principal's **application (client) ID id**. |
| **Client secret** | The service principal's **client secret** (not the **client secret id**). |


### Active Directory password

The following are the required fields for setting up a connection with Azure Synapse Analytics using Active Directory password authentication.

| Field | Description |
| --- | --- |
| **Server** | The server hostname to connect to Azure Synapse Analytics. |
| **Port** | The server port. You can use `1433` (the default), which is the standard SQL server port number. |
| **Database** | The database name. |
| **Authentication** | Choose **Active Directory Password** from the dropdown. |
| **User** | The AD username. |
| **Password** | The AD username's password. |


### SQL server authentication

The following are the required fields for setting up a connection with Azure Synapse Analytics using SQL server authentication.

| Field | Description |
| --- | --- |
| **Server** | The server hostname or IP to connect to Azure Synapse Analytics. |
| **Port** | The server port. You can use `1433` (the default), which is the standard SQL server port number. |
| **Database** | The database name. |
| **Authentication** | Choose **SQL** from the dropdown. |
| **User** | The username. |
| **Password** | The username's password. |


## Configuration

To learn how to optimize performance with data platform-specific configurations in dbt Cloud, refer to [Microsoft Azure Synapse DWH configurations](/reference/resource-configs/azuresynapse-configs).
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ dbt Core can connect with a variety of data platform providers including:

- [Amazon Redshift](/docs/core/connect-data-platform/redshift-setup)
- [Apache Spark](/docs/core/connect-data-platform/spark-setup)
- [Azure Synapse](/docs/core/connect-data-platform/azuresynapse-setup)
- [Databricks](/docs/core/connect-data-platform/databricks-setup)
- [Google BigQuery](/docs/core/connect-data-platform/bigquery-setup)
- [Microsoft Fabric](/docs/core/connect-data-platform/fabric-setup)
Expand Down
6 changes: 6 additions & 0 deletions website/docs/docs/get-started-dbt.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,12 @@ Learn more about [dbt Cloud features](/docs/cloud/about-cloud/dbt-cloud-feature

<div className="grid--3-col">

<Card
title="Quickstart for dbt Cloud and Azure Synapse Analytics (Preview)"
body="Discover how to integrate dbt Cloud with Azure Synapse Analytics for your data transformations."
link="https://docs.getdbt.com/guides/azure-synapse-analytics"
icon="azure-synapse-analytics"/>

<Card
title="Quickstart for dbt Cloud and BigQuery"
body="Discover how to leverage dbt Cloud with BigQuery to streamline your analytics workflows."
Expand Down
4 changes: 0 additions & 4 deletions website/docs/docs/supported-data-platforms.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,6 @@ You can [connect](/docs/connect-adapters) to adapters and data platforms nativel

You can also further customize how dbt works with your specific data platform via configuration: see [Configuring Postgres](/reference/resource-configs/postgres-configs) for an example.

import MSCallout from '/snippets/_microsoft-adapters-soon.md';

<MSCallout />

## Types of Adapters

There are two types of adapters available today:
Expand Down
Loading

0 comments on commit 9100d28

Please sign in to comment.