Udostępnij za pośrednictwem

Sterownik usługi Databricks dla narzędzi SQLTools dla programu Visual Studio Code

  • Artykuł

Ważne

Ta funkcja jest dostępna w publicznej wersji zapoznawczej.

Sterownik usługi Databricks dla narzędzi SQLTools umożliwia używanie rozszerzenia SQLTools dla programu Visual Studio Code do przeglądania obiektów SQL i uruchamiania zapytań SQL w zdalnych obszarach roboczych usługi Azure Databricks.

Zanim rozpoczniesz

Aby można było użyć sterownika usługi Databricks dla narzędzi SQLTools, obszar roboczy usługi Azure Databricks i lokalny komputer deweloperzy muszą spełniać następujące wymagania.

Wymagania dotyczące obszaru roboczego

Musisz mieć dostępny co najmniej jeden obszar roboczy usługi Azure Databricks, a obszar roboczy musi spełniać następujące wymagania:

  • Obszar roboczy musi zawierać co najmniej jedną usługę Databricks SQL Warehouse.

    Uwaga

    Klastry usługi Azure Databricks nie są obsługiwane przez sterownik usługi Databricks dla narzędzi SQLTools.

  • W przypadku obszarów roboczych, które są włączone dla Unity Catalog, obszar roboczy musi zawierać co najmniej jeden catalog, z co najmniej jednym schema (formalnie nazywanym bazą danych) w ramach tego catalog.

  • W przypadku obszarów roboczych, które nie są włączone dla Unity Catalog, obszar roboczy musi zawierać co najmniej jedną schema (wcześniej nazywaną bazą danych).

Wymagania dotyczące lokalnego komputera programistycznego

Musisz mieć następujące elementy na lokalnej maszynie deweloperów:

Aby zainstalować rozszerzenie SQLTools, przejdź do pozycji SQLTools , a następnie kliknij pozycję Zainstaluj lub:

  1. W programie Visual Studio Code kliknij pozycję Wyświetl > rozszerzenia w menu głównym.

  2. W polu Wyszukaj rozszerzenia w witrynie Marketplace wprowadź ciąg SQLTools.

  3. Kliknij wpis SQLTools z Matheus Teixeira.

    Uwaga

    Na liście może znajdować się wiele wpisów narzędzia SQLTools . Pamiętaj, aby kliknąć wpis z Matheus Teixeira.

  4. Kliknij przycisk Zainstaluj.

Aby zainstalować sterownik usługi Databricks dla rozszerzenia SQLTools, przejdź do pozycji Sterownik usługi Databricks dla narzędzi SQLTools , a następnie kliknij pozycję Zainstaluj lub:

  1. W programie Visual Studio Code kliknij pozycję Wyświetl > rozszerzenia w menu głównym.
  2. W polu Wyszukaj rozszerzenia w witrynie Marketplace wprowadź ciąg Databricks Driver for SQLTools.
  3. Kliknij wpis Sterownik usługi Databricks dla narzędzia SQLTools.
  4. Kliknij przycisk Zainstaluj.

Uwierzytelnianie

Należy set uwierzytelnienie dla sterownika usługi Databricks dla narzędzi SQLTools w następujący sposób.

Sterownik usługi Databricks dla narzędzi SQLTools obsługuje następujące typy uwierzytelniania usługi Azure Databricks:

Uwaga

Sterownik usługi Databricks dla narzędzi SQLTools nie obsługuje tokenów identyfikatora Entra firmy Microsoft.

Uwierzytelnianie osobistego tokenu dostępu w usłudze Azure Databricks

Aby użyć sterownika usługi Databricks dla narzędzi SQLTools z uwierzytelnianiem osobistego tokenu dostępu usługi Azure Databricks, musisz mieć osobisty token dostępu usługi Azure Databricks. Aby utworzyć osobisty token dostępu, wykonaj kroki opisane w artykule Osobiste tokeny dostępu usługi Azure Databricks dla użytkowników obszaru roboczego.

Uwierzytelnianie maszyny do komputera (M2M) w usłudze Azure Databricks

Aby uwierzytelnić się za pomocą sterownika databricks dla narzędzi SQLTools, możesz użyć uwierzytelniania maszyny do komputera (M2M) usługi Azure Databricks:

Uwaga

