Databricks JDBC 驱动程序 (OSS)

Databricks 提供了一个开放源代码软件 (OSS) JDBC 驱动程序，可支持你通过 Java 数据库连接 (JDBC) 将 DataGrip 和 DBeaver 等工具连接到 Azure Databricks，这是用于访问数据库管理系统的行业标准规范。

此驱动程序已实现 JDBC API，并提供核心功能，包括 OAuth、Cloud Fetch 以及 Unity Catalog 卷引入等功能。 它运行本机查询模式并支持本机参数化查询，并且可以使用语句执行 API（提供有利的查询结果保留功能）或 Thrift 运行。

本文提供有关安装和使用 Databricks JDBC 驱动程序 (OSS) 的信息。 有关非 OSS Databricks JDBC 驱动程序的信息，请参阅 Databricks JDBC 驱动程序。

要求

若要使用 Databricks JDBC 驱动程序 (OSS)，必须满足以下要求：

• Java Runtime Environment (JRE) 11.0 或更高版本。 JRE 11、17 和 21 支持 CI 测试。
• Databricks SQL 2024.30 或更高版本

安装驱动程序

Databricks JDBC 驱动程序 (OSS) 在 Maven 存储库中发布。 最新版本为 0.9.0-oss。

若要安装驱动程序，可以执行以下任一操作：

• 对于 Maven 项目，请将以下依赖项添加到项目的 pom.xml 文件中，以指示 Maven 自动下载指定版本的 JDBC 驱动程序：

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

• 对于 Gradle 项目，请将以下依赖项添加到项目的生成文件中，以指示 Gradle 自动下载指定版本的 JDBC 驱动程序：

  implementation 'com.databricks:databricks-jdbc:0.9.0-oss'
  

要查看其他项目类型的依赖项语法，并获取 Databricks JDBC 驱动程序 (OSS) 的最新版本号，请参阅 Maven 存储库。

配置连接 URL

要使用 JDBC 驱动程序连接到 Azure Databricks 工作区，需要指定一个 JDBC 连接 URL，其中包括各种连接设置，例如 Azure Databricks 工作区的服务器主机名、计算资源设置和用于连接到工作区的身份验证凭据。

可以在 JDBC 连接 URL 上设置这些属性的值，设置并将其传递到 DriverManager.getConnection 方法，或结合两者。 请参阅提供程序的文档，以了解如何最好地使用特定应用、客户端、SDK、API 或 SQL 工具进行连接。

JDBC 连接 URL 必须采用以下格式。 属性不区分大小写。

jdbc:databricks://<server-hostname>:<port>/<schema>;[property1]=[value];[property2]=[value];...

或者，使用 java.util.Properties 类或组合指定设置：

String url = "jdbc:databricks://<server-hostname>:<port>/<schema>";
Properties properties = new java.util.Properties();
properties.put("<property1>", "<value1");
properties.put("<property2>", "<value2");
// ...
Connection conn = DriverManager.getConnection(url, properties);

String url = "jdbc:databricks://<server-hostname>:<port>/<schema>;[property1]=[value];[property2]=[value];";
Connection conn = DriverManager.getConnection(url, "token", "12345678901234667890abcdabcd");

下表描述了连接 URL。 有关其他属性（包括身份验证属性）的信息，请参阅以下部分。 URL 元素和属性不区分大小写。

若要获取 Azure Databricks 群集的 JDBC 连接 URL，请执行以下操作：

1. 登录到你的 Azure Databricks 工作区。
2. 在边栏中，单击“计算”，然后单击目标群集的名称。
3. 在“配置”选项卡上，展开“高级选项”。
4. 单击“JDBC/ODBC”选项卡。
5. 复制 JDBC URL 以用作 JDBC 连接 URL，或从“服务器主机名”、“端口”和“HTTP 路径”字段中的值构造 URL。

若要获取 Databricks SQL 仓库的 JDBC 连接 URL，请执行以下操作：

1. 登录到你的 Azure Databricks 工作区。
2. 在边栏中，单击“SQL 仓库”，然后单击目标仓库的名称。
3. 单击“连接详细信息”选项卡。
4. 复制 JDBC URL 以用作 JDBC 连接 URL，或从“服务器主机名”、“端口”和“HTTP 路径”字段中的值构造 URL。

对驱动程序进行身份验证

可以使用以下身份验证机制之一对 JDBC 驱动程序连接进行身份验证：

• Azure Databricks 个人访问令牌

Azure Databricks 个人访问令牌

要使用 Azure Databricks 个人访问令牌对 JDBC 驱动程序连接进行身份验证，请将以下属性添加到 JDBC 连接 URL 或 java.util.Properties 对象：

连接属性

JDBC 驱动程序支持以下额外的连接属性。 属性不区分大小写。

SQL 配置属性

JDBC 驱动程序支持以下 SQL 配置属性。 配置参数中也介绍了这些参数。 属性不区分大小写。

日志记录属性

JDBC 驱动程序支持以下日志记录属性。 属性不区分大小写。

示例：使用 JDBC 驱动程序运行查询

以下示例演示如何使用 JDBC 驱动程序通过 Azure Databricks 计算资源运行 Databricks SQL 查询。

import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.ResultSet;
import java.sql.ResultSetMetaData;
import java.sql.Statement;
import java.util.Properties;

public class DatabricksJDBCExample {

    public static void main(String[] args) {

        Class.forName("com.databricks.client.jdbc.Driver");

        // Set JDBC URL properties
        String jdbcUrl = "jdbc:databricks://dbc-a1b2345c-d6e7.cloud.databricks.com:443";
        Properties connectionProperties = new Properties();
        connectionProperties.put("httpPath", "sql/protocolv1/o/123456780012345/0123-123450-z000pi22");
        connectionProperties.put("ssl", "1");

        // Set authentication properties (personal access token)
        connectionProperties.put("AuthMech", "3");
        connectionProperties.put("user", "token");
        connectionProperties.put("password", "12345678901234667890abcdabcd");

        // Set logging properties
        connectionProperties.put("logPath", "logs/myapplication.log");

        // Establish connection and execute query
        try (Connection connection = DriverManager.getConnection(jdbcUrl, connectionProperties);
             Statement statement = connection.createStatement();
             ResultSet resultSet = statement.executeQuery("SELECT * FROM samples.nyctaxi.trips")) {

            // Get metadata and column names
            ResultSetMetaData metaData = resultSet.getMetaData();
            String[] columns = new String[metaData.getColumnCount()];
            for (int i = 0; i < columns.length; i++) {
                columns[i] = metaData.getColumnName(i + 1);
            }

            // Process and print the result set
            while (resultSet.next()) {
                System.out.print("Row " + resultSet.getRow() + "=[");
                for (int i = 0; i < columns.length; i++) {
                    if (i != 0) {
                        System.out.print(", ");
                    }
                    System.out.print(columns[i] + "='" + resultSet.getObject(i + 1) + "'");
                }
                System.out.println("]");
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

其他资源

• DataGrip 与 Azure Databricks 的集成

• DBeaver 与 Azure Databricks 的集成

• 连接到 Infoworks

• 连接到 Qlik Replicate

• 连接到 StreamSets

• 连接到 Syncsort