Configure Reltio data sharing with Databricks - essentials using APIs

Learn how to create and configure a data share for Databricks using REST APIs.

Using the REST APIs, create and configure a data share to make data from your Reltio tenant available in Databricks. Once the data share is set up and the data is available, Databricks users can access and query the shared Reltio tables through Unity Catalog.

Prerequisites

Valid tenant ID and environment
Authentication token with the ROLE_DATA_PIPELINE_ADMIN role
Valid Databricks Open Sharing identifier
An active subscription for Reltio data sharing with Databricks - essentials

Note: While creating a new data share, ensure you provide a unique name for the data share that does not match any existing or deleted data shares.

When configuring Reltio data sharing with Databricks - essentials, you must refer to Best practices for setting up Reltio data sharing with Databricks - essentials.

To configure a Databricks data share using APIs

Create a new Databricks data share

Send a POST request to the DPH service to define a new Databricks data share:

POST {dphUrl}/api/tenants/{tenantID}/adapters

Example request body:

{
  "type": "datashare-databricks",
  "name": "datashare",
  "enabled": true,
  "createdBy": "user@example.com",
  "createdOn": "2025-06-09T10:05:07.864379Z",
  "databricksConfig": {
  "identifier": "identifier1"
  }
}

The createdOn timestamp is auto-generated.

Field reference:


Parameter	Type	Description
`type`	String	Data share type: must be `datashare-databricks`
`name`	String	Data share name (alphanumeric, 3–20 characters, no spaces)
`enabled`	Boolean	Enable or disable the data share
`createdBy`	String	Username of data share creator
`createdOn`	String	Data share creation time in UTC format
`databricksConfig`	Object	Databricks specific config
`databricksConfig.identifier`	String	Identifier for the Databricks Open Sharing

Set up the data share

Set up the data share and enable the share using the data share name:


POST {dphUrl}/api/tenants/{tenantID}/adapters/{adapterName}/actions/setup-databricks-datashare

Result

Your data share is now set up and ready for Databricks users to access the shared streaming tables through their Databricks Unity Catalog under Open Sharing.

Ensure that the Databricks recipient has the necessary metastore permissions to accept the data share. Grant the USE SHARE, USE PROVIDER, USE RECIPIENT, and CREATE CATALOG permissions to the recipient using the following commands:

GRANT USE SHARE ON METASTORE TO `<user-email-address>`;
GRANT USE PROVIDER ON METASTORE TO `<user-email-address>`;
GRANT USE RECIPIENT ON METASTORE TO `<user-email-address>`;
GRANT CREATE CATALOG ON METASTORE TO `<user-email-address>`;

Unify and manage your data

Configure Reltio data sharing with Databricks - essentials using APIs

Footer