Skip to main content

Databricks

Requirements​

To connect DataChat to your Databricks project, you’ll need:

  • Catalog name
  • Database (schema) name
  • Connection details of your SQL warehouse
  • Hostname
  • Port number (usually 443 for Databricks)
  • HTTP path
  • Access token

Find Your Catalog and Database (Schema) Name​

In your Databricks Workspace, click Catalog in the left sidebar to browse through the available catalogs and databases.

databricks catalog

Find Your Hostname and HTTP Path​

In your Databricks Workspace, click SQL Warehouse in the left sidebar, and select the SQL warehouse to connect to. Under Connection Details you'll find:

  • Hostname: The server hostname in the format <workspace>.cloud.databricks.com
  • HTTP Path: The specific path for your SQL Warehouse in the format /sql/<version>/warehouses/<identifier>

databricks catalog

Generate an Access Token​

In your Databricks Workspace, click your user icon in the top-right, then click Settings > Developer > Access Tokens > Manage > Generate New Token.

databricks catalog

Permissions​

To connect to a Databricks database, your account must have the following permissions:

  • BROWSE. Allows viewing and listing tables in the Database Browser.
  • USE SCHEMA. Grants access to read data from schemas within the assigned scope.
  • SELECT. Enables reading rows from tables within the assigned scope.

Add Your Databricks Database​

To add your Databricks database:

Databricks database

  1. Give the database a display name. This is how you'll reference the database across DataChat.
  2. In the Database field, enter the name of your Databricks database.
  3. In the Catalog field, enter the name of your Databricks catalog.
  4. In the Hostname field, enter the hostname or IP address of the database.
  5. In the Port Number field, enter the port for the database.
  6. In the HTTP Path field, enter the URL needed to connect to the database.
  7. In the Access Token field, enter the access token needed to connect to the database.
  8. Optionally, set the database to be read-only.
  9. Test your database, then click Save.