Sterownik Databricks dla SQLTools dla programu Visual Studio Code

Ważne

Ta funkcja jest dostępna w publicznej wersji zapoznawczej.

Sterownik Databricks Driver for 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.

Requirements

Aby można było użyć sterownika usługi Databricks dla narzędzi SQLTools, obszar roboczy usługi Azure Databricks i lokalny komputer deweloperski 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 jeden magazyn Databricks SQL .

    Uwaga

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

  • W przypadku obszarów roboczych, dla których włączono Unity Catalog, obszar roboczy musi zawierać co najmniej jeden katalog z co najmniej jednym schematem, zwaną formalnie bazą danych, w tym katalogu.

  • W przypadku obszarów roboczych, które nie są włączone dla Katalogu Unity, obszar roboczy musi zawierać co najmniej jeden schemat (wcześniej nazywany bazą danych).

Wymagania dotyczące lokalnego komputera programistycznego

Musisz mieć następujące elementy na lokalnej maszynie deweloperskiej:

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

  1. W programie Visual Studio Code kliknij pozycję Widok > 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 SQLTools. Pamiętaj, aby kliknąć wpis autorstwa Matheus Teixeira.

  4. Kliknij przycisk Zainstaluj.

Aby zainstalować sterownik Databricks Driver for SQLTools, przejdź do Databricks Driver for SQLTools, a następnie kliknij pozycję Zainstaluj lub:

  1. W programie Visual Studio Code kliknij pozycję Widok > 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 skonfigurować uwierzytelnianie dla sterownika Databricks dla narzędzia 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 Microsoft Entra ID.

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

Aby użyć sterownika usługi Databricks dla narzędzi SQLTools z uwierzytelnianiem za pomocą 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 Tworzenie osobistych tokenów dostępu dla użytkowników obszaru roboczego.

Uwierzytelnianie OAuth maszyna-maszyna (M2M) w usłudze Azure Databricks

Aby uwierzytelnić się za pomocą sterownika Databricks dla SQLTools, możesz użyć uwierzytelniania Azure Databricks OAuth maszyna-maszyna (M2M) w następujący sposób:

Uwaga

Uwierzytelnianie OAuth M2M w usłudze Azure Databricks jest dostępne w produkcie Databricks Driver for SQLTools w wersji 0.4.2 lub nowszej.

  1. Wykonaj kroki konfiguracji uwierzytelniania OAuth M2M. Zobacz uwierzytelnianie OAuth maszyna-maszyna (M2M).
  2. Utwórz profil konfiguracji usługi Azure Databricks przy użyciu ustawień konfiguracji uwierzytelniania OAuth M2M. Zobacz sekcję „Config” w uwierzytelnianiu OAuth typu machine-to-machine (M2M).
  3. Zainstaluj i otwórz rozszerzenie usługi Databricks dla programu Visual Studio Code na lokalnej maszynie dewelopera.
  4. W rozszerzeniu Databricks IDE kliknij przycisk Konfiguruj w panelu 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 obszaru roboczego usługi Azure Databricks, na przykład https://adb-1234567890123456.7.azuredatabricks.net, a następnie naciśnij Enter.
  6. Wybierz wpis profilu konfiguracji zgodny z tym, który utworzyłeś w kroku 2.
  7. Wykonaj instrukcje na ekranie w przeglądarce internetowej, aby dokończyć uwierzytelnianie przy użyciu konta Azure Databricks.

Uwierzytelnianie OAuth użytkownik–maszyna (U2M) w usłudze Azure Databricks

Możesz użyć usługi Azure Databricks uwierzytelnianie OAuth user-to-machine (U2M) do uwierzytelniania za pomocą sterownika Databricks dla 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 IDE kliknij przycisk Configure w panelu 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 przypisany do obszaru roboczego usługi Azure Databricks, na przykład https://adb-1234567890123456.7.azuredatabricks.net. Następnie naciśnij klawisz Enter.
  4. Wybierz OAuth (użytkownik na komputer).
  5. Wykonaj instrukcje na ekranie w przeglądarce internetowej, aby dokoń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

