Databricks Isv Integration

Databricks ISV Integration

Overview

This skill provides patterns and code examples for building PWAF-compliant ISV integrations with Databricks, following the Partner Well-Architected Framework (PWAF).

Cursor rule vs skills: Use the Cursor rule (.cursor/rules/databricks-isv-integration.mdc) for file-scoped context when editing integration code (it applies when you work in matching paths). Use the skills in skills/*/SKILL.md for task-based guidance (e.g. "add a Databricks connector," "fix U2M," "run auth tests")—the agent loads the relevant skill by description. Auth patterns live in skills/<connector>/authentication.md, co-located with each skill.

PWAF covers:

• Authentication: OAuth M2M, U2M, Token Federation, PAT
• Telemetry: User-Agent attribution for partner tracking
• Unity Catalog: Proper namespace usage and governance
• SQL Drivers: JDBC, ODBC, Node.js, Go connectivity

PWAF Integration Requirements Summary

All PWAF-validated partner integrations must meet these requirements:

Applications: Use OAuth M2M for service/backend flows, or U2M for interactive user sign-in. U2M has three flows: (1) SDK external-browser with built-in app (simplest; no custom app), (2) SDK external-browser with custom OAuth app (for ISV integrations; configurable redirect URI), (3) token pass-through (pre-obtained token; headless/CI). All use Auth_Flow=0 on the JDBC side. For custom apps, redirect URI is configurable; default http://localhost:8080/callback. For the built-in app, redirect URI is http://localhost:8020.

Quick Start: JDBC Connection with OAuth M2M

import java.sql.*;
import java.util.Properties;

public class DatabricksConnector {
    public static Connection connect(
            String host,
            String httpPath,
            String clientId,
            String clientSecret,
            String userAgent
    ) throws SQLException {
        String url = "jdbc:databricks://" + host + ":443";
        
        Properties props = new Properties();
        props.put("httpPath", httpPath);
        props.put("SSL", "1");
        
        // OAuth M2M Authentication
        props.put("AuthMech", "11");
        props.put("Auth_Flow", "1");
        props.put("OAuth2ClientId", clientId);
        props.put("OAuth2Secret", clientSecret);
        
        // Partner Telemetry (REQUIRED)
        props.put("UserAgentEntry", userAgent);
        
        return DriverManager.getConnection(url, props);
    }
}

Authentication Types

Dynamic Field Requirements by Auth Type

When building a connector UI, show these fields based on auth selection:

U2M: All three U2M flows use Auth_Flow=0 (token pass-through) on the JDBC side. The token is obtained externally via the Databricks SDK or a prior OAuth exchange. For custom OAuth apps, use DATABRICKS_U2M_CLIENT_ID (not the M2M DATABRICKS_CLIENT_ID). Redirect URI: configurable for custom apps; http://localhost:8020 for the built-in app (must set explicitly in Java SDK v0.54.0).

See skills/java-jdbc/authentication.md for complete code examples including Java SDK workarounds.

Telemetry Attribution

User-Agent Format (required per PWAF for all partner integrations):

<isv-name>_<product-name>/<product-version>

Example: AcmePartner_DataConnector/2.1.0

See skills/telemetry-attribution/SKILL.md for driver-specific configuration.

Reference Files

Quick index: INDEX.md – one line per rule and skill.

Authentication by Driver/SDK (skills/<connector>/authentication.md)

Telemetry & Validation

• skills/telemetry-attribution/SKILL.md - User-Agent configuration for all drivers
• skills/connector-testing/integration-checklist.md - Validation checklist for partners
• skills/connector-testing/env-isolation.md - env -i isolation pattern for tests

Cursor rule and skills (subfolders)

Maven Dependencies (Java)

Java SDK (workspace APIs, UC, Jobs — no warehouse needed):

<dependency>
    <groupId>com.databricks</groupId>
    <artifactId>databricks-sdk-java</artifactId>
    <version>0.54.0</version>
</dependency>

Java 11+ required. See skills/java-sdk/SKILL.md.

OSS JDBC driver (SQL queries via warehouse):

<dependency>
    <groupId>com.databricks</groupId>
    <artifactId>databricks-jdbc</artifactId>
    <version>3.1.1</version>
    <scope>runtime</scope>
</dependency>

On Java 17+, add --add-opens=java.base/java.nio=ALL-UNNAMED (e.g. MAVEN_OPTS or exec plugin). See skills/java-jdbc/SKILL.md.

Go Module Dependencies

Databricks SDK for Go (workspace APIs, UC, Jobs — no warehouse needed):

go get github.com/databricks/databricks-sdk-go@v0.107.0

Go 1.21+ required. Uses useragent.WithPartner() / useragent.WithProduct() for telemetry. See skills/go-sdk/SKILL.md.

Databricks SQL Driver for Go (SQL queries via warehouse):

go get github.com/databricks/databricks-sql-go

Go 1.20+ required. Requires DATABRICKS_HTTP_PATH (SQL warehouse). Uses dbsql.WithUserAgentEntry() for telemetry. See skills/go-sql-driver/SKILL.md.

Common Issues

External Resources

• PWAF – Partner Well-Architected Framework
• PWAF – Telemetry & Attribution
• PWAF – Integration Requirements
• Databricks OSS JDBC Driver
• OAuth M2M Documentation