Documentation Index

Fetch the complete documentation index at: https://kb.pigment.com/llms.txt

Use this file to discover all available pages before exploring further.

Connect Pigment with Databricks

Prev Next

This article explains how to connect Databricks data with Pigment using the OpenSharing Databricks-to-Open protocol.

As with all native Pigment integrations, you must first configure a connection on the Integration Library page. Once configured, the connection can then be used by any Application authorized as a data source.

Overview

This native integration with Databricks uses the OpenSharing Databricks-to-Open protocol (formerly known as Delta Sharing) across Azure(opens in new tab), Amazon Web Services (AWS)(opens in new tab) and Google Cloud Platform (GCP)(opens in new tab). OpenSharing is an open protocol developed by Databricks for secure data sharing between organizations, regardless of the computing platforms they use.

To set up the integration, first create and configure a share in Databricks and grant Pigment's recipient access to that share. This enables Pigment to access the shared data through the OpenSharing Databricks-to-Open protocol.

Next, configure a connection in the Pigment Integrations panel and select the Applications that can use this connection.

⚠️ Important

Pigment uses the OpenSharing Databricks-to-Open protocol. Some features available with Databricks-to-Databricks sharing may not be supported. In particular, tables that use Databricks default storage (Databricks-managed storage) may not be supported for Databricks-to-Open sharing and can result in unsupported table type errors.

If you encounter these errors, verify that the shared tables are not using Databricks default storage. Consider sharing data from customer-managed cloud storage instead, or use Databricks-to-Databricks sharing when applicable.

Prerequisites

Before configuring the Databricks OpenSharing integration, ensure the following requirements are met:

  • A Databricks workspace with Unity Catalog enabled. The Databricks workspace used to create and manage shares must be attached to a Unity Catalog metastore.

  • An OpenSharing share configured in Databricks. Create a share containing the tables, views, or other supported data assets that you want to make available in Pigment.

  • A recipient configured for Pigment. Create an Open recipient in Databricks and generate the OpenSharing profile that Pigment will use to access the shared data.

  • Permissions to create shares and grant recipient access. You must have the required Databricks permissions to create and manage shares, create or manage recipients and grant recipients access to shares. Contact your Databricks administrator if you do not have the necessary permissions.

Step 1: Set up the Databricks share and recipient

Prepare a Databricks share containing the data you want to make available through OpenSharing.

  1. If a share is not yet available, follow these steps to create a new share in Databricks. Select all the data objects you need to make available for Pigment in the Add data assets step.

  2. When the share is ready, create or select the recipient that Pigment will use and grant that recipient access to the share. In the Add recipient panel in Databricks, select Open as the recipient type and Token as the authentication method.

  3. Copy the generated activation link and use it to download the OpenSharing credential file.

  4. Select the recipient you created and grant them access to the share you have configured.

ℹ️ Note

To enhance security, Databricks supports restricting token usage to defined IP ranges. Specify the following IP addresses in the IP access section of the recipient configured for Pigment.

  • 35.242.251.111

  • 34.145.54.113

  • 34.163.209.119

  • 35.202.142.12

Step 2: Set up the Connector in Pigment

⚠️ Important

You must be a Pigment Workspace Admin to configure the connector.

When you have your Databricks credentials set up, you can set up the connector in Pigment.

To do this:

  1. In your Workspace, go to Integrations.

  2. Select + Add on the Databricks OpenSharing integration and fill in the connection details, including the Name, Application access and OpenSharing profile.

  • Name. Enter the name of your connection.

  • Application access. Select the Applications to allow using this connection.

  • OpenSharing profile. Copy and paste the contents of the OpenSharing profile JSON file downloaded in the previous step.

ℹ️ Note

If the token expires or needs to be rotated, edit the connection and replace the expired OpenSharing profile. For more information, see Edit Pigment Integrations.

Step 3: Load Databricks data into Pigment

After the Databricks OpenSharing connection is configured, access an Application linked to this connection and open the Import Data panel for the relevant object.

For example, if you are importing data into a Transaction List, you would open the List and select Import and Download and then Import.

To do this:

  1. Select Import, then select Integration.

  2. Select the Databricks OpenSharing connection you just configured.

ℹ️ Note

If you don’t see the connection, go to Integrations and confirm that the Application is on the Application Access list.

  1. From the drop-down menus, select the share, schema, and table you want to load into Pigment. Pigment will automatically discover these fields based on the recipient and share configuration you’ve set up. If you think a Table is missing, check the share and recipient configuration with your Databricks Admin.

  2. Select Start Import, the selected table will load in Pigment within seconds.

⚠️ Important

The Databricks OpenSharing integration has the following limits:

  • Tables: up to 1 GiB

  • Views: up to 100k rows (any additional rows are truncated or ignored)