Condividi tramite

Driver Databricks per SQLTools per Visual Studio Code

  • Articolo

Importante

Questa funzionalità è disponibile in anteprima pubblica.

Il driver Databricks per SQLTools consente di usare l'estensione SQLTools per Visual Studio Code per esplorare gli oggetti SQL e per eseguire query SQL in aree di lavoro remote di Azure Databricks.

Operazioni preliminari

Prima di poter usare il driver Databricks per SQLTools, l'area di lavoro di Azure Databricks e il computer di sviluppo locale devono soddisfare i requisiti seguenti.

Requisiti dell'area di lavoro

È necessario avere almeno un'area di lavoro di Azure Databricks disponibile e l'area di lavoro deve soddisfare i requisiti seguenti:

Requisiti del computer di sviluppo locale

È necessario disporre degli elementi seguenti nel computer di sviluppo locale:

  • Visual Studio Code versione 1.70 o successiva. Per visualizzare la versione installata, fare clic su Code > About Visual Studio Code dal menu manin in Linux o macOS e guida > su In Windows. Per scaricare, installare e configurare Visual Studio Code, vedere Configurazione di Visual Studio Code.
  • Estensione SQLTools per Visual Studio Code.
  • Estensione Databricks Driver per SQLTools per Visual Studio Code.

Per installare l'estensione SQLTools, passare a SQLTools e quindi fare clic su Installa oppure:

  1. In Visual Studio Code fare clic su Visualizza > estensioni nel menu principale.

  2. Nella casella Cerca estensioni nel Marketplace immettere SQLTools.

  3. Fare clic sulla voce SQLTools da Matheus Teixeira.

    Nota

    Potrebbero essere elencate più voci di SQLTools . Assicurarsi di fare clic sulla voce da Matheus Teixeira.

  4. Fare clic su Installa.

Per installare l'estensione Databricks Driver for SQLTools, passare a Databricks Driver for SQLTools e quindi fare clic su Installa oppure:

  1. In Visual Studio Code fare clic su Visualizza > estensioni nel menu principale.
  2. Nella casella Cerca estensioni nel Marketplace immettere Databricks Driver for SQLTools.
  3. Fare clic sulla voce Driver Databricks per SQLTools .
  4. Fare clic su Installa.

Autenticazione

È necessario configurare l'autenticazione per il driver Databricks per SQLTools come indicato di seguito.

Il driver Databricks per SQLTools supporta i tipi di autenticazione di Azure Databricks seguenti:

Nota

Il driver Databricks per SQLTools non supporta i token ID di Microsoft Entra.

Autenticazione del token di accesso personale di Azure Databricks

Per usare il driver Databricks per SQLTools con l'autenticazione del token di accesso personale di Azure Databricks, è necessario disporre di un token di accesso personale di Azure Databricks. Per creare un token di accesso personale, eseguire le operazioni seguenti:

  1. Nell'area di lavoro di Azure Databricks fare clic sul nome utente di Azure Databricks nella barra superiore e quindi selezionare Impostazioni nell'elenco a discesa.
  2. Fare clic su Sviluppatore.
  3. Accanto a Token di accesso fare clic su Gestisci.
  4. Fare clic su Generare nuovi token.
  5. (Facoltativo) Immettere un commento che consente di identificare questo token in futuro e modificare la durata predefinita del token di 90 giorni. Per creare un token senza durata (scelta non consigliata), lasciare vuota la casella Durata (giorni) (vuota).
  6. Fare clic su Genera.
  7. Copiare il token visualizzato in un percorso sicuro e quindi fare clic su Fine.

Nota

Assicurarsi di salvare il token copiato in un percorso sicuro. Non condividere il token copiato con altri utenti. Se si perde il token copiato, non è possibile rigenerare lo stesso token esatto. È invece necessario ripetere questa procedura per creare un nuovo token. Se si perde il token copiato o si ritiene che il token sia stato compromesso, Databricks consiglia vivamente di eliminare immediatamente il token dall'area di lavoro facendo clic sull'icona del cestino (Revoca) accanto al token nella pagina Token di accesso.

