This page explains how to connect MIStudio to a Databricks SQL Warehouse using JDBC.

The connection can be used in the MIStudio Logic Editor to read data from Databricks, execute SQL statements, write database data, and send database results to other application components.

A typical MIStudio-to-Databricks connection requires:

• A Databricks workspace
• A Databricks SQL Warehouse
• Permission to use the SQL Warehouse
• The warehouse Server Hostname
• The warehouse HTTP Path
• The Databricks JDBC driver
• A Databricks authentication method
• A DatabricksConnectionManager in MIStudio

After the connection is configured, database components such as DatabaseRawLookup and DatabaseRawWrite can execute SQL against Databricks.

Sign in to your Databricks workspace.

Open the SQL Warehouse that MIStudio should use.

In Databricks:

• Open SQL Warehouses.
• Select the SQL Warehouse.
• Open Connection Details.
• Locate the Server Hostname.
• Locate the Port.
• Locate the HTTP Path.

Keep these values available while configuring MIStudio.

Typical connection information includes:

Download the Databricks JDBC Driver from Maven Central:

Databricks JDBC Driver on Maven Central

Databricks publishes the JDBC driver under:

com.databricks:databricks-jdbc

Select the desired driver version and download the JAR file.

The downloaded file follows this naming pattern:

databricks-jdbc-<version>.jar

For example:

databricks-jdbc-3.4.2.jar

The JDBC driver class used by MIStudio is:

com.databricks.client.jdbc.Driver

The Databricks JDBC driver can be added directly to the MIStudio project.

In the MIStudio project tree:

• Select Drivers.
• Click Add File.
• Browse to the Databricks JDBC JAR downloaded in the previous step.
• Select the JAR and add it to the project.
• Confirm that the driver file appears under Drivers.
• Save the project.
• Close and restart MIStudio.

The driver file follows this naming pattern:

databricks-jdbc-<version>.jar

Databricks supports multiple JDBC authentication methods.

For a simple connection test, a Databricks Personal Access Token (PAT) can be used.

For PAT authentication:

A Personal Access Token can be useful for testing and development. Production environments may require a different authentication method based on your organization's Databricks security requirements.

Open the MIStudio project and application that will use Databricks.

Open the MIStudio Logic Editor and add a:

DatabricksConnectionManager

Configure the connection manager using the connection information from your Databricks SQL Warehouse.

Enter the appropriate values for:

• Server Hostname
• Port
• HTTP Path
• User Name
• Password
• Driver Class
• Connection Properties
• Catalog or Schema, if required by the application

For the JDBC Driver Class, use:

com.databricks.client.jdbc.Driver

The Server Hostname should be entered without the protocol.

For example, enter:

YOUR-SERVER-HOSTNAME

Do not enter:

https://YOUR-SERVER-HOSTNAME

Copy the HTTP Path from the Databricks SQL Warehouse Connection Details.

The HTTP Path should include the leading slash, for example:

/sql/1.0/warehouses/YOUR-WAREHOUSE-ID

For PAT-based authentication, enter the following connection properties.

Enter each property on its own line:

AuthMech=3
transportMode=http
ssl=1

The MIStudio User Name field should contain:

token

The Password field should contain the Databricks Personal Access Token.

MIStudio must be running the application logic for database components to execute.

Before testing the Databricks connection:

• Confirm that DatabricksConnectionManager is configured.
• Add a DatabaseRawLookup component to the Logic Editor.
• Configure the DatabaseRawLookup to use the Databricks connection manager.
• Put MIStudio into Simulating mode.

The connection manager reference will normally point to the DatabricksConnectionManager in the application.

For example:

/Main/DatabricksConnectionManager

Start with a simple query before attempting a larger database operation.

In DatabaseRawLookup, enter:

SELECT 1

Trigger the DatabaseRawLookup while MIStudio is in Simulating mode.

If the connection is successful, the query should return:

1

You can also check the Databricks SQL Warehouse Query History to confirm that the query was received and executed.

After confirming the connection, determine which Databricks catalog and schema MIStudio is using.

