Ovladač Databricks pro SQLTools pro Visual Studio Code

Důležité

Tato funkce je ve verzi Public 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.

Než začnete

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
• Požadavky místního vývojového počítače
• Authentication
  • Ověřování tokenu PAT služby Azure Databricks
  • Ověřování azure Databricks OAuth typu machine-to-machine (M2M)
  • Ověřování uživatelem a počítačem (U2M) Azure Databricks OAuth
  • Ověřování přes Azure CLI

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:

• Pracovní prostor musí obsahovat alespoň jeden Databricks SQL Warehouse.

  Poznámka:

  Clustery Azure Databricks nejsou podporovány ovladačem Databricks pro SQLTools.

• U pracovních prostorů, které jsou povolené pro katalogu Unity, musí pracovní prostor obsahovat alespoň jeden katalog s alespoň jedním schématem (formálně označovaným jako databáze) v rámci daného katalogu.

  • Prozkoumejte databázové objekty.
  • Vytvořit katalog.
  • Vytvoření schématu.

• U pracovních prostorů, které nejsou povolené pro katalog Unity, musí pracovní prostor obsahovat alespoň jedno schéma (dříve označované jako databáze).

  • Prozkoumejte databázové objekty.
  • Vytvoření schématu.

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 na Code > About Visual Studio Code z nabídky manin v Linuxu nebo macOS a nápovědy > k Windows. 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
• Ovladač Databricks pro rozšíření 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 zobrazit > rozšíření .

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

3. Klikněte na položku SQLTools z Matheus Teixeira.

   Poznámka:

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

4. Klikněte na Install (Nainstalovat).

Chcete-li nainstalovat rozšíření Databricks Driver for SQLTools, přejděte do ovladače Databricks pro 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 (Nainstalovat).

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:

• Ověřování tokenu PAT služby Azure Databricks
• Ověřování azure Databricks OAuth typu machine-to-machine (M2M)
• Ověřování uživatelem a počítačem (U2M) Azure Databricks OAuth
• Ověřování přes Azure CLI

Poznámka:

Ovladač Databricks pro SQLTools nepodporuje tokeny Microsoft Entra ID.

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

Pokud chcete použít ovladač Databricks pro SQLTools s ověřováním osobního přístupového tokenu Azure Databricks, musíte mít osobní přístupový token Azure Databricks. Pokud chcete vytvořit osobní přístupový token, postupujte podle kroků v osobních přístupových tokenech Azure Databricks 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 (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í OAuth typu machine-to-machine (M2M).
2. Vytvořte konfigurační profil Azure Databricks s nastavením konfigurace ověřování OAuth M2M. Viz část Konfigurace ověřování OAuth typu 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 pro Visual Studio Code klikněte v podokně Konfigurace na tlačítko Konfigurovat. Pokud se tlačítko Konfigurovat nezobrazí, klikněte místo toho na ikonu ozubeného kola (Konfigurovat pracovní prostor).
5. Do palety příkazů zadejte pro hostitele Databricks adresu URL azure Databricks pro jednotlivé pracovní prostory, například https://adb-1234567890123456.7.azuredatabricks.neta stiskněte Enter.
6. Vyberte položku konfiguračního profilu, která odpovídá položce, kterou jste vytvořili v kroku 2.
7. Dokončete pokyny na obrazovce ve webovém prohlížeči a dokončete ověřování pomocí účtu Azure Databricks.

Ověřování uživatelem a počítačem (U2M) Azure Databricks OAuth

K ověření pomocí ovladače Databricks pro SQLTools můžete použít ověřování uživatele a počítače (U2M) Azure Databricks pro SQLTools, 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 pro Visual Studio Code klikněte v podokně Konfigurace na tlačítko Konfigurovat. Pokud se tlačítko Konfigurovat nezobrazí, klikněte místo toho na ikonu ozubeného kola (Konfigurovat pracovní prostor).
3. Do palety Pak stiskněte klávesu Enter.
4. Vyberte OAuth (uživatel do počítače).
5. Dokončete pokyny 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 pro SQLTools, a to následujícím způsobem:

Poznámka:

Ověřování pomocí Azure CLI je ve stavu experimentální funkce. 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 pro Visual Studio Code klikněte v podokně Konfigurace na tlačítko Konfigurovat. Pokud se tlačítko Konfigurovat nezobrazí, klikněte místo toho na ikonu ozubeného kola (Konfigurovat pracovní prostor).
4. Do palety 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. Pokud používáte rozšíření SQLTool s poprvé, klikněte v zobrazení SQLTools na Přidat nové připojení v podokně 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 pole 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í.

   3. 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).

   4. Pokud jste pro připojení vybrali název hostitele a token, zadejte pro hostitele nastavení názvu hostitele skladu. Informace o nastavení názvu hostitele serveru skladu najdete v tématu Získání podrobností o připojení pro výpočetní prostředek Azure Databricks.

   5. Jako cestu zadejte nastavení cesty HTTP skladu nebo clusteru. Informace o nastavení cesty HTTP skladu najdete v tématu Získání podrobností o připojení k výpočetnímu prostředku Azure Databricks.

   6. Pokud jste pro připojení vybrali název hostitele a token, zadejte do tokenu hodnotu osobního přístupového tokenu Azure Databricks.

   7. 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.

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

   9. (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. Klepněte pravým tlačítkem myši na připojení a klepněte na příkaz Upravit připojení.
4. Změňte nastavení cíle.
5. Klikněte na Otestovat 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. Poklikejte 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 zobrazení.
• Pokud chcete zobrazit schéma tabulky nebo zobrazení, klikněte pravým tlačítkem myši na tabulku nebo zobrazení a klikněte na Popsat tabulku nebo Popis 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 vloženého dotazu se přidá do vkládacího bodu 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. Poklikejte 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 při aktivním připojení . Výsledky dotazu se zobrazí na nové kartě editoru.

Spuštění existujícího 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. Poklikejte 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 průběžný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.

Odesílání protokolů 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 na místní vývojový počítač.
2. Zapněte protokolování tak, že zkontrolujete nastavení: Povolené nastavení nebo nastavení databricks.logs.enabledtrue na , jak je popsáno v Nastavení rozšíření Databricks pro Visual Studio Code. Po zapnutí protokolování nezapomeňte Visual Studio Code restartovat.
3. Pokus o reprodukci vašeho problému
4. Z palety příkazů ( příkazů z hlavní nabídky) spusťte >.
5. Odešlete soubory Databricks Logs.logdatabricks-cli-logs.jsona sdk-and-extension-logs.json soubory, které se zobrazí podpoře Databricks.
6. Zkopírujte také obsah terminálu (> zobrazení) v kontextu problému 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. Pokud chcete zobrazit další informace, změňte následující nastavení, jak je popsáno v nastavení rozšíření Databricks pro Visual Studio Code:

• Protokoly: Maximální délka pole 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

• Dokumentace k SQLTools
• Ovladač Databricks pro SQLTools na GitHubu