Driver ODBC di Databricks (OSS)

Databricks fornisce un driver JDBC (OSS) software open source che consente di connettere strumenti come DataGrip, DBeaver e SQL Workbench/J ad Azure Databricks tramite JDBC (Java Database Connectivity), una specifica standard del settore per l'accesso ai sistemi di gestione dei database.

Questo driver ha implementato le API JDBC e offre funzionalità di base, tra cui OAuth, Cloud Fetch e funzionalità come l'inserimento di volumi del catalogo Unity. Esegue la modalità query nativa e supporta query con parametri nativi e può essere eseguita usando le API di esecuzione delle istruzioni, che fornisce la funzionalità di conservazione dei risultati delle query vantaggiosa o Thrift.

Questo articolo fornisce informazioni sull'installazione e l'uso di Databricks JDBC Driver (OSS). Per informazioni sul driver JDBC di Databricks non OSS, vedere Driver JDBC di Databricks.

Requisiti

Per usare databricks JDBC Driver (OSS), è necessario soddisfare i seguenti requisiti:

• Java Runtime Environment (JRE) 11.0 o versione successiva. I test CI sono supportati in JRE 11, 17 e 21.

Installare il driver

Il driver JDBC di Databricks (OSS) viene pubblicato nel repository Maven. La versione più recente è 0.9.6-oss.

Per installare il driver, è possibile eseguire una delle seguenti operazioni:

• Per i progetti Maven, aggiungere la dipendenza seguente al file pom.xml del progetto per indicare a Maven di scaricare automaticamente il driver JDBC con la versione specificata:

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

• Per i progetti Gradle , aggiungere la dipendenza seguente al file di compilazione del progetto per indicare a Gradle di scaricare automaticamente il driver JDBC con la versione specificata:

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

Per visualizzare la sintassi delle dipendenze per altri tipi di progetto e ottenere il numero di versione più recente di Databricks JDBC Driver (OSS), vedere il repository Maven.

Configurare le connessioni URL

Per connettersi all'area di lavoro di Azure Databricks utilizzando il driver JDBC, è necessario specificare un URL di connessione JDBC che includa varie impostazioni di connessione, come il nome host del server dell'area di lavoro di Azure Databricks, le impostazioni della risorsa di calcolo e le credenziali di autenticazione per la connessione all'area di lavoro.

È possibile impostare il valore di queste proprietà nell'URL della connessione JDBC, impostarle e passarle al metodo DriverManager.getConnection o una combinazione dei due metodi. Vedere la documentazione del provider per informazioni su come connettersi usando l'app, il client, l'SDK, l'API o lo strumento SQL specifico.

L'URL di connessione JDBC deve avere il seguente formato. Le proprietà fanno distinzione tra maiuscole e minuscole.

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

In alternativa, specificare le impostazioni usando la classe java.util.Properties o una combinazione:

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

Gli elementi DELL'URL di connessione sono descritti nella tabella seguente. Per informazioni sulle proprietà aggiuntive, incluse le proprietà di autenticazione, vedere le sezioni seguenti. Gli elementi e le proprietà URL non fanno distinzione tra maiuscole e minuscole.

Per ottenere l'URL di connessione JDBC per un cluster Azure Databricks:

1. Accedere all'area di lavoro di Azure Databricks.
2. Nella barra laterale fare clic su Ambiente di calcolo, quindi sul nome del cluster di destinazione.
3. Nella scheda Configurazione espandere Opzioni avanzate.
4. Fare clic sulla scheda JDBC/ODBC.
5. Copiare l'URL JDBC da usare come URL di connessione JDBC oppure costruire l'URL dai valori nei ampi Nome host server, Porta e Percorso HTTP.

Per ottenere l'URL di connessione JDBC per un databricks SQL Warehouse:

1. Accedere all'area di lavoro di Azure Databricks.
2. Nella barra laterale fare clic su SQL Warehouse, poi sul nome del warehouse di destinazione.
3. Fare clic sulla scheda Dettagli sulle connessioni.
4. Copiare l'URL JDBC da usare come URL di connessione JDBC oppure costruire l'URL dai valori nei ampi Nome host server, Porta e Percorso HTTP.

Autenticare il driver

È possibile autenticare la connessione al driver JDBC usando uno dei meccanismi di autenticazione seguenti:

• Autenticazione da utente a computer (U2M) OAuth (consigliata)
• Autenticazione OAuth da computer a computer (M2M)
• Token di accesso personale di Azure Databricks

Autenticazione da utente a computer (U2M) OAuth

Il driver JDBC supporta l'autenticazione da utente a computer (U2M) OAuth per l'accesso umano in tempo reale e il consenso per autenticare l'account utente di Databricks di destinazione. Questa operazione è nota anche come autenticazione OAuth basata su browser.

