You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/unify/linked-profiles/setup-guides/databricks-setup.md
+24-25Lines changed: 24 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,60 +5,59 @@ plan: unify
5
5
hidden: true
6
6
---
7
7
8
-
> info "Linked Events is in private beta"
9
-
> Linked Eventsis in private beta, and Segment is actively working on this feature. Some functionality may change before it becomes generally available.
8
+
> info "Linked Profiles is in public beta"
9
+
> Linked Profiles (Data Graph, Linked Events, and Linked Audiences) is in public beta, and Segment is actively working on this feature. Some functionality may change before it becomes generally available.
10
10
11
-
On this page, you'll learn how to connect your Databricks data warehouse to your Segment Data Graph.
11
+
On this page, you'll learn how to connect your Databricks data warehouse to the Segment Data Graph.
12
12
13
13
> info ""
14
14
> At this time, you can only use Databricks with Linked Audiences.
15
15
16
16
## Set up Databricks credentials
17
17
18
-
Sign into Databricks with admin permissions to create new resources and provide Data Graph with the necessary permissions.
18
+
Sign into Databricks with admin permissions to create new resources and provide the Data Graph with the necessary permissions.
19
19
20
20
Segment assumes that you already have a workspace that includes the datasets you'd like to use for the Data Graph. Segment recommends setting up a new Service Principal user with only the permissions to access the required catalogs and schemas.
21
21
22
-
### Step 1: Set up a Service Principal and SQL Warehouse
22
+
### Step 1: Set up a Service Principal user and SQL Warehouse
23
23
24
-
Segment recommends that you set up a new Service Principal. If you already have a Service Principal you'd like to use, grant it "Can use" permissions for your data warehouse and proceed to [Step 2: Create a catalog for Segment to store checkpoint tables](#step-2-create-a-catalog-for-segment-to-store-checkpoint-tables).
24
+
Segment recommends that you set up a new Service Principal user. If you already have a Service Principal user you'd like to use, grant it "Can use" permissions for your data warehouse and proceed to [Step 2: Create a catalog for Segment to store checkpoint tables](#step-2-create-a-catalog-for-segment-to-store-checkpoint-tables).
25
25
26
-
To verify that your Service Principal has "Can use" permission, see the [Confirm Service Principal permissions](#confirm-service-principal-permissions) documentation.
26
+
If you want to create a new Service Principal user, complete the following substeps:
27
27
28
-
#### Create a new Service Principal User
28
+
#### Substep 1: Create a new Service Principal user
29
29
1. Log into the Databricks UI as an Admin.
30
30
2. Click **User Management**.
31
31
3. Select the **Service principals** tab.
32
32
4. Click **Add Service Principal**.
33
-
5. Enter a Service principal name and click **Add**.
34
-
6. Select the Service Principal you just created and click **Generate secret**.
33
+
5. Enter a Service Principal user name and click **Add**.
34
+
6. Select the Service Principal user you just created and click **Generate secret**.
35
35
7. Save the **Secret** and **Client ID** to a safe place. You'll need these values to connect your Databricks warehouse to Segment.
36
-
8. To add the user to the workspace:
37
-
1. Navigate to Workspaces and select your Workspace.
38
-
2. Select the “Permissions” tab and click **Add Permissions**.
39
-
3. Add the newly created Service Principal user and click **Save**.
36
+
8. Navigate to Workspaces and select your Workspace.
37
+
9. Select the “Permissions” tab and click **Add Permissions**.
38
+
10. Add the newly created Service Principal user and click **Save**.
40
39
41
40
> success ""
42
-
> If you already have a warehouse you'd like to use, you can [Add your Service Principal User to Warehouse User Lists](#add-your-service-principal-user-to-warehouse-user-lists). If you need to create a new warehouse, see the [Create a new warehouse](#create-a-new-warehouse)documentation.
41
+
> If you already have a warehouse you'd like to use, you can move on to the next substep, [Substep 2: Add your Service Principal user to Warehouse User Lists](#substep-2-add-your-service-principal-user-to-warehouse-user-lists). If you need to create a new warehouse first, see the [Create a new warehouse](#create-a-new-warehouse)before completing the next substep.
43
42
44
-
#### Add your Service Principal User to Warehouse User Lists
43
+
#### Substep 2: Add your Service Principal user to Warehouse User Lists
45
44
1. Log into the Databricks UI as an Admin.
46
45
2. Navigate to SQL Warehouses.
47
46
3. Select your warehouse and click **Permissions**.
48
-
4. Add the Service Principal user and grant the user “Can use” access.
47
+
4. Add the Service Principal user and grant them “Can use” access.
49
48
5. Click **Add**.
50
49
51
-
##### Confirm Service Principal permissions
50
+
##### (Optional) Confirm Service Principal permissions
52
51
Confirm that the Service Principal user that you're using to connect to Segment has "Can use" permissions for your warehouse.
53
52
54
-
To confirm that your Service Principal has "Can use" permission:
53
+
To confirm that your Service Principal user has "Can use" permission:
55
54
1. In the Databricks console, navigate to SQL Warehouses and select your warehouse.
56
55
2. Navigate to Overview and click **Permissions**.
57
-
3. Verify that the Service Principal has "Can use" permission.
56
+
3. Verify that the Service Principal user has "Can use" permission.
58
57
59
58
### Step 2: Create a catalog for Segment to store checkpoint tables
60
59
61
-
> warning "Segment recommends creating an empty catalog for Data Graph"
60
+
> warning "Segment recommends creating an empty catalog for the Data Graph"
62
61
> If you plan to use an existing catalog with Reverse ETL, follow the instructions in the [Update user access for Segment Reverse ETL catalog](#update-user-access-for-segment-reverse-etl-catalog) section.
63
62
64
63
Segment requires write access to a catalog to create a schema for internal bookkeeping, and to store checkpoint tables for the queries that are executed.
@@ -81,8 +80,8 @@ Run the SQL below to grant the Data Graph read-only access to the Profiles Sync
81
80
GRANT USAGE, SELECT, USE SCHEMA ON CATALOG `${profiles_sync_catalog}` TO `${client_id}`;
82
81
```
83
82
84
-
### Step 4: Grant read-only access to additional catalogs for Data Graph
85
-
Run the SQL below to grant your Service Principal read-only access to any additional catalogs you want to use for Data Graph:
83
+
### Step 4: Grant read-only access to additional catalogs for the Data Graph
84
+
Run the SQL below to grant your Service Principal user read-only access to any additional catalogs you want to use for the Data Graph:
86
85
87
86
```sql
88
87
-- Run the SQL below for each catalog you want to use for the Segment Data Graph
@@ -102,7 +101,7 @@ GRANT USAGE, SELECT ON SCHEMA `${schema_2}` TO `${client_id}`;
102
101
103
102
```
104
103
105
-
### (Optional) Restrict read access to tables
104
+
### (Optional) Restrict read-only access to tables
106
105
Restrict access to specific tables by running the following SQL:
107
106
108
107
```sql
@@ -140,7 +139,7 @@ Segment requires the following settings to connect to your Databricks warehouse.
140
139
-**Service principal client ID**: The client ID used to access to your Databricks warehouse
141
140
-**OAuth secret**: The OAuth secret used to connect to your Databricks warehouse
142
141
143
-
After identifying the following settings, continue setting up your Data Graph by following the instructions in [Connect your warehouse to the Data Graph](/docs/unify/linked-profiles/data-graph/#step-2-connect-your-warehouse-to-the-data-graph).
142
+
After identifying the following settings, continue setting up the Data Graph by following the instructions in [Connect your warehouse to the Data Graph](/docs/unify/linked-profiles/data-graph/#step-2-connect-your-warehouse-to-the-data-graph).
0 commit comments