Ovladač Databricks pro SQLTools pro Visual Studio Code

Důležité

Tato funkce je ve fázi veřejné verze Preview.

Ovladač Databricks pro SQLTools umožňuje pomocí rozšíření SQLTools pro Visual Studio Code procházet objekty SQL a spouštět dotazy SQL ve vzdálených pracovních prostorech Azure Databricks.

Requirements

Než budete moct použít ovladač Databricks pro SQLTools, váš pracovní prostor Azure Databricks a místní vývojový počítač musí splňovat následující požadavky.

Požadavky na pracovní prostor

Musíte mít k dispozici alespoň jeden pracovní prostor Azure Databricks a pracovní prostor musí splňovat následující požadavky:

Požadavky místního vývojového počítače

Na místním počítači pro vývoj musíte mít následující:

  • Visual Studio Code verze 1.70 nebo vyšší Pokud chcete zobrazit nainstalovanou verzi, klikněte v hlavní nabídce v Linuxu nebo macOS na Code > O aplikaci Visual Studio Code a ve Windows na Nápověda > O aplikaci. Pokud chcete stáhnout, nainstalovat a nakonfigurovat Visual Studio Code, přečtěte si téma Nastavení editoru Visual Studio Code.
  • Rozšíření SQLTools pro Visual Studio Code
  • Rozšíření Databricks Driver for SQLTools pro Visual Studio Code.

Chcete-li nainstalovat rozšíření SQLTools, přejděte do nástroje SQLTools a klepněte na tlačítko Nainstalovat, nebo:

  1. V editoru Visual Studio Code klikněte v hlavní nabídce na Zobrazení > Rozšíření.

  2. Do pole Hledat rozšíření na Marketplace zadejte SQLTools.

  3. Klikněte na položku SQLTools od Matheuse Teixeiry.

    Poznámka

    Může se zobrazit několik položek SQLTools . Nezapomeňte kliknout na položku od Matheus Teixeira.

  4. Klikněte na Install.

Chcete-li nainstalovat rozšíření Databricks Driver for SQLTools, přejděte do Databricks Driver for SQLTools a klikněte na tlačítko Nainstalovat, nebo:

  1. V editoru Visual Studio Code klikněte v hlavní nabídce na Zobrazit > Rozšíření.
  2. Do pole Hledat rozšíření na Marketplace zadejte Databricks Driver for SQLTools.
  3. Klikněte na položku Ovladač Databricks pro SQLTools.
  4. Klikněte na Install.

Ověřování

Pro ovladač Databricks pro SQLTools musíte nastavit ověřování následujícím způsobem.

Ovladač Databricks pro SQLTools podporuje následující typy ověřování Azure Databricks:

Poznámka

Ovladač Databricks pro SQLTools nepodporuje tokeny Microsoft Entra ID.

Ověřování osobního přístupového tokenu Azure Databricks

Chcete-li použít ovladač Databricks pro SQLTools s ověřováním pomocí osobního přístupového tokenu Azure Databricks, musíte mít osobní přístupový token Azure Databricks. Chcete-li vytvořit osobní token pro přístup, postupujte podle pokynů v tématu Vytváření osobních tokenů pro uživatele pracovního prostoru.

Ověřování azure Databricks OAuth typu machine-to-machine (M2M)

K ověření pomocí ovladače Databricks pro SQLTools můžete použít ověřování Azure Databricks OAuth typu machine-to-machine (M2M), a to následujícím způsobem:

Poznámka

