Tworzenie rozszerzenia pulpitu nawigacyjnego usługi Azure Data Studio

W tym samouczku pokazano, jak utworzyć nowe rozszerzenie pulpitu nawigacyjnego usługi Azure Data Studio. Rozszerzenie współtworzy pulpit nawigacyjny połączenia usługi Azure Data Studio, dzięki czemu można rozszerzyć funkcjonalność narzędzia Azure Data Studio w sposób łatwo widoczny dla użytkowników.

W tym artykule omówiono sposób wykonywania następujących zadań:

• Zainstaluj generator rozszerzeń.
• Utwórz rozszerzenie.
• Współtworzenie pulpitu nawigacyjnego w rozszerzeniu.
• Przetestuj rozszerzenie.
• Spakuj rozszerzenie.
• Opublikuj rozszerzenie na platformie handlowej.

Wymagania wstępne

Narzędzie Azure Data Studio jest oparte na tej samej strukturze co program Visual Studio Code, więc rozszerzenia dla programu Azure Data Studio są kompilowane przy użyciu programu Visual Studio Code. Do rozpoczęcia pracy potrzebne są następujące składniki:

• Node.js zainstalowane i dostępne w pliku $PATH. Node.js obejmuje narzędzie npm, Node.js Menedżer pakietów, które służy do instalowania generatora rozszerzeń.
• Program Visual Studio Code do debugowania rozszerzenia.
• Rozszerzenie debugowania usługi Azure Data Studio (opcjonalnie). Rozszerzenie Debug umożliwia przetestowanie rozszerzenia bez konieczności tworzenia pakietów i instalowania go w narzędziu Azure Data Studio.
• Upewnij się, że znajduje się azuredatastudio w ścieżce. W przypadku systemu Windows upewnij się, że w setup.exe wybrano opcję Dodaj do ścieżki . W przypadku komputerów Mac lub Linux uruchom polecenie Zainstaluj "azuredatastudio" w ścieżce PATH z palety poleceń w narzędziu Azure Data Studio.

Instalowanie generatora rozszerzeń

Aby uprościć proces tworzenia rozszerzeń, utworzyliśmy generator rozszerzeń przy użyciu narzędzia Yeoman. Aby go zainstalować, uruchom następujące polecenie w wierszu polecenia:

npm install -g yo generator-azuredatastudio

Tworzenie rozszerzenia pulpitu nawigacyjnego

Wprowadzenie do pulpitu nawigacyjnego

Pulpit nawigacyjny połączenia usługi Azure Data Studio to zaawansowane narzędzie, które podsumowuje i zapewnia wgląd w połączenia użytkownika.

Istnieją dwie odmiany pulpitu nawigacyjnego. Pulpit nawigacyjny serwera zawiera podsumowanie całego serwera, a pulpit nawigacyjny bazy danych zawiera podsumowanie pojedynczej bazy danych. Dostęp do pulpitu nawigacyjnego można uzyskać, klikając prawym przyciskiem myszy serwer lub bazę danych w widoku Połączenia narzędzia Azure Data Studio i wybierając polecenie Zarządzaj.

Istnieją trzy kluczowe punkty współtworzenia rozszerzeń w celu dodania funkcji do pulpitu nawigacyjnego:

1. Karta Pełny pulpit nawigacyjny: oddzielna karta na pulpicie nawigacyjnym dla rozszerzenia. Można dodać do pulpitu nawigacyjnego serwera lub bazy danych. Możliwość dostosowywania za pomocą widżetów, paska narzędzi i sekcji nawigacji.

2. Akcje strony głównej: przyciski akcji w górnej części paska narzędzi połączenia.

3. Widżety: wykresy uruchamiane względem programu SQL Server.

   

Uruchamianie generatora rozszerzeń

Aby utworzyć rozszerzenie:

1. Uruchom generator rozszerzeń za pomocą następującego polecenia:

   yo azuredatastudio

2. Wybierz pozycję Nowy pulpit nawigacyjny z listy typów rozszerzeń.

3. Wypełnij monity, jak pokazano, aby utworzyć rozszerzenie, które współtworzy kartę na pulpicie nawigacyjnym serwera.

   

   Istnieje wiele monitów, więc oto trochę więcej informacji na temat tego, co oznacza każde pytanie:

   

Wykonanie poprzednich kroków powoduje utworzenie nowego folderu. Otwórz folder w programie Visual Studio Code i możesz utworzyć własne rozszerzenie pulpitu nawigacyjnego.

