Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.omni.co/llms.txt

Use this file to discover all available pages before exploring further.

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:
GRANT USE CATALOG ON CATALOG <catalog> TO `omni_user`; 
GRANT USE SCHEMA ON SCHEMA <catalog>.<schema> TO `omni_user`;
GRANT SELECT ON SCHEMA <catalog>.<schema> TO `omni_user`;
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:
    ​
    HTTP Path
    required
    The HTTP path for the Databricks SQL warehouse.
    ​
    Authentication Type
    required
    Select the authentication type you chose in step 1 and enter the credentials into their corresponding fields.
    ​
    Enable DW Metric View Integration
    When enabled, Omni will sync metrics and metric views defined in your Databricks Unity Catalog into your Omni model.
  4. When finished, click Create connection.

​
What’s next?

Now that your database is set up, you can: