|
| 1 | +--- |
| 2 | +title: Databricks Reverse ETL Setup |
| 3 | +--- |
| 4 | + |
| 5 | +> info "" |
| 6 | +> The Databricks Reverse ETL source is in beta and Segment is actively working on this feature. Segment's [First-Access and Beta terms](https://segment.com/legal/first-access-beta-preview/) govern this feature. |
| 7 | +
|
| 8 | +Set up Databricks as your Reverse ETL source. |
| 9 | + |
| 10 | +At a high level, when you set up Databricks for Reverse ETL, the configured user needs read permissions for any resources (databases, schemas, tables) the query needs to access. Segment keeps track of changes to your query results with a managed schema (`__SEGMENT_REVERSE_ETL`), which requires the configured user to allow write permissions for that schema. |
| 11 | + |
| 12 | +## Required permissions |
| 13 | +* Make sure the user or the service principal you use to connect to Segment has permissions to use that warehouse. In the Databricks console go to **SQL warehouses** and select the warehouse you're using. Navigate to **Overview > Permissions** and make sure the user or the service principal you use to connect to Segment has *can use* permissions. |
| 14 | + |
| 15 | +* To grant access to read data from the tables used in the model query, run: |
| 16 | + |
| 17 | + ``` |
| 18 | + GRANT USAGE ON SCHEMA <schema_name> TO `<user or service principal you are using to connect to Segment>`; |
| 19 | + GRANT SELECT, READ_METADATA ON SCHEMA <schema_name> TO `<user or service principal you are using to connect to Segment>`; |
| 20 | + ``` |
| 21 | +
|
| 22 | +* To grant Segment access to create a schema to keep track of the running syncs, run: |
| 23 | +
|
| 24 | + ``` |
| 25 | + GRANT CREATE on catalog <name of the catalog, usually hive_metastore or main if using unity-catalog> TO `<user or service principal you are using to connect to Segment>`; |
| 26 | + ``` |
| 27 | +
|
| 28 | +* If you want to create the schema yourself instead and then give Segment access to it, run: |
| 29 | +
|
| 30 | + ``` |
| 31 | + CREATE SCHEMA IF NOT EXISTS __segment_reverse_etl; |
| 32 | + GRANT ALL PRIVILEGES ON SCHEMA __segment_reverse_etl TO `<user or service principal you are using to connect to Segment>`; |
| 33 | + ``` |
| 34 | +
|
| 35 | +## Set up guide |
| 36 | +
|
| 37 | +To set up Databricks as your Reverse ETL source: |
| 38 | +
|
| 39 | +1. Log in to your Databricks account. |
| 40 | +2. Navigate to **Workspaces** and select the workspace you want to use. |
| 41 | +3. Select **SQL** in the main navigation. |
| 42 | +4. Select **SQL Warehouses** and select the warehouse you want to use. |
| 43 | +5. Go to the **Connection details** tab. |
| 44 | +6. In a new tab on your browser, go to the Segment app. |
| 45 | +7. Navigate to **Connections > Sources > Reverse ETL**. |
| 46 | +8. Click **+ Add Reverse ETL source**. |
| 47 | +9. Select **Databricks** and click **Add Source**. |
| 48 | +10. Enter the configuration settings for your Databricks source. |
| 49 | + * Copy the Hostname, Http Path, and Port from the Databricks console from step 5. |
| 50 | + * To generate a **Token**, follow the steps listed in the [Databricks docs](https://docs.databricks.com/dev-tools/auth.html#pat){:target="_blank"}. Segment recommends you create a token with no expiration date by leaving the lifetime field empty when creating it. If you already have a token with an expiration date, be sure to keep track of the date and renew it on time. |
| 51 | +11. Click **Test Connection** to see if the connection works. If the connection fails, make sure you have the right permissions and credentials, then try again. |
| 52 | +12. Click **Create Source** if the test connection is successful. |
| 53 | +
|
| 54 | +Once you've added your Databricks source, [add a model](/docs/connections/reverse-etl/#step-2-add-a-model) and follow the rest of the steps in the Reverse ETL setup guide. |
0 commit comments