Skip to content

Commit

Permalink
Fast-follows for MS Fabric docs (#4538)
Browse files Browse the repository at this point in the history
## What are you changing in this pull request and why?

Microsoft Fabric docs fast-follows
- Create new dbt Cloud MS Fabric connect page and link to it from
https://docs.getdbt.com/docs/cloud/connect-data-platform/about-connections
- Add new dbt Cloud MS Fabric connect page to sidebar
- Update this page
https://docs.getdbt.com/docs/core/connect-data-platform/fabric-setup to
say it's supported in dbt Cloud
- Add link to MS Fabric on
https://docs.getdbt.com/docs/core/connect-data-platform/about-core-connections
- Update tile in verified adapters to point to new connect page
- Update quickstart
- Update release note

## 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).
- [ ] Needs review from DX

Adding new pages (delete if not applicable):
- [x] Add page to `website/sidebars.js`
- [x] Provide a unique filename for the new page
  • Loading branch information
nghi-ly authored Nov 29, 2023
2 parents f484d26 + 43a0e13 commit b5c27c9
Show file tree
Hide file tree
Showing 8 changed files with 62 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,15 @@ title: "About data platform connections"
id: about-connections
description: "Information about data platform connections"
sidebar_label: "About data platform connections"
pagination_next: "docs/cloud/connect-data-platform/connect-starburst-trino"
pagination_next: "docs/cloud/connect-data-platform/connect-microsoft-fabric"
pagination_prev: null
---
dbt Cloud can connect with a variety of data platform providers including:
- [Amazon Redshift](/docs/cloud/connect-data-platform/connect-redshift-postgresql-alloydb)
- [Apache Spark](/docs/cloud/connect-data-platform/connect-apache-spark)
- [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)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: "Connect Microsoft Fabric"
description: "Configure Microsoft Fabric connection."
sidebar_label: "Connect Microsoft Fabric"
---

## Supported authentication methods
The supported authentication methods are:
- Azure Active Directory (Azure AD) service principal
- Azure AD password

SQL password (LDAP) is not supported in Microsoft Fabric Synapse Data Warehouse so you must use Azure AD. This means that to use [Microsoft Fabric](https://www.microsoft.com/en-us/microsoft-fabric) in dbt Cloud, you will need at least one Azure AD service principal to connect dbt Cloud to Fabric, ideally one service principal for each user.

### Active Directory service principal
The following are the required fields for setting up a connection with a Microsoft Fabric using Azure AD service principal authentication.

| Field | Description |
| --- | --- |
| **Server** | The service principal's **host** value for the Fabric test endpoint. |
| **Port** | The port to connect to Microsoft Fabric. You can use `1433` (the default), which is the standard SQL server port number. |
| **Database** | The service principal's **database** value for the Fabric 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 a Microsoft Fabric using Azure AD password authentication.

| Field | Description |
| --- | --- |
| **Server** | The server hostname to connect to Microsoft Fabric. |
| **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. |

## Configuration

To learn how to optimize performance with data platform-specific configurations in dbt Cloud, refer to [Microsoft Fabric DWH configurations](/reference/resource-configs/fabric-configs).
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ dbt Core can connect with a variety of data platform providers including:
- [Apache Spark](/docs/core/connect-data-platform/spark-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)
- [PostgreSQL](/docs/core/connect-data-platform/postgres-setup)
- [Snowflake](/docs/core/connect-data-platform/snowflake-setup)
- [Starburst or Trino](/docs/core/connect-data-platform/trino-setup)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ meta:
github_repo: 'Microsoft/dbt-fabric'
pypi_package: 'dbt-fabric'
min_core_version: '1.4.0'
cloud_support: Not Supported
cloud_support: Supported
platform_name: 'Microsoft Fabric'
config_page: '/reference/resource-configs/fabric-configs'
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ date: 2023-11-28

Public Preview is now available in dbt Cloud for Microsoft Fabric!

To learn more, check out the [Quickstart for dbt Cloud and Microsoft Fabric](/guides/microsoft-fabric?step=1). The guide walks you through:
To learn more, refer to [Connect Microsoft Fabric](/docs/cloud/connect-data-platform/connect-microsoft-fabric) and [Microsoft Fabric DWH configurations](/reference/resource-configs/fabric-configs).

Also, check out the [Quickstart for dbt Cloud and Microsoft Fabric](/guides/microsoft-fabric?step=1). The guide walks you through:

- Loading the Jaffle Shop sample data (provided by dbt Labs) into your Microsoft Fabric warehouse.
- Connecting dbt Cloud to Microsoft Fabric.
Expand Down
17 changes: 10 additions & 7 deletions website/docs/guides/microsoft-fabric-qs.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ recently_updated: true
---
## Introduction

In this quickstart guide, you'll learn how to use dbt Cloud with Microsoft Fabric. It will show you how to:
In this quickstart guide, you'll learn how to use dbt Cloud with [Microsoft Fabric](https://www.microsoft.com/en-us/microsoft-fabric). It will show you how to:

- Load the Jaffle Shop sample data (provided by dbt Labs) into your Microsoft Fabric warehouse.
- Connect dbt Cloud to Microsoft Fabric.
Expand All @@ -27,7 +27,7 @@ A public preview of Microsoft Fabric in dbt Cloud is now available!
### Prerequisites
- You have a [dbt Cloud](https://www.getdbt.com/signup/) account.
- You have started the Microsoft Fabric (Preview) trial. For details, refer to [Microsoft Fabric (Preview) trial](https://learn.microsoft.com/en-us/fabric/get-started/fabric-trial) in the Microsoft docs.
- As a Microsoft admin, you’ve enabled service principal authentication. For details, refer to [Enable service principal authentication](https://learn.microsoft.com/en-us/fabric/admin/metadata-scanning-enable-read-only-apis) in the Microsoft docs. dbt Cloud needs these authentication credentials to connect to Microsoft Fabric.
- As a Microsoft admin, you’ve enabled service principal authentication. You must add the service principal to the Microsoft Fabric workspace with either a Member (recommended) or Admin permission set. For details, refer to [Enable service principal authentication](https://learn.microsoft.com/en-us/fabric/admin/metadata-scanning-enable-read-only-apis) in the Microsoft docs. dbt Cloud needs these authentication credentials to connect to Microsoft Fabric.

### Related content
- [dbt Courses](https://courses.getdbt.com/collections)
Expand All @@ -54,8 +54,8 @@ A public preview of Microsoft Fabric in dbt Cloud is now available!
CREATE TABLE dbo.customers
(
[ID] [int],
[FIRST_NAME] [varchar] (8000),
[LAST_NAME] [varchar] (8000)
\[FIRST_NAME] [varchar](8000),
\[LAST_NAME] [varchar](8000)
);

COPY INTO [dbo].[customers]
Expand All @@ -72,7 +72,7 @@ A public preview of Microsoft Fabric in dbt Cloud is now available!
[USER_ID] [int],
-- [ORDER_DATE] [int],
[ORDER_DATE] [date],
[STATUS] [varchar] (8000)
\[STATUS] [varchar](8000)
);

COPY INTO [dbo].[orders]
Expand All @@ -87,8 +87,8 @@ A public preview of Microsoft Fabric in dbt Cloud is now available!
(
[ID] [int],
[ORDERID] [int],
[PAYMENTMETHOD] [varchar] (8000),
[STATUS] [varchar] (8000),
\[PAYMENTMETHOD] [varchar](8000),
\[STATUS] [varchar](8000),
[AMOUNT] [int],
[CREATED] [date]
);
Expand All @@ -108,6 +108,9 @@ A public preview of Microsoft Fabric in dbt Cloud is now available!
2. Enter a project name and click **Continue**.
3. Choose **Fabric** as your connection and click **Next**.
4. In the **Configure your environment** section, enter the **Settings** for your new project:
- **Server** — Use the service principal's **host** value for the Fabric test endpoint.
- **Port** — 1433 (which is the default).
- **Database** — Use the service principal's **database** value for the Fabric test endpoint.
5. Enter the **Development credentials** for your new project:
- **Authentication** — Choose **Service Principal** from the dropdown.
- **Tenant ID** — Use the service principal’s **Directory (tenant) id** as the value.
Expand Down
1 change: 1 addition & 0 deletions website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ const sidebarSettings = {
link: { type: "doc", id: "docs/cloud/connect-data-platform/about-connections" },
items: [
"docs/cloud/connect-data-platform/about-connections",
"docs/cloud/connect-data-platform/connect-microsoft-fabric",
"docs/cloud/connect-data-platform/connect-starburst-trino",
"docs/cloud/connect-data-platform/connect-snowflake",
"docs/cloud/connect-data-platform/connect-bigquery",
Expand Down
2 changes: 1 addition & 1 deletion website/snippets/_adapters-verified.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@

<Card
title="Microsoft Fabric"
body="<a href='/guides/microsoft-fabric?step=1'><img src='/img/icons/dbt-bit.svg' width='7%'/>Set up in dbt Cloud </a> <br /><a href='/docs/core/connect-data-platform/fabric-setup'><img src='/img/icons/dbt-bit.svg' width='7%'/>Install with dbt Core </a> <br /><br /> <a href=https://badge.fury.io/py/dbt-fabric><img src=https://badge.fury.io/py/dbt-fabric.svg/></a>"
body="<a href='/docs/cloud/connect-data-platform/connect-microsoft-fabric'><img src='/img/icons/dbt-bit.svg' width='7%'/>Set up in dbt Cloud </a> <br /><a href='/docs/core/connect-data-platform/fabric-setup'><img src='/img/icons/dbt-bit.svg' width='7%'/>Install with dbt Core </a> <br /><br /> <a href=https://badge.fury.io/py/dbt-fabric><img src=https://badge.fury.io/py/dbt-fabric.svg/></a>"
icon="fabric"/>
<Card
title="Azure Synapse"
Expand Down

0 comments on commit b5c27c9

Please sign in to comment.