Databricks JDBC ドライバー (OSS)

Databricks には、DataGrip、DBeaver、SQL Workbench/J などのツールを JDBC 経由で Azure Databricks に接続できるオープン ソース ソフトウェア (OSS) JDBC ドライバーが用意されています。JDBC (Java Database Connectivity) は、データベース管理システムにアクセスする手段の業界標準仕様です。

このドライバーは JDBC API を実装しており、OAuth、Cloud Fetch、Unity Catalog ボリューム インジェストなどの機能を含むコア機能を提供します。 これはネイティブ クエリ モードを実行し、ネイティブのパラメーター化クエリをサポートし、有益なクエリ結果保持機能を提供する Statement Execution API または Thrift を使用して実行できます。

この記事では、Databricks JDBC ドライバー (OSS) のインストールと使用に関する情報を提供します。 OSS ではない Databricks JDBC ドライバーの詳細については、Databricks JDBC ドライバーの説明を参照してください。

要件

Databricks JDBC ドライバー (OSS) を使用するには、以下の要件を満たす必要があります。

• Java Runtime Environment (JRE) 11.0 以降。 CI テストは、JRE 11、17、および 21 でサポートされています。
• Databricks SQL 2024.30 以降

ドライバーをインストールする

Databricks JDBC ドライバー (OSS) は Maven Repository で公開されています。 最新バージョンは 0.9.0-oss です。

ドライバーをインストールするには、以下のいずれかの操作を行います。

• Maven プロジェクトの場合は、指定したバージョンの JDBC ドライバーを自動的にダウンロードすることを Maven に指示するために、プロジェクトの pom.xml ファイルに以下の依存関係を追加します。

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

• Gradle プロジェクトの場合は、指定したバージョンの JDBC ドライバーを自動的にダウンロードすることを Gradle に指示するために、プロジェクトのビルド ファイルに以下の依存関係を追加します。

  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 個人用アクセス トークン

• OAuth マシン間 (M2M) 認証

Azure Databricks 個人用アクセス トークン

Azure Databricks 個人用アクセス トークン を使用して JDBC ドライバー接続を認証する場合は、JDBC 接続 URL または java.util.Properties オブジェクトに以下のプロパティを追加します。

OAuth マシン間 (M2M) 認証

この JDBC ドライバーは、Microsoft Entra ID サービス プリンシパルの OAuth マシン間 (M2M) 認証をサポートしています。 これは、OAuth 2.0 ''クライアント資格情報'' 認証とも呼ばれます。

OAuth M2M または OAuth 2.0 クライアント資格情報認証を構成するには、以下のようにします。

1. Microsoft Entra ID マネージド サービス プリンシパルを作成し、それを Azure Databricks アカウントとワークスペースに割り当てます。 詳細については、サービス プリンシパルの管理に関する説明を参照してください。

   重要

   Databricks JDBC ドライバー (OSS) は、OAuth M2M または OAuth 2.0 クライアント資格情報認証用の Azure Databricks OAuth シークレットをサポートしています。 Microsoft Entra ID シークレットはサポートされません。

2. サービス プリンシパルの Azure Databricks OAuth シークレットを作成します。 これを行うには、「OAuth M2M 認証用のアクセス トークンを手動で生成して使用する」を参照してください。

3. サービス プリンシパルにクラスターまたはウェアハウスへのアクセス権を付与します。 「コンピューティングのアクセス許可」または「SQL ウェアハウスを管理する」を参照してください。

以下のプロパティを、既存の JDBC 接続 URL または java.util.Properties オブジェクトに追加します。

接続のプロパティ

この JDBC ドライバーでは、以下に示す追加の接続プロパティがサポートされています。 プロパティの大文字と小文字は区別されません。

SQL 構成プロパティ

この JDBC ドライバーでは、以下に示す SQL 構成プロパティがサポートされています。 これらについては、設定パラメータの説明も参照してください。 プロパティの大文字と小文字は区別されません。

ログのプロパティ

この JDBC ドライバーでは、以下のログ記録プロパティがサポートされています。 プロパティの大文字と小文字は区別されません。

例: JDBC ドライバーを使用したクエリ実行

以下の例は、Azure Databricks コンピューティング リソースを使用する Databricks SQL クエリを、JDBC ドライバーを使用して実行する方法を示しています。

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 との統合

• SQL Workbench/J に接続する

• Infoworks に接続する

• Qlik Replicate に接続する

• StreamSets に接続する

• Syncsort に接続する

• MicroStrategy に接続する