Databricks for Profiles Sync
With Databricks for Profiles Sync, you can use Profiles Sync to sync Segment profiles into your Databricks Lakehouse.
Before getting started with Databricks Profiles Sync, note the following prerequisites for setup.
- The target Databricks workspace must be Unity Catalog enabled. Segment doesn't support the Hive metastore. Visit the Databricks guide enabling the Unity Catalog for more information.
- Segment creates managed tables in the Unity catalog.
- Segment supports only OAuth (M2M) for authentication.
A SQL warehouse is required for compute. Segment recommends a warehouse with the the following characteristics:
- Size: small
- Type: Serverless otherwise Pro
- Clusters: Minimum of 2 - Maximum of 6
Success!
To improve the query performance of the Delta Lake, Segment recommends creating compact jobs per table using OPTIMIZE following Databricks recommendations.
Info
Segment recommends manually starting your SQL warehouse before setting up your Databricks destination. 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.
- From your Segment app, navigate to Unify > Profiles Sync.
- Click Add Warehouse.
- Select Databricks as your warehouse type.
- Use the following steps to connect your warehouse.
Use the five steps below to connect to your Databricks warehouse.
Warning
To configure your warehouse, you'll need read and write permissions.
Pick a name to help you identify this space in the warehouse, or use the default name provided. You can't change this name once the warehouse is connected.
You'll use the Databricks workspace URL, along with Segment, to access your workspace API.
Check your browser's address bar when inside the workspace. The workspace URL should resemble: https://<workspace-deployment-name>.cloud.databricks.com. Remove any characters after this portion and note the URL for later use.
This catalog is the target catalog where Segment lands your schemas and tables.
- Follow the Databricks guide for creating a catalog. Be sure to select the storage location created earlier. You can use any valid catalog name (for example, "Segment"). Note this name for later use.
- Select the catalog you've just created.
- Select the Permissions tab, then click Grant.
- Select the Segment service principal from the dropdown, and check
ALL PRIVILEGES. - Click Grant.
Next, add SQL warehouse details about your compute resource.
- HTTP Path: The connection details for your SQL warehouse.
- Port: The port number of your SQL warehouse.
Segment uses the service principal to access your Databricks workspace and associated APIs.
Service principal client ID: Follow the Databricks guide for adding a service principal to your account. This name can be anything, but Segment recommends something that identifies the purpose (for example, "Segment Profiles Sync"). Segment doesn't require Account admin or Marketplace admin roles.
The service principal needs the following setup:
- Catalog-level privileges which include:
- USE CATALOG
- USE SCHEMA
- MODIFY
- SELECT
- CREATE SCHEMA
- CREATE TABLE
- Databricks SQL access entitlement at the workspace level.
- CAN USE permissions on the SQL warehouse that will be used for the sync.
Client secret: Follow the Databricks instructions to generate an OAuth secret.
Once you've configured your warehouse, test the connection and click Next.
With selective sync, you can choose exactly which tables you want synced to the Databricks warehouse. Segment syncs materialized view tables as well by default.
Select tables to sync, then click Next. Segment creates the warehouse and connects databricks to your Profiles Sync space.
You can view sync status, and the tables you're syncing from the Profiles Sync overview page.
Learn more about using selective sync with Profiles Sync.