You need to know the Databricks server and database name to create a connection. You must also have access credentials. Once you have created a connection to your Databricks database, you can select data from the available tables and load that data into your app.
In Qlik Sense and Qlik Cloud Analytics Services, you connect to a Databricks database through the Data manager or the Data load editor.
Setting up the database properties
Qlik Cloud Analytics Services database properties
| Database property | Description | Required |
|---|---|---|
| Direct Gateway |
This field will only appear if you selected the "via Direct Access gateway" data connection. Select the data gateway through which you need to connect to your data source. Information noteUsers that need to leverage gateway-enabled data connections must have the Can Consume Data permission for the space in which the gateway resides.
|
Yes |
| Host name | The IP address or host name of the Databricks server. | Yes |
| Port | Server port for the Databricks database. | Yes |
| Catalog |
If your Databricks host supports Unity Catalog, specify the catalog name. Otherwise, leave this field empty. Information noteThe catalog name is case sensitive.
|
Only if your Databricks host supports Unity Catalog. |
| Database | The name of the Databricks database. If you specified a catalog, you must specify a database in that catalog. | Yes |
| HTTP Path | Databricks compute resources URL. | Yes |
Authenticating the driver
Databricks connectors have the following authentication options:
-
User name
-
User name and password
-
No authentication
-
Azure OAuth
Information noteWhen using Direct Access gateway, Azure OAuth authentication require Direct Access gateway 1.6.6 or later.
Databricks authentication properties
These properties apply to authentication with:
-
User name
-
User name and password
-
No authentication
| Property | Description |
|---|---|
| Mechanism | If the Databricks Server Type is Shark Server, you must select No Authentication. If the Databricks Server Type is Databricks Thrift Server, most configurations require User Name authentication. Selecting User Name or User Name And Password gives you the option to set up Account properties. |
| User Name | User name for the Databricks connection. |
| Password | Password for the Databricks connection. |
| Name |
Name of the Databricks connection. The default name will be used if you do not enter a name. |
Azure OAuth authentication properties
You can authenticate using OAuth 2.0, if you are using Databricks on Azure. The support for OAuth also allows single sign-on (SSO) to Databricks with Qlik Sense SaaS when using an identity provider.
Authentication data can be stored in different places:
-
Username and password: The default setting. Authentication information is stored in Qlik Sense.
-
OAuth: User information will not be stored in Qlik Sense.
You need an authentication pin to authenticate via OAuth:
Do the following:
-
Under Authentication, select Azure OAuth. New form fields appear.
-
Fill in all fields. Click the Authenticate button in the Credentials section under Account properties. A new window opens.
-
Copy the Authentication code. Go back to the connection creation dialog.
-
Under Complete authentication with the PIN provided by the source, paste the authentication pin. Click Verify.
| Authentication property | Description | Required |
|---|---|---|
| Mechanism |
Select Azure OAuth. Information noteWhen using Direct Access gateway, Azure OAuth authentication require Direct Access gateway 1.6.6 or later.
|
Yes |
| Tenant ID | The Azure AD tenant to use for authentication. It is also referred to as the directory ID. | Yes |
| Client ID | The client ID when configuring the Azure AD OAuth authorization server. | Yes |
| Client Secret | The client secret when configuring the Azure AD OAuth authorization server. This needs to be inputted every time the connection needs to be re-authenticated. | Yes |
Databricks configuration for OAuth
Your Databricks database must be configured to use OAuth.
Do the following:
-
Have a Databricks service hosted in Azure.
-
Register OAuth app in Azure. For more information, see Configure an OpenID Connect OAuth application from Azure AD app gallery.
-
Assign the following API to the OAuth app you created: https://azuredatabricks.net//user_impersonation.
Account properties
Credentials
Credentials are used to prove that a user is allowed to access the data in a connection.
There are two types of credentials that can be used when making a connection in Qlik Sense SaaS. If you leave the User defined credentials check box deselected, then only one set of credentials will be used for the connection. These credentials belong to the connection and will be used by anyone who can access it. For example, if the connection is in a shared space, every user in the space will be able to use these credentials. This one-to-one mapping is the default setting.
If you select User defined credentials, then every user who wants to access this connection will need to input their own credentials before selecting tables or loading data. These credentials belong to a user, not a connection. User defined credentials can be saved and used in multiple connections of the same connector type.
In the Data load editor, you can click the 
underneath the connection to edit your credentials. In spaces or Data manager, you can edit credentials by right-clicking on the connection and selecting Edit Credentials.
See which authentication type applies on each connector's page.
| Account property | Description |
|---|---|
| User defined credentials | Select this check box if you want users that access this connection to have to input their own credentials. Deselect this check box if credentials can be shared with anyone who has access to this connection. |
| New credentials | Drop-down menu item that appears if User defined credentials is selected. |
| Existing credentials | Drop-down menu item that appears if User defined credentials is selected. |
| User | User name for the connection. |
| Password | Password for the connection. |
| Credentials name | Name given to a set of user defined credentials. |
Setting SSL options
| Property | Description | Required |
|---|---|---|
| Enable SSL | Require SSL authentication on the connection the Databricks server. | No |
| Use System Trust Store | Use the SSL certificate located in the standard system location used for storing trusted certificates. | Yes, if certificate is stored in the standard system location. Only available when SSL is enabled. |
| Trusted Certificate | The full path to the SSL certificate if it is not stored in the standard system location. | Yes, if certificate is not stored in the standard system location. Only available when SSL is enabled. |
| Allow Self-signed Server Certificate | Accept an SSL certificate from the server that is self-signed and not verified by a trusted authority. | No. Only available when SSL is enabled. |
| Allow Common Name Host Name Mismatch | Allow a mismatch between the SSL certificate's common name and the name provided in Host name field. | No |
Miscellaneous properties
| Property | Description |
|---|---|
| Query timeout | Amount of time before a data load query times out. Can be set from 30 seconds to 65535 seconds. Default is 30 seconds. |
Load optimization settings
| Property | Description | Required |
|---|---|---|
| Max String Length |
Maximum length of string fields. This can be set from 256 to 16384 characters. The default value is 4096. Setting this value close to the maximum length may improve load times, as it limits the need to allocate unnecessary resources. If a string is longer than the set value, it will be truncated, and the exceeding characters will not be loaded. |
No |
Advanced options
| Option | Description | Required |
|---|---|---|
|
Name |
Name of the property. You can add additional properties by clicking the |
No |
| Value |
Value of the property. |
No |
| Thrift | Can be set to Binary, SASL, or HTTP. Default = SASL | Yes |
.