Unity Catalog

The Unity Catalog provider in Sail allows you to connect to an external catalog that exposes the Unity Catalog API.

Options

Unity Catalog can be configured using the following options.

• type (required): The catalog provider. Set this option to unity.
• name (required): The catalog name.
• uri (optional): The base URI of the Unity Catalog API. The default is http://localhost:8080/api/2.1/unity-catalog.
• default_catalog (optional): The default catalog name. The default is unity.
• token (optional): The authentication token for the Unity Catalog API. The default is an empty value, which disables authentication. See Unity Catalog Authentication and Authorization for more information.

See Common Options for caching configuration.

Environment Variables

WARNING

The environment variables only allow configuring one Unity Catalog provider instance per session. We may stop supporting these environment variables in future versions of Sail when we support the options in the catalog provider list.

Sail automatically loads Unity Catalog configuration from environment variables with the following prefixes:

• DATABRICKS_*: Databricks-specific configuration.
• UNITY_*: Unity Catalog configuration.
• UC_*: Short-form Unity Catalog configuration.

The following table lists the supported configuration keys and their corresponding environment variable names:

• DATABRICKS_HOST, DATABRICKS_WORKSPACE_URL, UNITY_HOST, UNITY_WORKSPACE_URL, UC_HOST, UC_WORKSPACE_URL

  The host URI.

• DATABRICKS_TOKEN, DATABRICKS_ACCESS_TOKEN, UNITY_ACCESS_TOKEN, UC_ACCESS_TOKEN

  The access token.

• DATABRICKS_CLIENT_ID, UNITY_CLIENT_ID, UC_CLIENT_ID

  The client ID.

• DATABRICKS_CLIENT_SECRET, UNITY_CLIENT_SECRET, UC_CLIENT_SECRET

  The client secret.

• DATABRICKS_AUTHORITY_ID, UNITY_AUTHORITY_ID, UC_AUTHORITY_ID

  The authority ID.

• DATABRICKS_AUTHORITY_HOST, UNITY_AUTHORITY_HOST, UC_AUTHORITY_HOST

  The authority host.

• DATABRICKS_MSI_ENDPOINT, UNITY_MSI_ENDPOINT, UC_MSI_ENDPOINT

  The MSI endpoint.

• DATABRICKS_MSI_RESOURCE_ID, UNITY_MSI_RESOURCE_ID, UC_MSI_RESOURCE_ID

  The MSI resource ID.

• DATABRICKS_OBJECT_ID, UNITY_OBJECT_ID, UC_OBJECT_ID

  The object ID.

• DATABRICKS_FEDERATED_TOKEN_FILE, UNITY_FEDERATED_TOKEN_FILE, UC_FEDERATED_TOKEN_FILE

  The federated token file.

• DATABRICKS_USE_AZURE_CLI, UNITY_USE_AZURE_CLI, UC_USE_AZURE_CLI

  Whether to use Azure CLI to fetch token.

• DATABRICKS_ALLOW_HTTP_URL, UNITY_ALLOW_HTTP_URL, UC_ALLOW_HTTP_URL

  Whether to allow HTTP URL.

Example

export UNITY_ALLOW_HTTP_URL='false'
export SAIL_CATALOG__LIST='[{type="unity", name="sail", uri="https://catalog.example.com", default_catalog="meow", token="..."}]'