Ověřování Azure Databricks OAuth M2M je k dispozici v ovladači Databricks pro SQLTools verze 0.4.2 a vyšší.

  1. Dokončete kroky konfigurace pro ověřování OAuth M2M. Viz ověřování typu OAuth machine-to-machine (M2M).
  2. Vytvořte konfigurační profil Azure Databricks s nastavením konfigurace ověřování OAuth M2M. Viz sekci „Config“ v článku ověřování OAuth machine-to-machine (M2M).
  3. Nainstalujte a otevřete rozšíření Databricks pro Visual Studio Code na místním vývojovém počítači.
  4. V rozšíření Databricks IDE klikněte na tlačítko Configure v panelu Konfigurace . Pokud se tlačítko Konfigurovat nezobrazí, klikněte místo toho na ikonu ozubeného kola (Konfigurovat pracovní prostor).
  5. V Paletě příkazů pro Hostitel Databricks zadejte adresu URL Azure Databricks pro jednotlivé pracovní prostory, například https://adb-1234567890123456.7.azuredatabricks.net, a potom stiskněte Enter.
  6. Vyberte položku konfiguračního profilu, která odpovídá položce, kterou jste vytvořili v kroku 2.
  7. Postupujte podle pokynů na obrazovce ve webovém prohlížeči a dokončete ověřování pomocí účtu Azure Databricks.

Ověřování OAuth uživatel–počítač (U2M) v Azure Databricks

K ověření pomocí ovladače Databricks pro SQLTools můžete použít Azure Databricks ověřování OAuth uživatele k počítači (U2M), a to následujícím způsobem:

Poznámka

Ověřování Azure Databricks OAuth U2M je k dispozici v ovladači Databricks pro SQLTools verze 0.4.2 a vyšší.

  1. Nainstalujte a otevřete rozšíření Databricks pro Visual Studio Code na místním vývojovém počítači.
  2. V rozšíření Databricks IDE klikněte na tlačítko Configure v panelu Konfigurace . Pokud se tlačítko Konfigurovat nezobrazí, klikněte místo toho na ikonu ozubeného kola (Konfigurovat pracovní prostor).
  3. V Paletě příkazů do pole Databricks Host zadejte URL pro jednotlivý pracovní prostor služby Azure Databricks, například . Pak stiskněte klávesu Enter.
  4. Vyberte OAuth (uživatel do počítače).
  5. Postupujte podle pokynů na obrazovce ve webovém prohlížeči a dokončete ověřování pomocí účtu Azure Databricks. Pokud se zobrazí výzva, povolte all-apis přístup.

Ověřování Azure CLI

Azure CLI můžete použít k ověření pomocí ovladače Databricks Driver for SQLTools, a to následujícím způsobem:

Poznámka

Ověřování pomocí Azure CLI je ve stavu Experimentální. Tato funkce je dostupná v ovladači Databricks pro SQLTools verze 0.4.2 a vyšší.

  1. Pokud jste to ještě neudělali, nainstalujte azure CLI na místní vývojový počítač.
  2. Nainstalujte a otevřete rozšíření Databricks pro Visual Studio Code na místním vývojovém počítači.
  3. V rozšíření Databricks IDE klikněte na tlačítko Configure v panelu Konfigurace . Pokud se tlačítko Konfigurovat nezobrazí, klikněte místo toho na ikonu ozubeného kola (Konfigurovat pracovní prostor).
  4. V Příkazové paletě do pole Databricks Host zadejte adresu URL pro pracovní prostor služby Azure Databricks, například . Pak stiskněte klávesu Enter.
  5. Vyberte Azure CLI.
  6. Postupujte podle pokynů na obrazovce a dokončete ověřování pomocí Azure CLI.

