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/profiles-sync/profiles-sync-setup/databricks-profiles-sync.md
+15-24Lines changed: 15 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,25 +14,6 @@ Before getting started with Databricks Profiles Sync, note the following prerequ
14
14
- Segment creates [managed tables](https://docs.databricks.com/en/data-governance/unity-catalog/create-tables.html#managed-tables){:target="_blank"} in the Unity catalog.
15
15
- Segment supports only [OAuth (M2M)](https://docs.databricks.com/en/dev-tools/auth/oauth-m2m.html){:target="_blank"} for authentication.
16
16
17
-
#### Service principal requirements and setup
18
-
19
-
Segment uses the service principal to access your Databricks workspace and associated APIs.
20
-
- Use the [Databricks guide for adding a service principal to your account](https://docs.databricks.com/en/administration-guide/users-groups/service-principals.html#manage-service-principals-in-your-account){:target="_blank"}. This name can be anything, but Segment recommends something that identifies the purpose (for example, "Segment Profiles Sync"). Note the Application ID that Databricks generates for later use. Segment doesn't require `Account admin` or `Marketplace admin` roles.
21
-
22
-
The service principal needs the following setup:
23
-
- OAuth secret tocken generated. Follow the [Databricks guide for generating an OAuth secret](https://docs.databricks.com/en/dev-tools/authentication-oauth.html#step-2-create-an-oauth-secret-for-a-service-principal){:target="_blank"}. Note the secret generated by Databricks for later use. Once you navigate away from the page the secret is no longer visible. If you lose or forget the secret, you can delete the existing secret and create a new one.
24
-
-[Catalog level priveleges](https://docs.databricks.com/en/data-governance/unity-catalog/manage-privileges/privileges.html#general-unity-catalog-privilege-types){:target="_blank"} which include:
25
-
- USE CATALOG
26
-
- USE SCHEMA
27
-
- MODIFY
28
-
- SELECT
29
-
- CREATE SCHEMA
30
-
- CREATE TABLE
31
-
- Databricks [SQL access entitlement](https://docs.databricks.com/en/administration-guide/users-groups/service-principals.html#manage-workspace-entitlements-for-a-service-principal){:target="_blank"} at the workspace level.
32
-
-[CAN USE permissions](https://docs.databricks.com/en/security/auth-authz/access-control/sql-endpoint-acl.html#sql-warehouse-permissions){:target="_blank"} on the SQL warehouse that will be used for the sync.
33
-
34
-
35
-
36
17
#### Warehouse size and performance
37
18
38
19
A SQL warehouse is required for compute. Segment recommends the following size:
@@ -42,7 +23,7 @@ A SQL warehouse is required for compute. Segment recommends the following size:
42
23
43
24
44
25
> success ""
45
-
> To improve the query performance of the Delta Lake, Segment recommends creating compact jobs per table using OPTIMIZE following [Databricks recommendations](https://docs.databricks.com/en/delta/optimize.html#){:target="_blank"}. <br>
26
+
> To improve the query performance of the Delta Lake, Segment recommends creating compact jobs per table using OPTIMIZE following [Databricks recommendations](https://docs.databricks.com/en/delta/optimize.html#){:target="_blank"}.
46
27
47
28
> info ""
48
29
> Segment recommends manually starting your SQL warehouse in advance. If the SQL warehouse isn't running, Segment attempts to start the SQL warehouse to validate the connection and may experience a timeout when you hit the **Test Connection** button during setup.
@@ -89,15 +70,25 @@ Next, add SQL warehouse details about your compute resource.
89
70
-**Port**: The port number of your SQL warehouse.
90
71
91
72
92
-
### Step 5: Add the principal service client ID and client secret
73
+
### Step 5: Add the service principal client ID and client secret
93
74
94
75
> warning ""
95
-
> Be sure to note the principal ID and the client secret Databricks generates in this step for later use.
76
+
> Be sure to note the principal ID and the client secret Databricks generates, as you'll need to enter them in this step.
96
77
97
78
Segment uses the service principal to access your Databricks workspace and associated APIs.
98
-
1. Follow the [Databricks guide for adding a service principal to your account](https://docs.databricks.com/en/administration-guide/users-groups/service-principals.html#manage-service-principals-in-your-account){:target="_blank"}. This name can be anything, but Segment recommends something that identifies the purpose (for example, "Segment Profiles Sync"). Note the principal application ID that Databricks generates for later use. Segment doesn't require Account admin or Marketplace admin roles.
99
-
2. Follow the [Databricks instructions to generate an OAuth secret](https://docs.databricks.com/en/dev-tools/authentication-oauth.html#step-2-create-an-oauth-secret-for-a-service-principal){:target="_blank"}. Note the secret generated by Databricks for later use. Once you navigate away from this page, the secret is no longer visible. If you lose or forget the secret, delete the existing secret and create a new one.
79
+
1. Follow the [Databricks guide for adding a service principal to your account](https://docs.databricks.com/en/administration-guide/users-groups/service-principals.html#manage-service-principals-in-your-account){:target="_blank"}. This name can be anything, but Segment recommends something that identifies the purpose (for example, "Segment Profiles Sync"). Note the principal application ID that Databricks generates to use in this step. Segment doesn't require `Account admin` or `Marketplace admin` roles.
80
+
2. Follow the [Databricks instructions to generate an OAuth secret](https://docs.databricks.com/en/dev-tools/authentication-oauth.html#step-2-create-an-oauth-secret-for-a-service-principal){:target="_blank"}. Note the secret generated by Databricks to use in this step. Once you navigate away from this page, the secret is no longer visible. If you lose or forget the secret, delete the existing secret and create a new one.
100
81
82
+
The service principal needs the following setup:
83
+
-[Catalog level priveleges](https://docs.databricks.com/en/data-governance/unity-catalog/manage-privileges/privileges.html#general-unity-catalog-privilege-types){:target="_blank"} which include:
84
+
- USE CATALOG
85
+
- USE SCHEMA
86
+
- MODIFY
87
+
- SELECT
88
+
- CREATE SCHEMA
89
+
- CREATE TABLE
90
+
- Databricks [SQL access entitlement](https://docs.databricks.com/en/administration-guide/users-groups/service-principals.html#manage-workspace-entitlements-for-a-service-principal){:target="_blank"} at the workspace level.
91
+
-[CAN USE permissions](https://docs.databricks.com/en/security/auth-authz/access-control/sql-endpoint-acl.html#sql-warehouse-permissions){:target="_blank"} on the SQL warehouse that will be used for the sync.
101
92
102
93
103
94
Once you've configured your warehouse, test the connection and click **Next**.
0 commit comments