Databricks

This page describes how to sync data to your Databricks data warehouse.

Databricks is a unified analytics platform that provides a collaborative environment for data engineering, data science, and machine learning. With Census, you can sync data into Databricks from any source we support.

Census supports a wide set of Databricks deployments including

Unity Catalog
SQL Warehouses (including Serverless)
All Databricks LTS versions up to and including 14.3, and new versions typically work without issue.

Getting Started

In this guide, we will show you how to connect Census to Databricks as a destination.

If you are configuring Databricks as a source (to query data from Databricks to sync elsewhere), that process is documented separately here: Databricks as a Source

Permissions

Census will require the following permissions on the tables you wish to sync to: SELECT, MODIFY.

Configuring a new Databricks destination

First, you'll need to select which form of access credentials to use: Service Principal (recommended, but a bit more work) or Personal Access Tokens.
- If you're using a Service Principal, within your Databricks Account Console, go to the User management page and Service Principals tab.
  1. Create a new service principal with the Add service principal button. Give it a name you'll remember such as Census. You can also reuse an existing one.
  2. Once created, click Generate secret which will create a new Client ID and Secret pair. Keep this somewhere safe as you won't be able to access it again.
  3. Now you'll need to add the service principal as an admin on the specific Workspace you are connecting to. In your Databricks Account console, go the Workspaces page. Click on the name of your workspace and go to the Permissions tab.
  4. Select your new service principal and mark them as admin on the workspace.
- If you're using Personal Access Token, you can create this for yourself. Alternatively, may want to create a new specific user account for Census to use for auditing and access control.
  1. You'll first need to navigate into the specific Workspace you are connecting to. In your Databricks Account console, go the Workspaces page. Select the workspace you'd like Census to connect to and then click Open workspace in the top right.
  2. Clicking on your Profile Icon in the top right and selecting Settings. Then click the Developer option in the left settings menu and click on Manage next to Access Tokens. We recommend you create a new Access Token:
    Name: Census (or some other details)
    Lifetime: (clear the box) - This will prevent the token from expiring
If you're not already, go into your target workspace by visiting the Workspaces page and clicking the Open link next to it. Now within your selected Workspace, select Compute from the left menu. Census can connect to a SQL Warehouse or All Purpose Cluster. You can reuse an existing compute resource, or create a new one here. Click on the Compute you've decided to use.

Note: Service Principals cannot be connected to All Purpose Clusters that are in the Single User Access Mode.

You'll need to collect three credentials to connect to your compute:
- Hostname
- Port
- HTTP Path
For SQL Warehouses, switch to the Connection details tab.
For All Purpose Clusters, in the Configuration tab, open the Advanced Options section at the bottom, then select the JDBC/ODBC section.
Now you're ready to add the connection to Census. Visit the Destinations page in Census, and click New Destination, selecting Databricks from the menu.
- Provide the connection credentials: Hostname, Port, HTTP Path
- Select your credential type (Personal Access Token or Service Principal), and provide the corresponding Access Token, or Client ID & Secret.
- Optionally, set the Catalog and Schema Allow lists. This will filter what Catalogs and Schemas appear in Census. Note that if you are using Unity Catalog, this filtering will apply across all catalogs.
Click Connect.

️ Supported Objects and Sync Behaviors

Object Name

Supported?

Sync Keys

Behaviors

Table

✅

Any columns that are integers or strings

Update or Create, Update Only, Add

Learn more about all of our sync behaviors in our Syncs documentation.

Allowed IP Addresses

If you're using Databricks's Allowed IPs network policy, you'll need to add these Census IP addresses to your list. You can find Census's set of IP address for your region in Regions & IP Addresses. Visit the Databricks Documentation for more details on how to specify these IPs as part of your network policy.

Need help connecting to Databricks?

You can send our support team an email at support@getcensus.com or start a conversation from the in-app chat.

PreviousCustomer.io NextDelighted

Last updated 1 month ago

Getting Started

In this guide, we will show you how to connect Census to Databricks as a destination.

If you are configuring Databricks as a source (to query data from Databricks to sync elsewhere), that process is documented separately here: Databricks as a Source

Permissions

Census will require the following permissions on the tables you wish to sync to: SELECT, MODIFY.

Configuring a new Databricks destination

First, you'll need to select which form of access credentials to use: Service Principal (recommended, but a bit more work) or Personal Access Tokens.

If you're using a Service Principal, within your Databricks Account Console, go to the User management page and Service Principals tab.
1. Create a new service principal with the Add service principal button. Give it a name you'll remember such as Census. You can also reuse an existing one.
2. Once created, click Generate secret which will create a new Client ID and Secret pair. Keep this somewhere safe as you won't be able to access it again.
3. Now you'll need to add the service principal as an admin on the specific Workspace you are connecting to. In your Databricks Account console, go the Workspaces page. Click on the name of your workspace and go to the Permissions tab.
4. Select your new service principal and mark them as admin on the workspace.
If you're using Personal Access Token, you can create this for yourself. Alternatively, may want to create a new specific user account for Census to use for auditing and access control.
1. You'll first need to navigate into the specific Workspace you are connecting to. In your Databricks Account console, go the Workspaces page. Select the workspace you'd like Census to connect to and then click Open workspace in the top right.
2. Clicking on your Profile Icon in the top right and selecting Settings. Then click the Developer option in the left settings menu and click on Manage next to Access Tokens. We recommend you create a new Access Token:
  - Name: Census (or some other details)
  - Lifetime: (clear the box) - This will prevent the token from expiring

If you're not already, go into your target workspace by visiting the Workspaces page and clicking the Open link next to it. Now within your selected Workspace, select Compute from the left menu. Census can connect to a SQL Warehouse or All Purpose Cluster. You can reuse an existing compute resource, or create a new one here. Click on the Compute you've decided to use.

Note: Service Principals cannot be connected to All Purpose Clusters that are in the Single User Access Mode.

You'll need to collect three credentials to connect to your compute:

Hostname
Port
HTTP Path

For SQL Warehouses, switch to the Connection details tab.

For All Purpose Clusters, in the Configuration tab, open the Advanced Options section at the bottom, then select the JDBC/ODBC section.

Now you're ready to add the connection to Census. Visit the Destinations page in Census, and click New Destination, selecting Databricks from the menu.

Provide the connection credentials: Hostname, Port, HTTP Path
Select your credential type (Personal Access Token or Service Principal), and provide the corresponding Access Token, or Client ID & Secret.
Optionally, set the Catalog and Schema Allow lists. This will filter what Catalogs and Schemas appear in Census. Note that if you are using Unity Catalog, this filtering will apply across all catalogs.

Click Connect.

Allowed IP Addresses