Microsoft Fabric データ エンジニアリング用の Microsoft JDBC ドライバー

JDBC (Java Database Connectivity) は、クライアント アプリケーションがデータベースやビッグ データ プラットフォームのデータに接続して操作できるようにする、広く採用されている標準です。

Microsoft JDBC Driver for Fabric Data Engineeringは、JDBC標準の信頼性とシンプルさをもって、Fabric内でSparkワークロードを接続、照会、管理を可能にします。 FabricのLivy APIを基に構築されたこのドライバーは、JavaアプリケーションやBIツールに対して安全かつ柔軟なSpark SQL接続を提供します。 この統合により、別々のノートブックやSparkジョブ定義項目を作成することなく、Sparkコードを直接提出・実行できます。 このドライバーは、DbVisualizer や DBeaver などの一般的な JDBC クライアントや、Tableau などの JDBC 接続をサポートする BI ツールと互換性があります。

主な機能

• JDBC 4.2 準拠: JDBC 4.2 仕様の完全な実装
• Microsoft Entra ID 認証: 対話型、クライアント資格情報、証明書ベースの認証を含む複数の認証フロー
• HikariCP統合:HikariCPを使って本番アプリケーション向けにJDBC接続を管理・再利用できます
• Spark SQL ネイティブ クエリのサポート: 変換なしで Spark SQL ステートメントを直接実行する
• 包括的なデータ型のサポート: 複合型 (ARRAY、MAP、STRUCT) を含むすべての Spark SQL データ型のサポート
• 非同期の結果セットプリフェッチ: パフォーマンス向上のためのバックグラウンド データ読み込み
• サーキット ブレーカー パターン: 自動再試行による連鎖障害に対する保護
• 自動再接続: 接続エラー時の透過的なセッション復旧
• 高度な再試行ロジック: 指数バックオフとセッション回復を使用して再試行し、回復性を向上させる
• プロキシのサポート: エンタープライズ環境向けの HTTP および SOCKS プロキシの構成

[前提条件]

Microsoft JDBCドライバー for Fabric Data Engineeringを使用する前に、以下の点を確認してください:

• Java Development Kit (JDK): バージョン 11 以降 (Java 21 を推奨)
• Fabricアクセス:Fabricワークスペースへのアクセス
• Microsoft Entra ID資格情報: 認証に適した資格情報
• ワークスペース ID とレイクハウス ID: Fabric ワークスペースとレイクハウスの GUID 識別子

ダウンロードとインストール

Microsoft JDBCドライバー for Fabric Data Engineering バージョン1.0.0は、Java 11、17、21をサポートしています。 Java 接続のサポートは継続的に改善されており、Microsoft JDBC ドライバーの最新バージョンを使用することをお勧めします。

• Microsoft JDBCドライバー for Fabric Data Engineering(zip)をダウンロードしてください
• Microsoft JDBCドライバー for Fabric Data Engineering(tar)をダウンロードしてください

1. 上記のリンクから zip または tar ファイルをダウンロードします。
2. ダウンロードしたファイルを抽出して、ドライバー JAR ファイルにアクセスします。
3. JRE バージョンに一致する JAR ファイルを選択します。
   • Java 11 の場合: ms-sparksql-jdbc-1.0.1.jre11.jar
   • Java 17 の場合: ms-sparksql-jdbc-1.0.1.jre17.jar
   • Java 21 の場合: ms-sparksql-jdbc-1.0.1.jre21.jar
4. 選択した JAR ファイルをアプリケーションのクラスパスに追加します。
5. JDBC クライアントの場合は、JDBC ドライバー クラスを構成します。 com.microsoft.spark.livy.jdbc.LivyDriver

クイック スタートの例

この例は、Microsoft JDBCドライバ for Fabric Data Engineering を使ってFabricに接続しクエリを実行する方法を示しています。 このコードを実行する前に、前提条件が満たされ、ドライバーがインストールされていることを確認してください。

import java.sql.*;

public class QuickStartExample {
    public static void main(String[] args) {
        // Connection string with required parameters
        String url = "jdbc:fabricspark://api.fabric.microsoft.com;" +
                     "FabricWorkspaceID=<workspace-id>;" +
                     "FabricLakehouseID=<lakehouse-id>;" +
                     "AuthFlow=2;" +  // Azure CLI based authentication
                     "LogLevel=INFO";
        
        try (Connection conn = DriverManager.getConnection(url)) {
            // Execute a simple query
            try (Statement stmt = conn.createStatement();
                 ResultSet rs = stmt.executeQuery("SELECT 'Hello from Fabric!' as message")) {
                
                if (rs.next()) {
                    System.out.println(rs.getString("message"));
                }
            }
        } catch (SQLException e) {
            e.printStackTrace();
        }
    }
}