Możesz użyć Azure CLI do uwierzytelniania za pomocą sterownika Databricks dla SQLTools w następujący sposób:

Uwaga

Uwierzytelnianie za pomocą interfejsu wiersza polecenia platformy Azure ma status funkcji eksperymentalnej. Ta funkcja jest dostępna w Databricks Driver for SQLTools w wersji 0.4.2 lub nowszej.

  1. Zainstaluj Azure CLI na lokalnym komputerze deweloperskim, jeśli jeszcze tego nie zrobiono.
  2. Zainstaluj i otwórz rozszerzenie usługi Databricks dla programu Visual Studio Code na lokalnym komputerze programistycznym.
  3. W rozszerzeniu Databricks IDE kliknij przycisk Configure w panelu 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 przypisany do obszaru roboczego usługi Azure Databricks, na przykład https://adb-1234567890123456.7.azuredatabricks.net. Następnie naciśnij klawisz Enter.
  5. Wybierz Azure CLI.
  6. Postępuj zgodnie z monitami wyświetlanymi na ekranie, aby zakończyć uwierzytelnianie za pomocą interfejsu wiersza polecenia platformy Azure.

Łączenie ze schematem

  1. Na pasku bocznym programu Visual Studio Code kliknij ikonę SQLTools .

  2. W widoku SQLTools, jeśli po raz pierwszy używasz rozszerzenia SQLTools, kliknij Dodaj nowe połączenie w okienku Połączenia. W przeciwnym razie kliknij ikonę Dodaj nowe połączenie na pasku tytułu okienka.

  3. Na karcie ustawień SQLTools, w kroku Wybierz sterownik bazy danych, kliknij ikonę Databricks.

  4. W kroku Ustawienia połączenia wprowadź następujące informacje o magazynie, katalogu i schemacie:

    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 połączeń w rozszerzeniu.
    1. W obszarze Połącz przy użyciu wybierz jedną z następujących opcji:
      • Aby użyć osobistego tokenu dostępu usługi Azure Databricks do uwierzytelniania, wybierz pozycję Nazwa hosta i Token.
      • W wersji 0.4.2 lub nowszej sterownika Databricks dla SQLTools, aby użyć uwierzytelniania OAuth U2M lub M2M lub Azure CLI, wybierz pozycję rozszerzenie programu VS Code (beta).

    1. 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 uzyskać ustawienie nazwy hosta serwera magazynu danych, zobacz Pobieranie szczegółów połączenia dla zasobu obliczeniowego usługi Azure Databricks.

    2. W polu Ścieżka wprowadź ustawienie ścieżki HTTP magazynu lub klastra. Aby uzyskać ustawienia ścieżki HTTP dla magazynu, zobacz Pobieranie szczegółów połączenia dla zasobu obliczeniowego usługi Azure Databricks.

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

    4. W polu Catalogwprowadź nazwę katalogu.

      Uwaga

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

    5. W polu Schemawprowadź nazwę schematu.

    6. (Opcjonalnie) W przypadku Pokaż domyślny limit rekordówpozostaw wartość domyślną 50, aby wyświetlić tylko pierwsze 50 wierszy dla każdego zapytania lub wprowadź inny limit.

  5. Kliknij 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 udało Ci się pomyślnie nawiązać 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 Połączenia rozwiń grupę połączeń, jeśli taka istnieje dla połączenia docelowego.
  3. Kliknij prawym przyciskiem myszy połączenie, a następnie kliknij polecenie Edytuj połączenie.
  4. Zmień ustawienia celu.
  5. Kliknij Testuj połączenie.
  6. Jeśli test połączenia zakończy się pomyślnie, kliknij przycisk Zapisz połączenie.

