Working with Databricks SQL Warehouse for Azure without Spark

• Prerequisites for creating Azure SQL Warehouse Connection with PAT authentication

• Prerequisites for creating Azure SQL Warehouse Connection with for OAuth Connection

• Working with Databricks SQL warehouse with Personal Token and OAuth

• Connection Details in Kyvos for Sanity Suite

Prerequisites for creating Azure SQL Warehouse Connection with PAT authentication

Before creating an Azure SQL Warehouse connection without Spark, complete the following prerequisites.

1. Unity Catalog must be enabled on your Databricks cluster.

2. In Unity Catalog, create storage credentials and an external location with appropriate access permissions for both the source and destination locations. You must have permission to create storage credentials and external locations.

3. To create storage credentials, first, create an access connector for Azure Databricks. Assign that access connector while creating storage credentials.

4. Grant the managed identity access to the storage account. You must have the Owner or User Access Administrator Azure RBAC role to grant permission to access your storage account.

   1. Log in to your Azure Data Lake Storage Gen2 account.

   2. Go to Access Control (IAM), click + Add, and select Add role assignment.

   3. Select the Storage Blob Data Contributor role and click Next.

   4. Under Assign access, select a Managed identity.

   5. Click +Select Members, and select Access connector for Azure Databricks or User-assigned managed identity.

   6. Search for your connector name or user-assigned identity, select it, and click Review and Assign.

5. Fetch the ABFSS path till the parent directory of your respective storage account.

6. On the Unity Catalog page, go to external locations and create a new external location by providing an external location name, newly created Storage credential, and fetched ABFSS URL. The URL format should be in abfss://my-container-name@my-storage-account.dfs.core.windows.net/<path>

7. Test the newly created external location by clicking the 'Test connection' button. This will validate the connection with the external location path. Through the permissions tab, assign your user the CREATE EXTERNAL TABLE role.

8. Go to semantic model Advanced Properties, and add the following properties:

   1. temp catalog name for create parquet table = kyvos.sqlwarehouse.catalog

   2. temp database name for create parquet table = kyvos.sqlwarehouse.tempdb

9. You must have 'create table and Use schema' permissions on the temp catalog.

Prerequisites for creating Azure SQL Warehouse Connection with for OAuth Connection

To create Databricks SQL Warehouse connection with OAuth, you need to complete the following prerequisites.

1. Create a Service Principal

   1. Go to the user profile, click Settings, then Identity and Access. Under Service Principal [Manage], click Add Service Principal, and note generated Application ID or Client ID; this will be OAuth2ClientId.

   2. Generate a secret for this Service Principal and note it down as it is OAuth2Secret.

2. Grant required permissions for Databricks SQL Warehouse cluster: Add the service principal with the permission "CAN MANAGE".

3. Prepare the JDBC URL:
   Get the JDBC URL from the cluster's JDBC tab. For example, if the JDBC URL is:

Change the URL as follows (change AuthMech=11 and add Auth_Flow=1 to the parameters):

4. Grant Permission to process semantic model using the above connection: To process semantic models using the above connection, grant permission on the external location (create an external location if it does not already exist for the storage account being used in your environment, such as "dev_testing"). For this service principal:

   • Click Catalog.

   • Click the Settings icon.

   • Click the Storage Location Name.

   • Create external table and write files access

5. Assign a role for Databricks SQL Warehouse connection:
   Just as a role is assigned in the case of the Databricks SQL Warehouse connection, you need to add the "Storage Blob Data Contributor" role assignment for the above service principal on the storage account:

   • Go to the Azure portal.

   • Go to the storage account, click Access Control (IAM).

   • Add a role assignment, select Storage Blob Data Contributor.

   • Select Managed Identity, choose the appropriate subscription [Dev-Enterprise or QA Enterprise], select the required managed identity, enter the Databricks connector name and Save.

6. Add the following properties to semantic model Advanced Properties:

   • kyvos.sqlwarehouse.catalog = <catalog name for temporary tables created while cubes building>

   • kyvos.sqlwarehouse.tempdb = <temporary database for temporary tables created while cubes building>

For more detail about Authentication settings for the Databricks JDBC Driver, refer to AWS documentation.

Working with Databricks SQL warehouse with Personal Token and OAuth

• Creating Databricks SQL Warehouse connection with Personal Token

• Creating Databricks SQL Warehouse connection with OAuth

Creating Databricks SQL Warehouse connection with Personal Token

1. From the Toolbox, click Setup, then choose Connections.

2. From the Actions menu ( ⋮ ), click Add Connection.

3. Enter a Name for the connection.

4. From the Category drop-down list, select the Warehouse option.

5. From the Provider list, select the DatabricksSQL option.

6. The Driver Class field is prepopulated.

7. Enter Databricks SQL Warehouse JDBC URL. For more information, see Microsoft documentation.

8. Select OAuth from the Personal Access Token list.

9. Enter Username as token.

10. Enter Databricks SQL Personal Access Token for the Databricks SQL workspace in the Password field.

11. The Use as Source checkbox is disabled as this is a source connection.

12. To use this connection as the default SQL engine, select the Is Default SQL Engine checkbox.

13. Select the Catalog Enabled checkbox. It is mandatory to enabled it for Databricks SQL.

14. Click the Properties link to view or set properties.

15. After configuring the settings, click the Save button. 

16. To refresh connections, click the Actions menu ( ⋮ ) at the top of the Connections column and select Refresh.

Open

Creating Databricks SQL Warehouse connection with OAuth

You can create Databricks SQL Warehouse connection with OAuth machine-to-machine (M2M) authentication type. See Prerequisites for more details.

Creating Databricks SQL Warehouse connection with OAuth

1. From the Toolbox, click Setup, then choose Connections.

2. From the Actions menu ( ⋮ ), click Add Connection.

3. Enter a Name for the connection.

4. From the Category drop-down list, select the Warehouse option.

5. From the Provider list, select the DatabricksSQL option.

6. The Driver Class field is prepopulated.

7. Enter Databricks SQL Warehouse JDBC URL. For more information, see Microsoft documentation.

8. Select OAuth from the Authentication Type list. Upon selecting this option, the Client ID and Client Secret fields are displayed.

9. In the Client ID field, enter the value of the service principal’s Application ID, Client ID, or OAuth2ClientId.

10. In the Client Secret field, enter the value of the secret created for the above service principal or the OAuth2ClientId.

11. The Use as Source checkbox is disabled as this is a source connection.

12. To use this connection as the default SQL engine, select the Is Default SQL Engine checkbox.

13. Select the Catalog Enabled checkbox. It is mandatory to enabled it for Databricks SQL.

14. Click the Properties link to view or set properties.

15. After configuring the settings, click the Save button. 

16. To refresh connections, click the Actions menu ( ⋮ ) at the top of the Connections column and select Refresh.

Open

Connection Details in Kyvos for Sanity Suite

To create Azure SQL Warehouse connection for sanity suite, perform the following steps.