Microsoft driver JDBC para engenharia de dados Microsoft Fabric

O JDBC (Conectividade de Banco de Dados Java) é um padrão amplamente adotado que permite que os aplicativos cliente se conectem e trabalhem com dados de bancos de dados e plataformas de Big Data.

O driver Microsoft JDBC para Fabric Data Engineering permite conectar, consultar e gerenciar cargas de trabalho do Spark no Fabric com a confiabilidade e simplicidade do padrão JDBC. Construído sobre as APIs Livy da Fabric, o driver oferece conectividade Spark SQL segura e flexível para suas aplicações Java e ferramentas de BI. Essa integração permite que você envie e execute código Spark diretamente, sem precisar criar itens separados de definição de notebooks ou tarefas do Spark. O driver é compatível com clientes JDBC populares, como DbVisualizer e DBeaver, bem como ferramentas de BI que dão suporte à conectividade JDBC, incluindo o Tableau.

Principais características

• JDBC 4.2 Compatível: implementação completa da especificação JDBC 4.2
• Autenticação da ID do Microsoft Entra: vários fluxos de autenticação, incluindo interativas, credenciais do cliente e autenticação baseada em certificado
• Integração com HikariCP: Use o HikariCP para gerenciar e reutilizar conexões JDBC para aplicações de produção
• Suporte à consulta nativa do Spark SQL: execução direta de instruções SQL do Spark sem tradução
• Suporte a tipos de dados abrangentes: suporte para todos os tipos de dados SQL do Spark, incluindo tipos complexos (ARRAY, MAP, STRUCT)
• Pré-busca de Conjunto de Resultados Assíncronos: carregamento de dados em segundo plano para aprimorar o desempenho
• Padrão de disjuntor: proteção contra falhas em cascata com repetição automática
• Reconexão automática: recuperação de sessão transparente em falhas de conexão
• Lógica de Repetição Avançada: Realizar nova tentativa com retrocesso exponencial e recuperação de sessão para aumentar a resiliência
• Suporte a proxy: configuração de proxy HTTP e SOCKS para ambientes empresariais

Pré-requisitos

Antes de usar o driver Microsoft JDBC para Fabric Data Engineering, certifique-se de que você tem:

• JDK (Java Development Kit): versão 11 ou superior (Java 21 recomendado)
• Fabric Access: Acesso a um espaço de trabalho Fabric
• Credenciais do Microsoft Entra ID: credenciais adequadas para autenticação
• IDs do Workspace e Lakehouse: identificadores GUID para o seu Workspace do Fabric e Lakehouse

Baixar e instalar

O Microsoft JDBC Driver for Fabric Data Engineering versão 1.0.0 suporta Java 11, 17 e 21. Estamos melhorando continuamente o suporte à conectividade Java e recomendamos que você trabalhe com a versão mais recente do driver JDBC da Microsoft.

• Baixe o driver Microsoft JDBC para Fabric Data Engineering (zip)
• Baixe o driver Microsoft JDBC para Fabric Data Engineering (tar)

1. Baixe o arquivo zip ou tar dos links acima.
2. Extraia o arquivo baixado para acessar os arquivos JAR do driver.
3. Selecione o arquivo JAR que corresponde à sua versão do JRE:
   • Para Java 11: ms-sparksql-jdbc-1.0.1.jre11.jar
   • Para Java 17: ms-sparksql-jdbc-1.0.1.jre17.jar
   • Para Java 21: ms-sparksql-jdbc-1.0.1.jre21.jar
4. Adicione o arquivo JAR selecionado ao classpath do aplicativo.
5. Para clientes JDBC, configure a classe de driver JDBC: com.microsoft.spark.livy.jdbc.LivyDriver

Exemplo de Início Rápido

Este exemplo demonstra como conectar ao Fabric e executar uma consulta usando o driver Microsoft JDBC para Fabric Data Engineering. Antes de executar esse código, verifique se você concluiu os pré-requisitos e instalou o driver.

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();
        }
    }
}

Formato da cadeia de conexão

Cadeia de conexão básica

O driver Microsoft JDBC para Fabric Data Engineering utiliza o seguinte formato de cadeia de conexão:

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

Componentes da cadeia de conexão

Exemplo de cadeias de conexão

Conexão básica (autenticação baseada em navegador interativo)

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

Com a configuração de recursos do 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

Com propriedades de sessão do 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

O Microsoft JDBC Driver for Fabric Data Engineering suporta múltiplos métodos de autenticação por meio do Microsoft Entra ID (anteriormente Azure Active Directory). A autenticação é configurada usando o AuthFlow parâmetro na cadeia de conexão.

Fluxos de autenticação

Autenticação interativa do navegador