Se non è possibile creare o usare token nell'area di lavoro, questo potrebbe essere dovuto al fatto che l'amministratore dell'area di lavoro ha disabilitato i token o non ha concesso l'autorizzazione per creare o usare token. Vedere l'amministratore dell'area di lavoro o quanto segue:

Autenticazione da computer a computer (M2M) di Azure Databricks

È possibile usare l'autenticazione da computer a computer (M2M) di Azure Databricks per eseguire l'autenticazione con il driver Databricks per SQLTools, come indicato di seguito:

Nota

L'autenticazione OAuth M2M di Azure Databricks è disponibile in Databricks Driver per SQLTools versioni 0.4.2 e successive.

  1. Completare i passaggi di configurazione per l'autenticazione M2M OAuth. Vedere Autenticazione da computer a computer (M2M) OAuth.
  2. Creare un profilo di configurazione di Azure Databricks con le impostazioni di configurazione dell'autenticazione OAuth M2M. Vedere la sezione "Config" dell'autenticazione da computer a computer (M2M) OAuth.
  3. Installare e aprire l'estensione Databricks per Visual Studio Code nel computer di sviluppo locale.
  4. Nell'estensione Databricks per Visual Studio Code fare clic sul pulsante Configura nel riquadro Configurazione . Se il pulsante Configura non viene visualizzato, fare clic sull'icona a forma di ingranaggio (Configura area di lavoro).
  5. Nel riquadro comandi, per Host Databricks, immettere l'URL di Azure Databricks per area di lavoro, ad esempio https://adb-1234567890123456.7.azuredatabricks.net, e quindi premere INVIO.
  6. Selezionare la voce del profilo di configurazione corrispondente a quella creata nel passaggio 2.
  7. Completare le istruzioni visualizzate nel Web browser per completare l'autenticazione con l'account Azure Databricks.

Autenticazione da utente a computer (U2M) di Azure Databricks

È possibile usare l'autenticazione da utente a computer (U2M) di Azure Databricks per eseguire l'autenticazione con il driver Databricks per SQLTools, come indicato di seguito:

Nota

L'autenticazione U2M OAuth di Azure Databricks è disponibile in Databricks Driver per SQLTools versioni 0.4.2 e successive.

  1. Installare e aprire l'estensione Databricks per Visual Studio Code nel computer di sviluppo locale.
  2. Nell'estensione Databricks per Visual Studio Code fare clic sul pulsante Configura nel riquadro Configurazione . Se il pulsante Configura non viene visualizzato, fare clic sull'icona a forma di ingranaggio (Configura area di lavoro).
  3. Nel riquadro comandi, per Host Databricks, immettere l'URL di Azure Databricks per area di lavoro, ad esempio https://adb-1234567890123456.7.azuredatabricks.net. Premere INVIO.
  4. Selezionare OAuth (da utente a computer).
  5. Completare le istruzioni visualizzate nel Web browser per completare l'autenticazione con l'account Azure Databricks. Se richiesto, consentire all-apis l'accesso.

Autenticazione dell'interfaccia della riga di comando di Azure

È possibile usare l'interfaccia della riga di comando di Azure per eseguire l'autenticazione con il driver Databricks per SQLTools, come indicato di seguito:

Nota

L'autenticazione con l'interfaccia della riga di comando di Azure è in uno stato di funzionalità sperimentale . Questa funzionalità è disponibile in Databricks Driver per SQLTools versioni 0.4.2 e successive.

  1. Installare l'interfaccia della riga di comando di Azure nel computer di sviluppo locale, se non è già stato fatto.
  2. Installare e aprire l'estensione Databricks per Visual Studio Code nel computer di sviluppo locale.
  3. Nell'estensione Databricks per Visual Studio Code fare clic sul pulsante Configura nel riquadro Configurazione . Se il pulsante Configura non viene visualizzato, fare clic sull'icona a forma di ingranaggio (Configura area di lavoro).
  4. Nel riquadro comandi, per Host Databricks, immettere l'URL di Azure Databricks per area di lavoro, ad esempio https://adb-1234567890123456.7.azuredatabricks.net. Premere INVIO.
  5. Selezionare Interfaccia della riga di comando di Azure.
  6. Seguire le istruzioni visualizzate per completare l'autenticazione con l'interfaccia della riga di comando di Azure.