接続文字列の形式

基本的な接続文字列

Microsoft JDBCのFabricデータエンジニアリングドライバーは、以下の接続文字列形式を使用しています:

jdbc:fabricspark://<hostname>[:<port>][;<parameter1>=<value1>;<parameter2>=<value2>;...]

接続文字列コンポーネント

接続文字列の例

基本接続 (対話型ブラウザー ベースの認証)

jdbc:fabricspark://api.fabric.microsoft.com;FabricWorkspaceID=<workspace-id>;FabricLakehouseID=<lakehouse-id>;AuthFlow=1

Spark リソース構成を使用して

jdbc:fabricspark://api.fabric.microsoft.com;FabricWorkspaceID=<workspace-id>;FabricLakehouseID=<lakehouse-id>;DriverCores=4;DriverMemory=4g;ExecutorCores=4;ExecutorMemory=8g;NumExecutors=2;AuthFlow=2

Spark セッションプロパティを用いて

jdbc:fabricspark://api.fabric.microsoft.com;FabricWorkspaceID=<workspace-id>;FabricLakehouseID=<lakehouse-id>;spark.sql.adaptive.enabled=true;spark.sql.shuffle.partitions=200;AuthFlow=2

Authentication

Microsoft JDBCドライバー for Fabric Data Engineeringは、Microsoft Entra ID(旧Azure Active Directory)を通じて複数の認証方法をサポートしています。 認証は、接続文字列の AuthFlow パラメーターを使用して構成されます。

認証フロー

対話型ブラウザー認証

最適な用途: 開発と対話型アプリケーション

String url = "jdbc:fabricspark://api.fabric.microsoft.com;" +
             "FabricWorkspaceID=<workspace-id>;" +
             "FabricLakehouseID=<lakehouse-id>;" +
             "AuthFlow=1;" +  
             "AuthTenantID=<tenant-id>;" +  // Optional
             "LogLevel=INFO";

Connection conn = DriverManager.getConnection(url);

パラメーター:

• AuthFlow=1: 対話型ブラウザー認証を指定します
• AuthTenantID (省略可能): Microsoft Entra テナント ID
• AuthClientID (省略可能): アプリケーション (クライアント) ID

動作：

• ユーザー認証用のブラウザー ウィンドウを開きます
• 資格情報は、有効期限が切れるまで後続の接続用にキャッシュされます
• シングル ユーザー アプリケーションに適しています

クライアント資格情報またはサービス プリンシパル認証

最適な用途は: 自動化されたサービスとバックグラウンド ジョブ

String url = "jdbc:fabricspark://api.fabric.microsoft.com;" +
             "FabricWorkspaceID=<workspace-id>;" +
             "FabricLakehouseID=<lakehouse-id>;" +
             "AuthFlow=3;" +  
             "AuthClientID=<client-id>;" +
             "AuthClientSecret=<client-secret>;" +
             "AuthTenantID=<tenant-id>;" +
             "LogLevel=INFO";

Connection conn = DriverManager.getConnection(url);

必須パラメーター:

• AuthFlow=3: クライアント資格情報認証を指定します
• AuthClientID: Microsoft Entra ID からのアプリケーション (クライアント) ID
• AuthClientSecret: Microsoft Entra ID からのクライアント シークレット
• AuthTenantID: Microsoft Entra テナント ID

ベスト プラクティス:

• シークレットを安全に格納する (Azure Key Vault、環境変数)
• 可能な場合はマネージド ID を使用する
• シークレットを定期的にローテーションする

証明書ベースの認証

最適な対象: 証明書ベースの認証を必要とするエンタープライズ アプリケーション

String url = "jdbc:fabricspark://api.fabric.microsoft.com;" +
             "FabricWorkspaceID=<workspace-id>;" +
             "FabricLakehouseID=<lakehouse-id>;" +
             "AuthFlow=4;" +  
             "AuthClientID=<client-id>;" +
             "AuthCertificatePath=/path/to/certificate.pfx;" +
             "AuthCertificatePassword=<certificate-password>;" +
             "AuthTenantID=<tenant-id>;" +
             "LogLevel=INFO";