Uwierzytelnianie OAuth M2M w usłudze Azure Databricks jest dostępne w sterowniku usługi Databricks dla narzędzi SQLTools w wersji 0.4.2 lub nowszej.

  1. Wykonaj kroki konfiguracji uwierzytelniania OAuth M2M. Zobacz Uwierzytelnianie maszyny do maszyny (M2M) protokołu OAuth.
  2. Utwórz profil konfiguracji usługi Azure Databricks przy użyciu ustawień konfiguracji uwierzytelniania OAuth M2M. Zobacz sekcję "Konfiguracja" uwierzytelniania maszyny do maszyny OAuth (M2M).
  3. Zainstaluj i otwórz rozszerzenie usługi Databricks dla programu Visual Studio Code na lokalnej maszynie dewelopera.
  4. W rozszerzeniu Databricks dla programu Visual Studio Code kliknij przycisk Konfiguruj w okienku Konfiguracja . Jeśli przycisk Konfiguruj nie jest wyświetlany, kliknij ikonę koła zębatego (Konfiguruj obszar roboczy).
  5. W palecie poleceń w polu Host usługi Databricks wprowadź adres URL usługi Azure Databricks dla każdego obszaru roboczego, na przykład https://adb-1234567890123456.7.azuredatabricks.net, a następnie naciśnij Enter.
  6. Select wpis profilu konfiguracji, który odpowiada temu, który utworzyłeś w kroku 2.
  7. Wykonaj instrukcje na ekranie w przeglądarce internetowej, aby zakończyć uwierzytelnianie przy użyciu konta usługi Azure Databricks.

Uwierzytelnianie użytkownika do komputera (U2M) w usłudze Azure Databricks

Uwierzytelnianie użytkownika do komputera (U2M) usługi Azure Databricks umożliwia uwierzytelnianie za pomocą sterownika usługi Databricks dla narzędzi SQLTools w następujący sposób:

Uwaga

Uwierzytelnianie U2M protokołu OAuth w usłudze Azure Databricks jest dostępne w sterowniku usługi Databricks dla narzędzi SQLTools w wersji 0.4.2 lub nowszej.

  1. Zainstaluj i otwórz rozszerzenie usługi Databricks dla programu Visual Studio Code na lokalnej maszynie dewelopera.
  2. W rozszerzeniu Databricks dla programu Visual Studio Code kliknij przycisk Konfiguruj w okienku Konfiguracja . Jeśli przycisk Konfiguruj nie jest wyświetlany, kliknij ikonę koła zębatego (Konfiguruj obszar roboczy).
  3. W palecie poleceń w polu Host usługi Databricks wprowadź adres URL usługi Azure Databricks dla obszaru roboczego, na przykład https://adb-1234567890123456.7.azuredatabricks.net. Następnie naciśnij klawisz Enter.
  4. Select OAuth (użytkownik na komputer).
  5. Wykonaj instrukcje na ekranie w przeglądarce internetowej, aby zakończyć uwierzytelnianie przy użyciu konta usługi Azure Databricks. Jeśli zostanie wyświetlony monit, zezwól na all-apis dostęp.

Uwierzytelnianie interfejsu wiersza polecenia platformy Azure

Interfejs wiersza polecenia platformy Azure umożliwia uwierzytelnianie za pomocą sterownika usługi Databricks dla narzędzi SQLTools w następujący sposób:

Uwaga

Uwierzytelnianie za pomocą interfejsu wiersza polecenia platformy Azure jest w stanie funkcji eksperymentalnej. Ta funkcja jest dostępna w sterowniku usługi Databricks dla narzędzi SQLTools w wersji 0.4.2 lub nowszej.

  1. Zainstaluj interfejs wiersza polecenia platformy Azure na lokalnej maszynie dewelopera, jeśli jeszcze tego nie zrobiono.
  2. Zainstaluj i otwórz rozszerzenie usługi Databricks dla programu Visual Studio Code na lokalnej maszynie dewelopera.
  3. W rozszerzeniu Databricks dla programu Visual Studio Code kliknij przycisk Konfiguruj w okienku Konfiguracja . Jeśli przycisk Konfiguruj nie jest wyświetlany, kliknij ikonę koła zębatego (Konfiguruj obszar roboczy).
  4. W palecie poleceń w polu Host usługi Databricks wprowadź adres URL usługi Azure Databricks dla obszaru roboczego, na przykład https://adb-1234567890123456.7.azuredatabricks.net. Następnie naciśnij klawisz Enter.
  5. Select interfejsu wiersza polecenia platformy Azure.
  6. Postępuj zgodnie z monitami wyświetlanymi na ekranie, aby zakończyć uwierzytelnianie za pomocą interfejsu wiersza polecenia platformy Azure.