Melhor para: desenvolvimento e aplicativos interativos

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);

Parâmetros:

• AuthFlow=1: especifica a autenticação interativa do navegador
• AuthTenantID (opcional): Microsoft Entra ID do inquilino
• AuthClientID (opcional): ID do aplicativo (cliente)

Comportamento:

• Abre uma janela do navegador para autenticação do usuário
• As credenciais são armazenadas em cache para conexões subsequentes até que elas expirem
• Adequado para aplicativos de usuário único

Credenciais do cliente ou autenticação de entidade de serviço

Melhor para: serviços automatizados e trabalhos em segundo plano

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);

Parâmetros necessários:

• AuthFlow=3: especifica a autenticação de credenciais do cliente
• AuthClientID: ID do aplicativo (cliente) da Microsoft Entra ID
• AuthClientSecret: segredo do cliente do Microsoft Entra ID
• AuthTenantID: ID do locatário Microsoft Entra

Melhores Práticas:

• Armazenar segredos com segurança (Azure Key Vault, variáveis de ambiente)
• Usar identidades gerenciadas quando possível
• Girar segredos regularmente

Autenticação Baseada em Certificado

Melhor para: aplicativos empresariais que exigem autenticação baseada em certificado

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);

Parâmetros necessários:

• AuthFlow=4: especifica a autenticação baseada em certificado
• AuthClientID: ID do aplicativo (cliente)
• AuthCertificatePath: caminho para o arquivo de certificado PFX/PKCS12
• AuthCertificatePassword: senha do certificado
• AuthTenantID: ID do locatário Microsoft Entra

Autenticação de Token de Acesso

Melhor para: cenários de autenticação personalizados

// 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);

Cache de autenticação

O driver armazena automaticamente tokens de autenticação em cache para melhorar o desempenho:

// 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);

Parâmetros de configuração

Parâmetros necessários

Esses parâmetros devem estar presentes em todas as cadeias de conexão:

Parâmetros opcionais

Configuração de versão da API

Configuração do Ambiente

Configuração do Spark

Configuração de recursos de sessão

Configurar recursos de sessão do Spark para um desempenho ideal:

Example:

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

Propriedades personalizadas da sessão do Spark

Qualquer parâmetro com o prefixo spark. é aplicado automaticamente à sessão do Spark:

Exemplo de configurações do 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 (Mecanismo de Execução Nativa):

spark.nee.enabled=true

Exemplo completo:

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

Configurações de conexão com cliente HTTP

Configure as conexões de transporte HTTP do driver para obter o desempenho ideal da rede. Essas configurações não configuram nem gerenciam o pooling de conexões JDBC:

Example:

HttpMaxTotalConnections=200;HttpMaxConnectionsPerRoute=100;HttpConnectionTimeoutInSeconds=60

Configuração de proxy

Defina as configurações de proxy HTTP e SOCKS para ambientes empresariais:

Exemplo de proxy HTTP:

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

Exemplo de proxy SOCKS:

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

Configuração de log

Example:

LogLevel=DEBUG

Local de log padrão:

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

Configuração de log personalizada: Use um arquivo personalizado log4j2.xml ou logback.xml no seu classpath.

Exemplos de uso

Conexão Básica

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();
        }
    }
}

Executando consultas

Consulta simples

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);
        }
    }
}

Consulta com Filtro

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);
        }
    }
}

Consulta com Limite

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();
        }
    }
}

Trabalhando com conjuntos de resultados

Navegando em conjuntos de resultados

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"));
        }
    }
}

Processamento de grandes conjuntos de resultados

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
}

Usando instruções preparadas

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);
            }
        }
    }
}

Operações em lote

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);
    }
}

Pooling de conexões com o HikariCP

Configure o HikariCP com a URL JDBC para que ele crie conexões através LivyDriverde . Crie uma instância do HikariCP e reutilize-a durante a vida útil da aplicação.

Dependência de Maven

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

Configure o HikariCP com a URL do JDBC

Configure a URL JDBC e a classe do driver para que o HikariCP crie conexões físicas através de LivyDriver. Definir explicitamente a classe do driver é opcional quando a descoberta automática do provedor de serviço JDBC está disponível:

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"));
            }
        }
    }
}

Use as seguintes orientações ao configurar o pool:

Para a lista completa de opções de configuração do HikariCP, veja:

• Referência da API HikariConfig
• Opções de configuração do HikariCP

Mapeamento de tipo de dados

O driver mapeia tipos de dados SQL do Spark para tipos SQL JDBC e tipos Java:

Conteúdo relacionado

• Ambientes de execução do Apache Spark no Azure Fabric
• Fabric Runtime 1.3
• O que é a API livy para engenharia de dados