Connettersi a uno schema

  1. Nella barra laterale di Visual Studio Code fare clic sull'icona SQLTools .
  2. Nella visualizzazione SQLTools, se è la prima volta che si usa l'estensione SQLTools, fare clic su Aggiungi nuova connessione nel riquadro Connessioni. In caso contrario, fare clic sull'icona Aggiungi nuova connessione nella barra del titolo del riquadro.
  3. Nella scheda Impostazioni SQLTools fare clic sull'icona Databricks per selezionare un driver di database.
  4. Per il passaggio Impostazioni di connessione immettere le informazioni seguenti relative al magazzino, al catalogo e allo schema:

    1. In Nome connessione immettere un nome univoco per questa connessione.

    2. (Facoltativo) Per Gruppo di connessioni immettere il nome di un gruppo di connessione esistente per aggiungere la nuova connessione a tale gruppo. In alternativa, immettere un nome univoco per creare un nuovo gruppo di connessioni con la nuova connessione. I gruppi di connessioni semplificano la ricerca delle connessioni nell'estensione.

    3. Per Connetti con, selezionare una delle opzioni seguenti:

      • Per usare un token di accesso personale di Azure Databricks per l'autenticazione, selezionare Nome host e Token.
      • Per Databricks Driver per SQLTools versioni 0.4.2 e successive, per usare OAuth U2M o M2M o l'autenticazione dell'interfaccia della riga di comando di Azure, selezionare Estensione VS Code (beta).

    4. Se è stata selezionata l'opzione Nome host e Token per connetti usando, immettere l'impostazione Nome host server del warehouse. Per ottenere l'impostazione Nome host del server di un warehouse, vedere Ottenere i dettagli di connessione per una risorsa di calcolo di Azure Databricks.

    5. In Percorso immettere l'impostazione del percorso HTTP del warehouse o del cluster. Per ottenere l'impostazione del percorso HTTP di un warehouse, vedere Ottenere i dettagli della connessione per una risorsa di calcolo di Azure Databricks.

    6. Se è stato selezionato Nome host e Token per la connessione usando, immettere il valore del token di accesso personale di Azure Databricks in Token.

    7. Per Catalogo immettere il nome del catalogo.

      Nota

      Per le aree di lavoro non abilitate per Il catalogo Unity, è possibile lasciare vuoto Catalogo per usare il valore predefinito di hive_metastore.

    8. Per Schema immettere il nome dello schema.

    9. (Facoltativo) Per Mostra limite predefinito record lasciare il valore predefinito di 50 per visualizzare solo le prime 50 righe per ogni query o immettere un limite diverso.

  5. Fare clic su Verifica connessione.
  6. Se il test di connessione ha esito positivo, fare clic su Salva connessione.

Modificare le impostazioni di una connessione

Questa procedura presuppone che l'utente sia connesso correttamente ad almeno un magazzino.

  1. Se la visualizzazione SQLTools non è visibile, nella barra laterale in Visual Studio Code fare clic sull'icona SQLTools .
  2. Nel riquadro Connessioni espandere il gruppo di connessioni, se presente per la connessione di destinazione.
  3. Fare clic con il pulsante destro del mouse sulla connessione e scegliere Modifica connessione.
  4. Modificare le impostazioni di destinazione.
  5. Fare clic su Verifica connessione.
  6. Se il test di connessione ha esito positivo, fare clic su Salva connessione.

Esplorare gli oggetti di uno schema

  1. Nel riquadro Connessioni espandere il gruppo di connessioni, se presente per la connessione di destinazione.
  2. Fare doppio clic o espandere la connessione di destinazione per il magazzino.
  3. Espandere il database di destinazione (schema), se presente per la connessione.
  4. Espandere Tabelle o viste, se sono presenti una o più tabelle o viste per il database (schema).
  5. Espandere qualsiasi tabella o vista di destinazione per visualizzare le colonne della tabella o della vista.

Visualizzare le righe o lo schema per una tabella o vista