Use DatabaseRawLookup with:

SELECT current_catalog()

Then check the schema:

SELECT current_schema()

These values identify the current location used by unqualified SQL queries.

Databricks objects can also be referenced using fully qualified names:

catalog.schema.table

For example:

my_catalog.my_schema.my_table

Using fully qualified table names can help prevent queries from running against the wrong catalog or schema.

Use DatabaseRawLookup for SQL statements that return data.

Common examples include:

• `SELECT`
• Metadata queries
• Catalog or schema checks
• Table checks
• Queries whose results will be sent to other Logic Editor components

Example:

SELECT *
FROM my_catalog.my_schema.my_table

Use DatabaseRawWrite for SQL statements that create or modify database content.

Common examples include:

• `CREATE TABLE`
• `INSERT`
• `UPDATE`
• `DELETE`

For example:

CREATE TABLE IF NOT EXISTS my_catalog.my_schema.mistudio_test (
    id INT,
    message STRING,
    created_at TIMESTAMP
)

After creating a test table, insert a value using DatabaseRawWrite.

For example:

INSERT INTO my_catalog.my_schema.mistudio_test
    (id, message, created_at)
VALUES
    (1, 'Hello from MIStudio', CURRENT_TIMESTAMP())

Then use DatabaseRawLookup to read the value back:

SELECT message
FROM my_catalog.my_schema.mistudio_test
WHERE id = 1

A successful readback confirms that MIStudio can:

• Connect to the Databricks SQL Warehouse
• Execute SQL
• Write database data
• Read database data

Use the MIStudio database component that matches the SQL operation.

Databricks SQL Warehouse Query History can be useful when testing the connection.

Query History can help confirm that:

• MIStudio reached Databricks
• The SQL statement was received
• The query executed
• An error occurred on the Databricks side

If a query appears to execute in MIStudio but the expected result is not visible, check Databricks Query History as part of troubleshooting.

Confirm that MIStudio is in Simulating mode.

Also confirm that the database component is configured to use the intended DatabricksConnectionManager.

Confirm that:

• The Databricks JDBC JAR appears under Drivers in the MIStudio project.
• The correct driver JAR was added.
• The project was saved after adding the driver.
• MIStudio was restarted after the JDBC driver was added.
• The Driver Class is:

com.databricks.client.jdbc.Driver

Confirm:

• Server Hostname
• Port
• HTTP Path
• User Name
• Password or authentication credential
• Connection Properties
• SQL Warehouse permissions
• SQL Warehouse availability

For PAT authentication, confirm that the User Name is:

token

and that the Password field contains the user's Databricks Personal Access Token.

Confirm that the correct MIStudio database component is being used.

Use:

• DatabaseRawLookup for queries that return data.
• DatabaseRawWrite for queries that modify database content or structure.

Confirm the current catalog and schema:

SELECT current_catalog()

SELECT current_schema()

If necessary, use the complete table name:

catalog.schema.table

Check that:

• MIStudio is in Simulating mode.
• The correct DatabricksConnectionManager is selected.
• The SQL Warehouse connection information is correct.
• The JDBC driver was added to the project and MIStudio was restarted.

Then check the Databricks SQL Warehouse Query History.

Database credentials and Databricks access tokens should be handled securely.

Do not include credentials in:

• Wiki documentation
• Screenshots
• Source control
• Shared project files
• Issue reports
• Example configuration files

Use the authentication method required by your organization for production systems.

Databricks SQL Warehouse
          |
          | Server Hostname
          | Port
          | HTTP Path
          | Authentication
          v
Databricks JDBC Driver
          |
          v
MIStudio Project Drivers
          |
          v
DatabricksConnectionManager
          |
          +--> DatabaseRawLookup
          |        |
          |        +--> SELECT / Read Data
          |
          +--> DatabaseRawWrite
                   |
                   +--> CREATE / INSERT / UPDATE / DELETE

• MIStudio Logic Editor
• Database Connections
• Data Sources Overview
• Connecting a Data Source to a Graphic
• Servers and Data Sources