Przeglądanie obiektów schematu

  1. W okienku Połączenia rozwiń grupę połączeń, jeśli taka istnieje dla połączenia docelowego.
  2. Kliknij dwukrotnie lub rozwiń połączenie docelowe dla Twojego magazynu danych.
  3. Rozwiń docelową bazę danych (schemat), jeśli istnieje dla twojego połączenia.
  4. Rozwiń tabelę lub widok, jeśli w Twojej bazie danych (schemacie) istnieje jedna lub więcej tabel albo widoków.
  5. Rozwiń dowolną tabelę docelową lub widok, aby wyświetlić kolumny tabeli lub widoku.

Wyświetlanie wierszy lub schematu dla tabeli lub widoku

Przy rozwiniętych tabelach lub widokach w okienku Połączenia wykonaj jedną z następujących czynności:

  • Aby wyświetlić wiersze tabeli lub widoku, kliknij prawym przyciskiem myszy tabelę lub widok, a następnie kliknij polecenie Pokaż rekordy tabeli lub Pokaż rekordy widoku.
  • Aby wyświetlić schemat tabeli lub widoku, kliknij prawym przyciskiem myszy tabelę lub widok, a następnie kliknij polecenie Opis tabeli lub Opis widoku.

Generowanie zapytania wstawiania dla tabeli

  1. Umieść kursor w istniejącym edytorze w miejscu, w którym ma zostać dodane zapytanie INSERT.
  2. Po rozwinięciu Tabele w okienku połączeń, kliknij prawym przyciskiem myszy tabelę, a następnie kliknij Wygeneruj zapytanie wstaw. Definicja zapytania wstawiającego jest dodawana w miejscu wstawienia kursora.

Tworzenie i uruchamianie zapytania

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

  1. W okienku Połączenia rozwiń grupę połączeń, jeśli taka 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 Połączenia . Pojawia się nowa karta edytora.
  4. Wprowadź zapytanie SQL w nowym edytorze.
  5. Aby uruchomić zapytanie SQL, kliknij przycisk Uruchom dla aktywnego połączenia w edytorze. Wyniki zapytania są wyświetlane na nowej karcie edytora.

Uruchom istniejące zapytanie

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

  1. W okienku Połączenia rozwiń grupę połączeń, jeśli taka 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 wybierz 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ę kolejnych instrukcji SQL w edytorze, który został wcześniej otwarty, kliknij prawym przyciskiem myszy zaznaczenie, a następnie kliknij polecenie Uruchom wybrane zapytanie. Wyniki zapytania są wyświetlane na nowej karcie edytora.

Wyślij dzienniki 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 lokalnym komputerze programistycznym.
  2. Włącz logowanie, zaznaczając ustawienie Logi: Włączone lub ustawiając databricks.logs.enabled na true, jak opisano w Ustawieniach rozszerzenia Databricks IDE. Pamiętaj, aby ponownie uruchomić Visual Studio Code po włączeniu logowania.
  3. Spróbuj odtworzyć zgłoszony problem.
  4. Z Palety poleceń (Widok > Paleta poleceń z menu głównego) uruchom polecenie Databricks: Open full logs.
  5. Wyślij pliki Databricks Logs.log, databricks-cli-logs.json i sdk-and-extension-logs.json, które się pojawiają, do pomocy technicznej Databricks.
  6. Skopiuj również zawartość terminalu (Widok > Terminal) w kontekście problemu i wyślij tę zawartość do pomocy technicznej usługi Databricks.

Widok danych wyjściowych (widokwidok danych wyjściowych >, dzienniki usługi Databricks) pokazuje obcięte informacje, jeśli dzienniki : włączone są zaznaczone lub databricks.logs.enabled jest ustawione na true. Aby pokazać więcej informacji, zmień następujące ustawienia, zgodnie z Ustawieniami dla rozszerzenia IDE Databricks:

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

Dodatkowe zasoby

  • Ostatnia aktualizacja o