Connection conn = DriverManager.getConnection(url);

必須パラメーター:

• AuthFlow=4: 証明書ベースの認証を指定します
• AuthClientID: アプリケーション (クライアント) ID
• AuthCertificatePath: PFX/PKCS12 証明書ファイルへのパス
• AuthCertificatePassword: 証明書パスワード
• AuthTenantID: Microsoft Entra テナント ID

アクセス トークン認証

最適な用途: カスタム認証シナリオ

// Acquire token through custom mechanism
String accessToken = acquireTokenFromCustomSource();

String url = "jdbc:fabricspark://api.fabric.microsoft.com;" +
             "FabricWorkspaceID=<workspace-id>;" +
             "FabricLakehouseID=<lakehouse-id>;" +
             "AuthFlow=5;" +  // Access token authentication
             "AuthAccessToken=" + accessToken + ";" +
             "LogLevel=INFO";

Connection conn = DriverManager.getConnection(url);

認証キャッシュ

ドライバーは、パフォーマンスを向上させるために認証トークンを自動的にキャッシュします。

// Enable/disable caching (enabled by default)
String url = "jdbc:fabricspark://api.fabric.microsoft.com;" +
             "FabricWorkspaceID=<workspace-id>;" +
             "FabricLakehouseID=<lakehouse-id>;" +
             "AuthFlow=2;" +
             "AuthEnableCaching=true;" +  // Enable token caching
             "AuthCacheTTLMS=3600000";    // Cache TTL: 1 hour

Connection conn = DriverManager.getConnection(url);

構成パラメーター

必須のパラメーター

これらのパラメーターは、すべての接続文字列に存在する必要があります。

省略可能なパラメーター

API バージョンの構成

環境の構成

Spark 構成

セッション リソースの構成

最適なパフォーマンスを得られるように Spark セッション リソースを構成します。

Example:

DriverCores=4;DriverMemory=4g;ExecutorCores=4;ExecutorMemory=8g;NumExecutors=2

カスタム Spark セッションのプロパティ

プレフィックス spark. を持つパラメーターは、Spark セッションに自動的に適用されます。

Spark 構成の例:

spark.sql.adaptive.enabled=true
spark.sql.adaptive.coalescePartitions.enabled=true
spark.sql.shuffle.partitions=200
spark.sql.autoBroadcastJoinThreshold=10485760
spark.dynamicAllocation.enabled=true
spark.dynamicAllocation.minExecutors=1
spark.dynamicAllocation.maxExecutors=10
spark.executor.memoryOverhead=1g

ネイティブ実行エンジン (NEE):

spark.nee.enabled=true

完全な例:

jdbc:fabricspark://api.fabric.microsoft.com;FabricWorkspaceID=<guid>;FabricLakehouseID=<guid>;DriverMemory=4g;ExecutorMemory=8g;NumExecutors=2;spark.sql.adaptive.enabled=true;spark.nee.enabled=true;AuthFlow=2

HTTPクライアント接続設定

最適なネットワーク性能のためにドライバーのHTTPトランスポート接続を設定してください。 これらの設定はJDBC接続プーリングの設定や管理にはなりません:

Example:

HttpMaxTotalConnections=200;HttpMaxConnectionsPerRoute=100;HttpConnectionTimeoutInSeconds=60

プロキシの構成

エンタープライズ環境の HTTP および SOCKS プロキシ設定を構成します。

HTTP プロキシの例:

UseProxy=true;ProxyTransport=http;ProxyHost=proxy.company.com;ProxyPort=8080;ProxyAuthEnabled=true;ProxyUsername=user;ProxyPassword=pass

SOCKS プロキシの例:

UseProxy=true;ProxyTransport=tcp;ProxyHost=socks.company.com;ProxyPort=1080;ProxySocksVersion=5

ログ記録の構成

Example:

LogLevel=DEBUG

既定のログの場所:

${user.home}/.microsoft/livy-jdbc-driver/driver.log

カスタム ログ構成: クラスパスでカスタム log4j2.xml または logback.xml ファイルを使用します。

使用例

基本接続

import java.sql.*;

