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.
- To use a - Follow the Databricks Access Token for a service principal guide. When you create the connection in Omni, you’ll select the Personal Access Token as the Authentication type.
- To use an - Follow the Databricks Authenticate as a service principal guide. When you create the connection in Omni, you’ll select the OAuth M2M Authentication as the Authentication type.
2
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.
3
Create the connection in Omni
- In Omni, click Settings > Connections.
- Click the Databricks option.
-
On the connection setup page, fill in the connection details:
Name Required? Description Display Name Yes A user-friendly name for the connection, which will be used throughout Omni Host Yes The hostname or IP address of the database server HTTP Path Yes The HTTP path for the Databricks SQL warehouse Default Catalog Yes The default catalog to use for queries Include Other Catalogs No A comma-separated list of other catalogs to include Include Schemas No A comma-separated list of schemas to include in the connection Offloaded Schemas No A comma-separated list of schemas to include in the connection, which will only load on demand. This setting is good for very large schemas or dbt dev schemas. Schema for Table Uploads No The name of the schema to use for table (CSV) uploads. If left blank, you can upload tables but they won’t be pushed to the database or be available for use in joins. Default Schema No The default schema to use for queries Authentication Type Yes Select the authentication type you chose in step 1 and enter the credentials into their corresponding fields Database Timezone Yes The timezone used by the database Query Timezone Yes The timezone to use for Omni queries. If a timezone is specified, data will be converted from the Database timezone to the selected timezone. Allow User-Specific Timezones No Allow users to override the connection timezone with their own when querying Query Timeout No The maximum time in seconds before a query times out - When finished, click Create connection.
What’s next?
Now that your Databricks is set up, you can:- Configure user permissions, schema refreshes, environments and timezone settings
- Learn how Omni generates the model associated with the connection