Configure Data Sharing with Databricks using APIs

Learn how to create and configure a Data Share adapter for Databricks using REST APIs.

Prerequisites:

Valid tenant ID and environment
Authentication token with the ROLE_DATA_PIPELINE_ADMIN role
Valid Databricks delta sharing identifier
An active subscription for Data Sharing with Databricks

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 Data Sharing with Databricks, you must refer to Best practices for setting up Reltio Data Sharing with Databricks.

Use the Reltio REST APIs to configure a Databricks Delta Share.

Create a new Databricks adapter

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",
  "isOvOnly": true,
  "databricksConfig": {
    "identifier": "identifier1"
  }
}

The createdOn timestamp is auto-generated. The field isOvOnly determines whether only operational values (OV) are shared. If set to true, the schema is also simplified to a flat format.

Field reference:


Parameter	Type	Description
`type`	String	Adapter type: must be `datashare-databricks`
`name`	String	Adapter name (alphanumeric, 3–20 characters, no spaces)
`enabled`	Boolean	Enable or disable the adapter
`createdBy`	String	Username of adapter creator
`createdOn`	String	Adapter creation time in UTC format
`isOv`	Boolean	Whether to share only operational values and use simplified schema
`databricksConfig`	Object	Databricks specific config
`databricksConfig.identifier`	String	Identifier for the Databricks delta share

Set up the data share

Provision the cloud resources and enable the share using the adapter name:


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

Your data share adapter is now set up and ready for Databricks users to access the shared Delta Lake tables through their Databricks Unity Catalog under Delta 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 Data Sharing with Databricks using APIs

Footer