Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Add Connect to Databricks SQL page in GX Cloud #10394

Merged
merged 4 commits into from
Sep 18, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions docs/docusaurus/docs/cloud/connect/connect_databrickssql.md
Original file line number Diff line number Diff line change
@@ -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 [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

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).
Loading