public class BasicConnectionExample {
    public static void main(String[] args) {
        String url = "jdbc:fabricspark://api.fabric.microsoft.com;" +
                     "FabricWorkspaceID=<workspace-id>;" +
                     "FabricLakehouseID=<lakehouse-id>;" +
                     "AuthFlow=2";
        
        try (Connection conn = DriverManager.getConnection(url)) {
            System.out.println("Connected successfully!");
            System.out.println("Database: " + conn.getMetaData().getDatabaseProductName());
            System.out.println("Driver: " + conn.getMetaData().getDriverName());
            System.out.println("Driver Version: " + conn.getMetaData().getDriverVersion());
        } catch (SQLException e) {
            System.err.println("Connection failed: " + e.getMessage());
            e.printStackTrace();
        }
    }
}

クエリの実行

単純なクエリ

public void executeSimpleQuery(Connection conn) throws SQLException {
    String sql = "SELECT current_timestamp() as now";
    
    try (Statement stmt = conn.createStatement();
         ResultSet rs = stmt.executeQuery(sql)) {
        
        if (rs.next()) {
            Timestamp now = rs.getTimestamp("now");
            System.out.println("Current timestamp: " + now);
        }
    }
}

フィルターを使用したクエリ

public void executeQueryWithFilter(Connection conn) throws SQLException {
    String sql = "SELECT * FROM sales WHERE amount > 1000 ORDER BY amount DESC";
    
    try (Statement stmt = conn.createStatement();
         ResultSet rs = stmt.executeQuery(sql)) {
        
        while (rs.next()) {
            int id = rs.getInt("id");
            double amount = rs.getDouble("amount");
            Date date = rs.getDate("sale_date");
            
            System.out.printf("ID: %d, Amount: %.2f, Date: %s%n", 
                            id, amount, date);
        }
    }
}

制限付きクエリ

public void executeQueryWithLimit(Connection conn) throws SQLException {
    String sql = "SELECT * FROM customers LIMIT 10";
    
    try (Statement stmt = conn.createStatement();
         ResultSet rs = stmt.executeQuery(sql)) {
        
        ResultSetMetaData metaData = rs.getMetaData();
        int columnCount = metaData.getColumnCount();
        
        // Print column names
        for (int i = 1; i <= columnCount; i++) {
            System.out.print(metaData.getColumnName(i) + "\t");
        }
        System.out.println();
        
        // Print rows
        while (rs.next()) {
            for (int i = 1; i <= columnCount; i++) {
                System.out.print(rs.getString(i) + "\t");
            }
            System.out.println();
        }
    }
}

結果セットの操作

結果セットの移動

public void navigateResultSet(Connection conn) throws SQLException {
    String sql = "SELECT id, name, amount FROM orders";
    
    try (Statement stmt = conn.createStatement(
            ResultSet.TYPE_SCROLL_INSENSITIVE,
            ResultSet.CONCUR_READ_ONLY);
         ResultSet rs = stmt.executeQuery(sql)) {
        
        // Move to first row
        if (rs.first()) {
            System.out.println("First row: " + rs.getString("name"));
        }
        
        // Move to last row
        if (rs.last()) {
            System.out.println("Last row: " + rs.getString("name"));
            System.out.println("Total rows: " + rs.getRow());
        }
        
        // Move to specific row
        if (rs.absolute(5)) {
            System.out.println("Row 5: " + rs.getString("name"));
        }
    }
}

大規模な結果セットの処理

public void processLargeResultSet(Connection conn) throws SQLException {
    String sql = "SELECT * FROM large_table";
    
    try (Statement stmt = conn.createStatement()) {
        // Set fetch size for efficient memory usage
        stmt.setFetchSize(1000);
        
        try (ResultSet rs = stmt.executeQuery(sql)) {
            int rowCount = 0;
            while (rs.next()) {
                // Process row
                processRow(rs);
                rowCount++;
                
                if (rowCount % 10000 == 0) {
                    System.out.println("Processed " + rowCount + " rows");
                }
            }
            System.out.println("Total rows processed: " + rowCount);
        }
    }
}

private void processRow(ResultSet rs) throws SQLException {
    // Process individual row
}

準備されたステートメントの使用

