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 wykazu aparatu Unity, obszar roboczy musi zawierać co najmniej jeden wykaz z co najmniej jednym schematem (formalnie nazywanym bazą danych) w tym wykazie.

  • W przypadku obszarów roboczych, które nie są włączone dla wykazu aparatu 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 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 skonfigurować uwierzytelnianie dla sterownika usługi 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 (dawniej Azure Active Directory).

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 następujące czynności:

  1. W obszarze roboczym usługi Azure Databricks kliknij nazwę użytkownika usługi Azure Databricks na górnym pasku, a następnie wybierz pozycję Ustawienia z listy rozwijanej.
  2. Kliknij pozycję Deweloper.
  3. Obok pozycji Tokeny dostępu kliknij pozycję Zarządzaj.
  4. Kliknij pozycję Generuj nowy token.
  5. (Opcjonalnie) Wprowadź komentarz, który pomaga zidentyfikować ten token w przyszłości i zmienić domyślny okres istnienia tokenu na 90 dni. Aby utworzyć token bez okresu istnienia (niezalecane), pozostaw puste pole Okres istnienia (dni) (puste).
  6. Kliknij pozycję Generate (Generuj).
  7. Skopiuj wyświetlony token do bezpiecznej lokalizacji, a następnie kliknij przycisk Gotowe.

Uwaga

Pamiętaj, aby zapisać skopiowany token w bezpiecznej lokalizacji. Nie udostępniaj skopiowanego tokenu innym osobom. W przypadku utraty skopiowanego tokenu nie można wygenerować tego samego tokenu. Zamiast tego należy powtórzyć tę procedurę, aby utworzyć nowy token. Jeśli utracisz skopiowany token lub uważasz, że token został naruszony, usługa Databricks zdecydowanie zaleca natychmiastowe usunięcie tego tokenu z obszaru roboczego, klikając ikonę kosza (Odwołaj) obok tokenu na stronie Tokeny dostępu.

Jeśli nie możesz utworzyć lub użyć tokenów w obszarze roboczym, może to być spowodowane tym, że administrator obszaru roboczego wyłączył tokeny lub nie udzielił Ci uprawnień do tworzenia lub używania tokenów. Zobacz administratora obszaru roboczego lub następujące elementy:

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 klawisz Enter.
  6. Wybierz wpis profilu konfiguracji zgodny z wpisem utworzonym 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. Wybierz pozycję OAuth (użytkownik do komputera).
  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. Wybierz pozycję Interfejs 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łączenie do schematu

  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 pozycję Dodaj nowy Połączenie ion w okienku Połączenie ions. W przeciwnym razie kliknij ikonę Dodaj nowy Połączenie ion na pasku tytułu okienka.
  3. Na karcie SQLTools Ustawienia w kroku Wybierz sterownik bazy danych kliknij ikonę Databricks.
  4. W kroku Połączenie ion Ustawienia wprowadź następujące informacje o magazynie, katalogu i schemacie:

    1. W polu nazwa Połączenie ion wprowadź unikatową nazwę dla tego połączenia.

    2. (Opcjonalnie) W przypadku grupy Połączenie ion 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łączenie ion ułatwiają znajdowanie połączeń w rozszerzeniu.

    3. W przypadku Połączenie użycia 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 przypadku sterownika usługi Databricks dla narzędzi SQLTools w wersji 0.4.2 lub nowszej, aby użyć uwierzytelniania OAuth U2M lub M2M lub interfejsu wiersza polecenia platformy Azure, wybierz pozycję Rozszerzenie programu VS Code (beta).

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

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

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

    7. W polu Wykaz wprowadź nazwę katalogu.

      Uwaga

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

    8. W polu Schemat wprowadź nazwę schematu.

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

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

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 Połączenie ions 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 ion.
  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 ion.

Przeglądanie obiektów schematu

  1. W okienku Połączenie ions 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 (schemat), jeśli istnieje dla twojego połączenia.
  4. Rozwiń węzeł Tabele lub widoki, jeśli dla bazy danych (schematu) istnieje co najmniej jedna tabela lub widoki.
  5. Rozwiń dowolną tabelę docelową lub widok, aby wyświetlić kolumny tabeli lub widoku.

Wyświetlanie wierszy lub schematu dla tabeli lub widoku

Po rozwinięciu tabel lub widoków w okienku Połączenie ions 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 Opisz tabelę lub Widok opisu.

Generowanie zapytania wstawiania dla tabeli

  1. Umieść kursor w istniejącym edytorze w lokalizacji, w której ma zostać dodane zapytanie wstawiania.
  2. Po rozwinięciu tabel w okienku Połączenie ions kliknij prawym przyciskiem myszy tabelę, a następnie kliknij polecenie Generuj zapytanie Wstaw. Definicja wstawiania zapytania wstawiania jest dodawana do punktu 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 Połączenie ions 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 Połączenie ions. 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 Połączenie ions 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 .sqlpliku lub 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ę 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 Ustawienia dla 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. W palecie poleceń (Wyświetl > paletę poleceń z menu głównego) uruchom polecenie Databricks: Otwórz pełne dzienniki.
  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 Dane wyjściowe (Wyświetl > dane wyjściowe, Dzienniki usługi Databricks) pokazuje obcięte informacje, jeśli dzienniki: włączone jest zaznaczone lub databricks.logs.enabled ustawiono wartość true. Aby wyświetlić więcej informacji, zmień następujące ustawienia zgodnie z opisem w Ustawienia dla 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