Připojení ke schématu

  1. V editoru Visual Studio Code na bočním panelu klikněte na ikonu SQLTools.

  2. V zobrazení SQLTools, pokud rozšíření SQLTools používáte poprvé, klikněte v podokně Připojení na Přidat nové připojení. V opačném případě klikněte na ikonu Přidat nové připojení v záhlaví podokna.

  3. Na kartě nastavení SQLTools v kroku Vyberte ovladač databáze klikněte na ikonu Databricks.

  4. V kroku Nastavení připojení zadejte následující informace o vašem skladu, katalogu a schématu:

    1. Jako Název připojení zadejte jedinečný název tohoto připojení.
    2. (Volitelné) Do Skupina připojení zadejte název existující skupiny připojení pro přidání nového připojení k této skupině. Nebo zadejte jedinečný název pro vytvoření nové skupiny připojení s novým připojením. Skupiny připojení usnadňují hledání připojení v rozšíření.
    1. Pro připojení pomocí vyberte jednu z následujících možností:
      • Pokud chcete pro ověřování použít osobní přístupový token Azure Databricks, vyberte název hostitele a token.
      • Pokud chcete pro ovladač Databricks pro SQLTools verze 0.4.2 a vyšší použít ověřování OAuth U2M nebo M2M nebo Azure CLI, vyberte rozšíření VS Code (beta).

    1. Pokud jste pro připojení pomocí vybrali název hostitele a token, zadejte pro Host nastavení serverového názvu hostitele skladu. Pro získání nastavení hostname serveru datového skladu, viz Získání podrobností o připojení pro výpočetní prostředek Azure Databricks.

    2. Pro cesta zadejte nastavení HTTP cesty pro sklad nebo cluster. Chcete-li získat nastavení cesty HTTP skladu, podívejte se na Získání podrobností o připojení pro výpočetní prostředek Azure Databricks.

    3. Pokud jste pro Připojit pomocí vybrali Název hostitele a token, zadejte hodnotu osobního přístupového tokenu Azure Databricks do pole Token.

    4. Do katalogzadejte název katalogu.

      Poznámka

      U pracovních prostorů, které nejsou povoleny pro katalog Unity, můžete ponechat Katalog prázdné, pokud chcete použít výchozí hodnotu hive_metastore.

    5. Pro schéma zadejte název svého schématu.

    6. (Volitelné) Pro možnost Nastavit výchozí limit záznamů, ponechte výchozí hodnotu 50 k zobrazení pouze prvních 50 řádků pro každý dotaz nebo zadejte jiný limit.

  5. Klikněte na Otestovat připojení.

  6. Pokud test připojení proběhne úspěšně, klikněte na uložit připojení.

Změna nastavení připojení

Tento postup předpokládá, že jste se úspěšně připojili k alespoň jednomu skladu.

  1. Pokud zobrazení SQLTools není viditelné, klikněte v nástroji Visual Studio Code na bočním panelu na ikonu SQLTools.
  2. V podokně Připojení rozbalte skupinu připojení, pokud pro cílové připojení existuje.
  3. Klikněte pravým tlačítkem myši na připojení a klikněte na Upravit připojení.
  4. Změňte nastavení cíle.
  5. Klikněte na Test připojení.
  6. Pokud test připojení proběhne úspěšně, klikněte na uložit připojení.

Procházení objektů schématu

  1. V podokně Připojení rozbalte skupinu připojení, pokud pro cílové připojení existuje.
  2. Dvakrát klikněte nebo rozbalte cílové připojení pro váš sklad.
  3. Rozbalte cílovou databázi (schéma), pokud existuje pro vaše připojení.
  4. Rozbalte tabulky nebo zobrazení, pokud pro databázi (schéma) existuje jedna nebo více tabulek nebo zobrazení.
  5. Rozbalením libovolné cílové tabulky nebo zobrazení zobrazíte sloupce tabulky nebo zobrazení.

Zobrazit řádky nebo schéma pro tabulku nebo databázové zobrazení.

Když rozbalíte tabulky nebo zobrazení v podokně Připojení, proveďte jednu z následujících akcí:

  • Pokud chcete zobrazit řádky tabulky nebo zobrazení, klikněte pravým tlačítkem myši na tabulku nebo zobrazení a klikněte na Zobrazit záznamy tabulky nebo Zobrazit záznamy.
  • Pokud chcete zobrazit schéma tabulky nebo zobrazení, klikněte pravým tlačítkem myši na tabulku nebo zobrazení a klikněte na popis tabulky nebo zobrazení.