public void usePreparedStatement(Connection conn) throws SQLException {
    String sql = "SELECT * FROM products WHERE category = ? AND price > ?";
    
    try (PreparedStatement pstmt = conn.prepareStatement(sql)) {
        // Set parameters
        pstmt.setString(1, "Electronics");
        pstmt.setDouble(2, 100.0);
        
        try (ResultSet rs = pstmt.executeQuery()) {
            while (rs.next()) {
                String name = rs.getString("name");
                double price = rs.getDouble("price");
                System.out.printf("Product: %s, Price: $%.2f%n", name, price);
            }
        }
    }
}

バッチ操作

public void executeBatchInsert(Connection conn) throws SQLException {
    String sql = "INSERT INTO logs (timestamp, level, message) VALUES (?, ?, ?)";
    
    try (PreparedStatement pstmt = conn.prepareStatement(sql)) {
        conn.setAutoCommit(false);  // Disable auto-commit for batch
        
        // Add multiple statements to batch
        for (int i = 0; i < 1000; i++) {
            pstmt.setTimestamp(1, new Timestamp(System.currentTimeMillis()));
            pstmt.setString(2, "INFO");
            pstmt.setString(3, "Log message " + i);
            pstmt.addBatch();
            
            // Execute batch every 100 statements
            if (i % 100 == 0) {
                pstmt.executeBatch();
                pstmt.clearBatch();
            }
        }
        
        // Execute remaining statements
        pstmt.executeBatch();
        conn.commit();
        
        System.out.println("Batch insert completed successfully");
    } catch (SQLException e) {
        conn.rollback();
        throw e;
    } finally {
        conn.setAutoCommit(true);
    }
}

HikariCPを使用した接続プーリング

HikariCP が LivyDriver 経由で接続を作成するように、JDBC URL を使用して設定します。 HikariCPインスタンスを1つ作成し、アプリケーションの寿命期間中再利用します。

Maven の依存関係

<dependency>
    <groupId>com.zaxxer</groupId>
    <artifactId>HikariCP</artifactId>
    <version>5.0.1</version>
</dependency>

HikariCPをJDBCのURLで設定してください

JDBCのURLとドライバークラスを設定し、HikariCPが LivyDriverを通じて物理的な接続を作成できるようにします。 JDBCサービスプロバイダーの自動検出機能がある場合、ドライバークラスの設定は任意です:

import com.zaxxer.hikari.HikariConfig;
import com.zaxxer.hikari.HikariDataSource;

import java.sql.Connection;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;

public final class DriverConnectionPoolExample {
    public static HikariDataSource createPool(String url) {
        HikariConfig config = new HikariConfig();
        config.setDriverClassName("com.microsoft.spark.livy.jdbc.LivyDriver");
        config.setJdbcUrl(url);

        // Keep pool sizes small: each classic-mode physical connection owns a Livy session.
        config.setMaximumPoolSize(2);
        config.setMinimumIdle(0);
        config.setConnectionTimeout(900000);     // Wait up to 15 minutes to borrow a connection
        config.setInitializationFailTimeout(-1); // Skip startup validation; connect on demand
        config.setIdleTimeout(600000);           // 10 minutes
        config.setMaxLifetime(1800000);          // 30 minutes
        config.setPoolName("FabricSparkDriverPool");

        return new HikariDataSource(config);
    }

    public static void main(String[] args) throws SQLException {
        String url = "jdbc:fabricspark://api.fabric.microsoft.com;" +
                     "FabricWorkspaceID=<workspace-id>;" +
                     "FabricLakehouseID=<lakehouse-id>;" +
                     "AuthFlow=AZURE_CLI;" +            // Uses the DefaultAzureCredential chain
                     "LivySessionTimeoutSeconds=600";  // Poll up to 10 minutes for session readiness

        // Reuse this pool for the application lifetime; main closes it at process exit.
        try (HikariDataSource pool = createPool(url);
             Connection conn = pool.getConnection();
             Statement stmt = conn.createStatement();
             ResultSet rs = stmt.executeQuery("SELECT 'Pooled LivyDriver connection!' as message")) {

            if (rs.next()) {
                System.out.println(rs.getString("message"));
            }
        }
    }
}

プールを設定する際は以下のガイダンスを参考にしてください:

HikariCPの設定オプションの完全なリストについては、以下をご覧ください:

• HikariConfig API リファレンス
• HikariCPの設定オプション

データ型マッピング

ドライバーは、Spark SQL データ型を JDBC SQL 型と Java 型にマップします。

関連コンテンツ

• Fabric の Apache Spark Runtime
• ファブリック ランタイム 1.3
• データ エンジニアリング用 Livy API とは