Uruchamianie rozszerzenia

Zobaczmy, co daje szablon pulpitu nawigacyjnego, uruchamiając rozszerzenie. Przed uruchomieniem upewnij się, że rozszerzenie Azure Data Studio Debug jest zainstalowane w programie Visual Studio Code.

Wybierz pozycję F5 w programie Visual Studio Code, aby uruchomić narzędzie Azure Data Studio w trybie debugowania z uruchomionym rozszerzeniem. Następnie możesz zobaczyć, jak ten szablon domyślny współtworzy pulpit nawigacyjny.

Następnie przyjrzymy się, jak zmodyfikować ten domyślny pulpit nawigacyjny.

Opracowywanie pulpitu nawigacyjnego

Najważniejszym plikiem, który należy rozpocząć pracę z programowaniem rozszerzeń, jest package.json. Ten plik jest plikiem manifestu, w którym są rejestrowane współtworzenie pulpitu nawigacyjnego. Zwróć uwagę na dashboard.tabssekcje , dashboard.insightsi dashboard.containers .

Oto kilka zmian, które należy wypróbować:

• Zapoznaj się z typami szczegółowych informacji, które obejmują pasek, poziomy pasek i timeSeries.
• Napisz własne zapytania, które będą uruchamiane względem połączenia z programem SQL Server.
• Zapoznaj się z tym przykładowym samouczkiem szczegółowych informacji lub tym samouczkiem , aby uzyskać szczegółowe informacje.

Pakowanie rozszerzenia

Aby udostępnić je innym osobom, należy spakować rozszerzenie w jeden plik. Rozszerzenie można opublikować na platformie handlowej rozszerzenia Azure Data Studio lub udostępnić zespołowi lub społeczności. Aby wykonać ten krok, należy zainstalować inny pakiet npm z wiersza polecenia.

npm install -g vsce

Zmodyfikuj README.md plik, aby go polubić. Następnie przejdź do katalogu podstawowego rozszerzenia i uruchom polecenie vsce package. Opcjonalnie możesz połączyć repozytorium z rozszerzeniem lub kontynuować bez tego repozytorium. Aby go dodać, dodaj podobny wiersz do pliku package.json .

"repository": {
    "type": "git",
    "url": "https://github.com/anjalia/my-test-extension.git"
}

Po dodaniu tych wierszy zostanie utworzony i gotowy do zainstalowania w narzędziu my-test-extension-0.0.1.vsix Azure Data Studio.

Publikowanie rozszerzenia na platformie handlowej

Platforma handlowa rozszerzeń usługi Azure Data Studio jest w budowie. Bieżący proces polega na hostowanie rozszerzenia VSIX gdzieś, na przykład na stronie wydania usługi GitHub. Następnie przesyłasz żądanie ściągnięcia, które aktualizuje ten plik JSON przy użyciu informacji o rozszerzeniu.

Następne kroki

W tym samouczku zawarto informacje na temat wykonywania następujących czynności:

• Zainstaluj generator rozszerzeń.
• Utwórz rozszerzenie.
• Współtworzenie pulpitu nawigacyjnego w rozszerzeniu.
• Przetestuj rozszerzenie.
• Spakuj rozszerzenie.
• Opublikuj rozszerzenie na platformie handlowej.

Mamy nadzieję, że po przeczytaniu tego artykułu zainspirowaliśmy Cię do utworzenia własnego rozszerzenia dla usługi Azure Data Studio. Mamy obsługę szczegółowych informacji o pulpicie nawigacyjnym (atrakcyjnych grafów uruchamianych względem programu SQL Server), wielu interfejsów API specyficznych dla języka SQL i ogromnego istniejącego zestawu punktów rozszerzeń dziedziczonego z programu Visual Studio Code.

Jeśli masz pomysł, ale nie wiesz, jak rozpocząć pracę, otwórz problem lub tweet zespołu w witrynie azuredatastudio.

Aby uzyskać więcej informacji, przewodnik rozszerzenia programu Visual Studio Code obejmuje wszystkie istniejące interfejsy API i wzorce.

Aby dowiedzieć się, jak pracować z językiem T-SQL w narzędziu Azure Data Studio, ukończ samouczek dotyczący edytora T-SQL:

Tworzenie obiektów bazy danych za pomocą edytora Transact-SQL