Połącz się z schema

  1. Na pasku bocznym programu Visual Studio Code kliknij ikonę SQLTools .
  2. Jeśli po raz pierwszy używasz rozszerzenia SQLTools, w widoku SQLTools kliknij Dodaj nowe połączenie w panelu Connections. W przeciwnym razie kliknij ikonę Dodaj nowe połączenie na pasku tytułu okienka.
  3. Na karcie ustawienia SQLTools kliknij kroku sterownika bazy danych kliknij ikonę usługi Databricks.
  4. W kroku ustawienia połączenia wprowadź następujące informacje o magazynie, i :

    1. W polu Nazwa połączenia wprowadź unikatową nazwę dla tego połączenia.

    2. (Opcjonalnie) W polu Grupa połączeń wprowadź nazwę istniejącej grupy połączeń, aby dodać nowe połączenie do tej grupy. Możesz też wprowadzić unikatową nazwę, aby utworzyć nową grupę połączeń przy użyciu nowego połączenia. Grupy połączeń ułatwiają znajdowanie connections w rozszerzeniu.

    3. Dla Connect użyj, select wybierz jedną z następujących opcji:

      • Aby użyć osobistego tokenu dostępu usługi Azure Databricks do uwierzytelniania, selectnazwa hosta i token.
      • W przypadku sterownika Databricks dla SQLTools w wersji 0.4.2 lub nowszej, aby skorzystać z uwierzytelniania OAuth U2M, M2M lub za pomocą interfejsu wiersza polecenia Azure CLI, selectrozszerzenie VS Code (beta).

    4. Jeśli wybrano opcję Nazwa hosta i Token dla opcji Połącz przy użyciu, w polu Host wprowadź ustawienie Nazwa hosta serwera magazynu. Aby get ustawienie nazwy hosta serwera server magazynu, zobacz Get szczegóły połączenia dla zasobu obliczeniowego usługi Azure Databricks.

    5. W polu Ścieżka wprowadź ustawienie ścieżki HTTP magazynu lub klastra. Aby get ustawienie ścieżki HTTP magazynu, zobacz Get szczegóły połączenia dla zasobu obliczeniowego usługi Azure Databricks.

    6. Jeśli wybrano opcję Nazwa hosta i Token dla opcji Połącz przy użyciu, wprowadź wartość osobistego tokenu dostępu usługi Azure Databricks w polu Token (Token).

    7. W Catalogwprowadź nazwę swojego catalog.

      Uwaga

      W przypadku obszarów roboczych, które nie są włączone dla modułu CatalogUnity, możesz pozostawić Catalog puste, aby użyć wartości domyślnej hive_metastore.

    8. W polu Schemawprowadź nazwę swojego schema.

    9. (Opcjonalnie) W przypadku Pokaż rekordy domyślne limitpozostaw wartość domyślną 50, aby wyświetlić tylko pierwsze 50 wierszy dla każdego zapytania lub wprowadź inną limit.

  5. Kliknij pozycję Testuj połączenie.
  6. Jeśli test połączenia zakończy się pomyślnie, kliknij przycisk Zapisz połączenie.

Zmienianie ustawień połączenia

W tej procedurze przyjęto założenie, że pomyślnie nawiązaliśmy połączenie z co najmniej jednym magazynem.

  1. Jeśli widok SQLTools nie jest widoczny, na pasku bocznym programu Visual Studio Code kliknij ikonę SQLTools .
  2. W okienku Connections rozwiń grupę połączeń, jeśli istnieje dla połączenia docelowego.
  3. Kliknij prawym przyciskiem myszy połączenie, a następnie kliknij polecenie Edytuj połączenie.
  4. Zmień ustawienia docelowe.
  5. Kliknij pozycję Testuj połączenie.
  6. Jeśli test połączenia zakończy się pomyślnie, kliknij przycisk Zapisz połączenie.

Przeglądaj obiekty schema

  1. W okienku Connections rozwiń grupę połączeń, jeśli istnieje dla połączenia docelowego.
  2. Kliknij dwukrotnie lub rozwiń połączenie docelowe dla magazynu.
  3. Rozwiń docelową bazę danych (schema), jeśli istnieje dla twojego połączenia.
  4. Rozwiń węzeł Tables lub Views, jeśli istnieje przynajmniej jeden tables lub views dla bazy danych (schema).
  5. Rozwiń dowolny widok table lub widoku, aby wyświetlić columnstablelub columnswidoku.

Wyświetlanie wierszy lub schema dla table lub widoku