Azure Databricks ha creato l'ID client OAuth databricks-sql-jdbc per i clienti. Si tratta anche dell'ID client OAuth predefinito usato nel driver JDBC. Per configurare l'autenticazione U2M OAuth, è sufficiente aggiungere le proprietà seguenti all'URL o all'oggetto java.util.Properties di connessione JDBC esistente:

Autenticazione OAuth da computer a computer (M2M)

Il driver JDBC supporta l'autenticazione da computer a computer (M2M) OAuth usando un'entità servizio di Azure Databricks. Questa operazione è nota anche come autenticazione delle credenziali client OAuth 2.0. Consultare Autenticare l'accesso ad Azure Databricks con un'entità servizio usando OAuth (OAuth M2M).

Per configurare l'autenticazione delle credenziali client OAuth M2M o OAuth 2.0:

1. Creare un'entità servizio gestita da Microsoft Entra ID e assegnarla agli account e alle aree di lavoro di Azure Databricks. Per ulteriori dettagli, vedere Gestire l'entità servizio.

   Importante

   Databricks JDBC Driver (OSS) supporta i segreti OAuth di Azure Databricks per l'autenticazione delle credenziali client OAuth M2M o OAuth 2.0. I segreti dell'ID Microsoft Entra non sono supportati.

2. Creare un segreto OAuth di Azure Databricks per l'entità servizio. A tale scopo, si veda Generare e usare manualmente i token di accesso per l'autenticazione OAuth M2M.

3. Concedere all'entità servizio l'accesso al cluster o al warehouse. Vedere Autorizzazioni di calcolo o Gestire un'istanza di SQL Warehouse.

Aggiungere le proprietà seguenti all'URL o all'oggetto java.util.Properties di connessione JDBC esistente:

Token di accesso personale di Azure Databricks

Per autenticare la connessione al driver JDBC usando un token di accesso personale di Azure Databricks, aggiungere le proprietà seguenti all'URL o all'oggetto java.util.Properties di connessione JDBC:

Proprietà di connessione

Le proprietà di connessione aggiuntive seguenti sono supportate dal driver JDBC. Le proprietà fanno distinzione tra maiuscole e minuscole.

Proprietà di configurazione SQL

Le seguenti proprietà di configurazione SQL sono supportate dal driver JDBC. Questi sono descritti anche in Parametri di configurazione. Le proprietà fanno distinzione tra maiuscole e minuscole.

Proprietà della registrazione

Le seguenti proprietà di registrazione sono supportate dal driver JDBC. Le proprietà fanno distinzione tra maiuscole e minuscole.

Abilitare e configurare la registrazione

Il driver JDBC supporta i framework Simple Logging Facciata per Java (SLF4J) e java.util.logging (JUL). Il driver usa il framework di registrazione JUL per impostazione predefinita.

Per abilitare e configurare la registrazione per il driver JDBC:

1. Abilitare il framework di registrazione che si vuole usare:

   • Per la registrazione SLF4J, impostare la proprietà -Dcom.databricks.jdbc.loggerImpl=SLF4JLOGGER di sistema e fornire l'implementazione dell'associazione SLF4J (compatibile con SLF4J versione 2.0.13 e successive) e il file di configurazione corrispondente nel classpath.
   • Per la registrazione di JUL, impostare la proprietà -Dcom.databricks.jdbc.loggerImpl=JDKLOGGERdi sistema . Si tratta dell'impostazione predefinita.

2. Impostare la LogLevel proprietà sul stringa di connessione sul livello di informazioni desiderato da includere nei file di log.

3. Impostare la LogPath proprietà nel stringa di connessione sul percorso completo della cartella in cui si desidera salvare i file di log.

   Ad esempio, l'URL di connessione seguente abilita il livello di registrazione 6 e salva i file di log nella cartella C:temp:

   jdbc: databricks://localhost:11000;LogLevel=6;LogPath=C:\\temp
   

4. Riavviare l'applicazione JDBC e riconnettersi al server per applicare le impostazioni.

Esempio: eseguire una query usando il driver JDBC

L'esempio seguente illustra come usare il driver JDBC per eseguire una query SQL di Databricks usando una risorsa di calcolo di Azure Databricks.

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

Risorse aggiuntive

• Integrazione di DataGrip con Azure Databricks

• Integrazione di DBeaver con Azure Databricks.

• Connettersi a SQL Workbench/J

• Connettersi a Infoworks

• Connettersi a Qlik Replicate

• Connettersi a StreamSet

• Connettersi a Syncsort

• Connettersi a MicroStrategy