Con tabelle o viste espanse nel riquadro Connessioni , eseguire una delle operazioni seguenti:

  • Per visualizzare le righe della tabella o della vista, fare clic con il pulsante destro del mouse sulla tabella o sulla vista e scegliere Mostra record tabella o Mostra record di visualizzazione.
  • Per visualizzare lo schema della tabella o della vista, fare clic con il pulsante destro del mouse sulla tabella o sulla vista e scegliere Descrizione tabella o Visualizzazione descrizione.

Generare una query di inserimento per una tabella

  1. Posizionare il cursore in un editor esistente nella posizione in cui si desidera aggiungere la query di inserimento.
  2. Con le tabelle espanse nel riquadro Connessioni , fare clic con il pulsante destro del mouse sulla tabella e scegliere Genera query di inserimento. La definizione della query di inserimento viene aggiunta al punto di inserimento del cursore.

Creare ed eseguire una query

Questa procedura presuppone che l'utente sia connesso correttamente ad almeno un magazzino.

  1. Nel riquadro Connessioni espandere il gruppo di connessioni, se presente per la connessione di destinazione.
  2. Fare doppio clic o espandere la connessione di destinazione per il magazzino.
  3. Con la connessione selezionata, fare clic su Nuovo file SQL nella barra del titolo del riquadro Connessioni . Viene visualizzata una nuova scheda dell'editor.
  4. Immettere la query SQL nel nuovo editor.
  5. Per eseguire la query SQL, fare clic su Esegui sulla connessione attiva nell'editor. I risultati della query vengono visualizzati in una nuova scheda dell'editor.

Eseguire una query esistente

Questa procedura presuppone che l'utente sia connesso correttamente ad almeno un magazzino.

  1. Nel riquadro Connessioni espandere il gruppo di connessioni, se presente per la connessione di destinazione.
  2. Fare doppio clic o espandere la connessione di destinazione per il magazzino.
  3. Con la connessione selezionata, aprire qualsiasi file con l'estensione di file o .sqlselezionare qualsiasi gruppo di istruzioni SQL continue in qualsiasi editor aperto in precedenza.
  4. Per eseguire la query SQL da un file aperto .sql , con .sql il contenuto del file visualizzato nell'editor, fare clic su Esegui sulla connessione attiva nell'editor. I risultati della query vengono visualizzati in una nuova scheda dell'editor.
  5. Per eseguire un gruppo selezionato di istruzioni SQL continue in un editor aperto in precedenza, fare clic con il pulsante destro del mouse sulla selezione e quindi scegliere Esegui query selezionata. I risultati della query vengono visualizzati in una nuova scheda dell'editor.

Inviare i log di utilizzo a Databricks

Se si verificano problemi durante l'uso del driver Databricks per SQLTools, è possibile inviare i log di utilizzo e le informazioni correlate al supporto di Databricks eseguendo le operazioni seguenti:

  1. Installare l'estensione Databricks per Visual Studio Code nel computer di sviluppo locale.
  2. Attivare la registrazione controllando l'impostazione Logs: Enabled o su truedatabricks.logs.enabled , come descritto in Impostazioni per l'estensione Databricks per Visual Studio Code Assicurarsi di riavviare Visual Studio Code dopo aver attivato la registrazione.
  3. Tentare di riprodurre il problema.
  4. Dal riquadro comandi (visualizza > riquadro comandi dal menu principale), eseguire il comando Databricks: Apri log completi.
  5. Inviare i Databricks Logs.logfile , databricks-cli-logs.jsone sdk-and-extension-logs.json visualizzati al supporto di Databricks.
  6. Copiare anche il contenuto del terminale (Visualizza > terminale) nel contesto del problema e inviare il contenuto al supporto di Databricks.

La visualizzazione Output (Visualizza > output, Log di Databricks) mostra le informazioni troncate se Logs: Enabled è selezionato o databricks.logs.enabled è impostato su true. Per visualizzare altre informazioni, modificare le impostazioni seguenti, come descritto in Impostazioni per l'estensione Databricks per Visual Studio Code:

  • Log: lunghezza massima della matrice o databricks.logs.maxArrayLength
  • Log: lunghezza massima del campo o databricks.logs.maxFieldLength
  • Log: Profondità troncamento o databricks.logs.truncationDepth

Risorse aggiuntive