Vygenerujte příkaz INSERT pro tabulku

  1. Umístěte kurzor do existujícího editoru na místo, kam chcete vložit dotaz.
  2. Když jsou Tabulky rozbaleny v podokně Připojení, klikněte pravým tlačítkem na tabulku a zvolte možnost Vygenerovat dotaz na vložení. Definice dotazu pro vložení se přidá na místo vložení kurzoru.

Vytvoření a spuštění dotazu

Tento postup předpokládá, že jste se úspěšně připojili k alespoň jednomu skladu.

  1. V podokně Připojení rozbalte skupinu připojení, pokud pro cílové připojení existuje.
  2. Dvakrát klikněte nebo rozbalte cílové připojení pro váš sklad.
  3. Pokud je vybrané připojení, klikněte na Nový soubor SQL v záhlaví podokna Připojení . Zobrazí se nová karta editoru.
  4. Zadejte dotaz SQL v novém editoru.
  5. Pokud chcete spustit dotaz SQL, klikněte v editoru na Spustit v aktivním připojení. Výsledky dotazu se zobrazí na nové kartě editoru.

Spustit existující dotaz

Tento postup předpokládá, že jste se úspěšně připojili k alespoň jednomu skladu.

  1. V podokně Připojení rozbalte skupinu připojení, pokud pro cílové připojení existuje.
  2. Poklepejte nebo rozbalte cílové připojení pro váš sklad.
  3. Při vybraném připojení otevřete libovolný soubor s příponou .sqlnebo vyberte libovolnou skupinu průběžných příkazů SQL v libovolném editoru, který byl dříve otevřen.
  4. Pokud chcete spustit dotaz SQL z otevřeného .sql souboru s obsahem souboru .sql zobrazeným v editoru, klikněte v editoru na Spustit při aktivním připojení v editoru. Výsledky dotazu se zobrazí na nové kartě editoru.
  5. Chcete-li spustit vybranou skupinu nepřetržitých příkazů SQL v editoru, který byl dříve otevřen, klikněte pravým tlačítkem myši na výběr a potom klikněte na příkaz Spustit vybraný dotaz. Výsledky dotazu se zobrazí na nové kartě editoru.

Odeslat protokoly využití do Databricks

Pokud při používání ovladače Databricks pro SQLTools narazíte na problémy, můžete odeslat protokoly využití a související informace podpoře Databricks následujícím způsobem:

  1. Nainstalujte rozšíření Databricks pro Visual Studio Code do svého místního vývojového počítače.
  2. Zapněte logování tím, že zkontrolujete nastavení Logs: Enabled nebo nastavíte databricks.logs.enabled na true, jak je popsáno v Nastavení pro rozšíření Databricks IDE. Po zapnutí logování nezapomeňte restartovat Visual Studio Code.
  3. Pokuste se reprodukovat váš problém.
  4. Z Palety příkazů (Zobrazit > Paleta příkazů z hlavní nabídky) spusťte příkaz Databricks: Open full logs.
  5. Odešlete soubory Databricks Logs.log, databricks-cli-logs.json a sdk-and-extension-logs.json, které se zobrazí, podpoře Databricks.
  6. Zkopírujte také obsah terminálu (Zobrazení > Terminál) v souvislosti s daným problémem a odešlete tento obsah podpoře Databricks.

Zobrazení výstupu (Zobrazení > Výstup, protokoly Databricks) zobrazují zkrácené informace, pokud protokoly: Je zaškrtnuté povolené nebo je databricks.logs.enabled nastavena na true. Pro více informací změňte následující nastavení, jak je popsáno v Nastavení pro rozšíření Databricks IDE:

  • Protokoly: Pole: maximální délka nebo databricks.logs.maxArrayLength
  • Protokoly: Maximální délka pole nebo databricks.logs.maxFieldLength
  • Protokoly: Hloubka zkrácení nebo databricks.logs.truncationDepth

Další materiály

  • Poslední aktualizace v