From 96532ddd78abfad58bdeecf4f6967db2dd8e4a45 Mon Sep 17 00:00:00 2001 From: allisongx <166552166+allisongx@users.noreply.github.com> Date: Fri, 13 Sep 2024 17:12:55 -0400 Subject: [PATCH 1/2] Adds page to describe how to connect to Databricks SQL in GX Cloud --- .../cloud/connect/connect_databrickssql.md | 42 +++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 docs/docusaurus/docs/cloud/connect/connect_databrickssql.md diff --git a/docs/docusaurus/docs/cloud/connect/connect_databrickssql.md b/docs/docusaurus/docs/cloud/connect/connect_databrickssql.md new file mode 100644 index 000000000000..f75197f14650 --- /dev/null +++ b/docs/docusaurus/docs/cloud/connect/connect_databrickssql.md @@ -0,0 +1,42 @@ +--- +sidebar_label: 'Connect GX Cloud to Databricks SQL' +title: 'Connect GX Cloud to Databricks SQL' +description: Connect GX Cloud to a Databricks SQL Data Source. +--- + +import TabItem from '@theme/TabItem'; +import Tabs from '@theme/Tabs'; + +## Prerequisites + +- You have a [GX Cloud account](https://greatexpectations.io/cloud) with [Admin or Editor permissions](../about_gx.md#roles-and-responsibilities). + +- You have a Databricks SQL catalog, schema, and table. + +- To improve data security, GX recommends creating a separate Databricks SQL user for your GX Cloud connection. + + +## Connect to a Databricks SQL Data Asset + +1. In GX Cloud, click **Data Assets** > **New Data Asset** > **Databricks SQL**. + +2. Enter a meaningful name for the Data Source in the **Data Source name** field. + +3. Enter a connection string in the **Connection string** field. The connection string format is `databricks://token:{token}@{host}?http_path={http_path}&catalog={catalog}&schema={schema}`. + - Check the instructions to create a GX-specific user in your Databricks SQL catalog by clicking "See instructions" + +4. Click **Connect**. + +5. Select tables to import as Data Assets: + + - Check the box next to a table name to add that table as an asset. + + - At least one table must be added. + + - To search for a specific table type the table's name in the Search box above the list of tables. + + - To add all of the available tables check the box for All Tables. + +6. Click **Add Asset**. + +7. Create an Expectation. See [Create an Expectation](/cloud/expectations/manage_expectations.md#create-an-expectation). From a24093aa15e35af20f8c3ff5eb7d919e2580dfd9 Mon Sep 17 00:00:00 2001 From: allisongx <166552166+allisongx@users.noreply.github.com> Date: Wed, 18 Sep 2024 10:33:38 -0400 Subject: [PATCH 2/2] Replace user with service principal --- docs/docusaurus/docs/cloud/connect/connect_databrickssql.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docusaurus/docs/cloud/connect/connect_databrickssql.md b/docs/docusaurus/docs/cloud/connect/connect_databrickssql.md index f75197f14650..5a00a0e333c0 100644 --- a/docs/docusaurus/docs/cloud/connect/connect_databrickssql.md +++ b/docs/docusaurus/docs/cloud/connect/connect_databrickssql.md @@ -13,7 +13,7 @@ import Tabs from '@theme/Tabs'; - You have a Databricks SQL catalog, schema, and table. -- To improve data security, GX recommends creating a separate Databricks SQL user for your GX Cloud connection. +- To improve data security, GX recommends creating a separate Databricks SQL [service principal](https://docs.databricks.com/en/admin/users-groups/service-principals.html#manage-service-principals-in-your-account) for your GX Cloud connection. ## Connect to a Databricks SQL Data Asset