Po rozwinięciu Tables lub Views w okienku Connections wykonaj jedną z następujących czynności:

  • Aby wyświetlić wiersze tablelub widoku, kliknij prawym przyciskiem myszy table lub widok, a następnie kliknij Pokaż rekordy Table lub Pokaż rekordy widoku.
  • Aby wyświetlić tableschemalub #B2 widoku, kliknij prawym przyciskiem myszy table lub widok, a następnie kliknij Opisz Table lub Opisz widok.

Generate zapytanie insert dla table

  1. Umieść kursor w istniejącym edytorze w lokalizacji where, gdzie chcesz dodać zapytanie insert.
  2. Po rozwinięciu Tables w okienku Connections, kliknij prawym przyciskiem myszy table, a następnie kliknij GenerateInsert Zapytanie. Definicja zapytania insert jest dodawana w punkcie wstawiania kursora.

Tworzenie i uruchamianie zapytania

W tej procedurze przyjęto założenie, że pomyślnie nawiązaliśmy połączenie z co najmniej jednym magazynem.

  1. W okienku Connections rozwiń grupę połączeń, jeśli istnieje dla połączenia docelowego.
  2. Kliknij dwukrotnie lub rozwiń połączenie docelowe dla magazynu.
  3. Po wybraniu połączenia kliknij pozycję Nowy plik SQL na pasku tytułu okienka Connections. Zostanie wyświetlona nowa karta edytora.
  4. Wprowadź zapytanie SQL w nowym edytorze.
  5. Aby uruchomić zapytanie SQL, kliknij przycisk Uruchom przy aktywnym połączeniu w edytorze. Wyniki zapytania są wyświetlane na nowej karcie edytora.

Uruchamianie istniejącego zapytania

W tej procedurze przyjęto założenie, że pomyślnie nawiązaliśmy połączenie z co najmniej jednym magazynem.

  1. W okienku Connections rozwiń grupę połączeń, jeśli istnieje dla połączenia docelowego.
  2. Kliknij dwukrotnie lub rozwiń połączenie docelowe dla magazynu.
  3. Po wybraniu połączenia otwórz dowolny plik z rozszerzeniem pliku .sqllub select dowolną grupę ciągłych instrukcji SQL w dowolnym edytorze, który został wcześniej otwarty.
  4. Aby uruchomić zapytanie SQL z otwartego .sql pliku, z .sql zawartością pliku wyświetlaną w edytorze, kliknij przycisk Uruchom przy aktywnym połączeniu w edytorze. Wyniki zapytania są wyświetlane na nowej karcie edytora.
  5. Aby uruchomić wybraną grupę ciągłych instrukcji SQL w edytorze, który został wcześniej otwarty, kliknij prawym przyciskiem myszy wybór, a następnie kliknij polecenie Uruchom wybrane zapytanie. Wyniki zapytania są wyświetlane na nowej karcie edytora.

Wysyłanie dzienników użycia do usługi Databricks

Jeśli wystąpią problemy podczas korzystania ze sterownika usługi Databricks dla narzędzi SQLTools, możesz wysłać dzienniki użycia i powiązane informacje do pomocy technicznej usługi Databricks, wykonując następujące czynności:

  1. Zainstaluj rozszerzenie Databricks dla programu Visual Studio Code na lokalnej maszynie dewelopera.
  2. Włącz rejestrowanie, sprawdzając ustawienie Dzienniki: włączone lub ustawienie databricks.logs.enabled na true, zgodnie z opisem w temacie Ustawienia rozszerzenia usługi Databricks dla programu Visual Studio Code Pamiętaj, aby ponownie uruchomić program Visual Studio Code po włączeniu rejestrowania.
  3. Spróbuj odtworzyć problem.
  4. poleceń z menu głównego) uruchom >.
  5. Databricks Logs.logWyślij pliki , databricks-cli-logs.jsonisdk-and-extension-logs.json, które są wyświetlane do pomocy technicznej usługi Databricks.
  6. Skopiuj również zawartość terminalu (wyświetl > terminal) w kontekście problemu i wyślij tę zawartość do pomocy technicznej usługi Databricks.

Widok danych wyjściowych (widok danych wyjściowych, dzienniki usługi Databricks) pokazuje obcięte informacje, jeśli dzienniki : włączona jest zaznaczona lub jest . Aby wyświetlić więcej informacji, zmień następujące ustawienia zgodnie z opisem w temacie Ustawienia rozszerzenia usługi Databricks dla programu Visual Studio Code:

  • Dzienniki: maksymalna długość tablicy lub databricks.logs.maxArrayLength
  • Dzienniki: maksymalna długość pola lub databricks.logs.maxFieldLength
  • Dzienniki: głębokość obcinania lub databricks.logs.truncationDepth

Dodatkowe zasoby