Skip to main content
If your Databricks workspace is in a private network and requires PrivateLink access, refer to the Databricks PrivateLink guide instead.

​
Requirements

To follow the steps in this guide, you’ll need Organization Admin permissions in Omni.

​
Setup

1

Generate credentials

Omni can use either personal access token (PAT) or OAuth machine-to-machine (M2M) credentials to authenticate to Databricks.
2

Grant permissions to the service principal

The Databricks service principal or user must have the following privileges on each catalog and schema Omni will access:
Repeat the schema-level grants for each schema you want Omni to query. The SELECT ON SCHEMA grant covers all current and future tables and views within that schema.
3

Retrieve database connection details

Next, you’ll need to retrieve your database’s connection details from Databricks. Follow the steps in this Databricks guide, specifically the getting connection details for a Databricks SQL warehouse section.
4

Create the connection in Omni

  1. In Omni, click Settings > Connections.
  2. Click the Databricks option.
  3. On the connection setup page, fill in the connection details:
    ​
    required
    A user-friendly name for the connection, which will be used throughout Omni.
    ​
    required
    The address of the database server.
    ​
    required
    The HTTP path for the Databricks SQL warehouse.
    ​
    required
    Select the authentication type you chose in step 1 and enter the credentials into their corresponding fields.
    ​
    required
    The timezone used by the database.
    ​
    required
    The timezone to use for Omni queries. If a timezone is specified, data will be converted from the Database Timezone to the selected timezone.
    ​
    When enabled, users can override the connection timezone with their own when querying.
    ​
    default:"900"
    Maximum time in seconds before a query times out.
    ​
    When enabled, Omni will sync metrics and metric views defined in your Databricks Unity Catalog into your Omni model.
    ​
    default:"enabled"
    When enabled, Omni will prefix generated view names with schema and catalog, e.g. my_catalog_public__orders instead of orders. Defaults to enabled. See View name generation for more information.
    ​
    required
    Select the minimum level of access users should have to models in the connection.
  4. When finished, click Create connection.

​
What’s next?

Now that your database is set up, you can: