Tworzenie rozszerzenia kreatora Azure Data Studio

Ważny

Usługa Azure Data Studio zostanie wycofana 28 lutego 2026 r.. Zalecamy użycie rozszerzenia MSSQL dla programu Visual Studio Code. Aby uzyskać więcej informacji na temat migracji do programu Visual Studio Code, odwiedź Co się dzieje z usługą Azure Data Studio?

W tym samouczku pokazano, jak utworzyć nowe rozszerzenie Kreatora narzędzia Azure Data Studio. Rozszerzenie dodaje kreatora do interakcji z użytkownikami w Azure Data Studio.

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

• Instalowanie generatora rozszerzeń
• Tworzenie rozszerzenia
• Dodaj kreatora niestandardowego do rozszerzenia
• Testowanie rozszerzenia
• Zapakuj swoje rozszerzenie
• Publikowanie rozszerzenia 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ą tworzone przy użyciu programu Visual Studio Code. Do rozpoczęcia pracy potrzebne są następujące składniki:

• Node.js jest zainstalowane i dostępne w systemie/c1 />. 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 Debug usługi Azure Data Studio (opcjonalnie). Dzięki temu można przetestować rozszerzenie bez konieczności tworzenia pakietów i instalowania go w narzędziu Azure Data Studio.
• Upewnij się, że azuredatastudio znajduje się w ścieżce. W przypadku systemu Windows upewnij się, że wybrano Add to Path opcję w setup.exe. 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

Utwórz rozszerzenie kreatora

Wprowadzenie do kreatorów

Kreatory to typy interfejsu użytkownika, które prezentują strony do wypełnienia krok po kroku, aby wykonać zadanie. Typowe przykłady obejmują asystentów instalacji oprogramowania i asystentów rozwiązywania problemów. Na przykład:

Ponieważ kreatory są często przydatni podczas pracy z danymi i rozszerzania funkcjonalności Azure Data Studio, program Azure Data Studio oferuje interfejsy API do tworzenia własnych kreatorów niestandardowych. Przedstawimy sposób generowania szablonu Kreatora i modyfikowania go, aby stworzyć własny spersonalizowany kreator.

Uruchamianie generatora rozszerzeń

Aby utworzyć rozszerzenie:

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

   yo azuredatastudio

2. Wybierz pozycję Nowy kreator lub okno dialogowe z listy typów rozszerzeń. Następnie wybierz pozycję Kreator, a następnie Szablon Rozpoczęcia

3. Wykonaj kroki, aby wypełnić nazwę rozszerzenia (na potrzeby tego samouczka użyj mojego rozszerzenia testowego) i dodaj opis.

   

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

Uruchamianie rozszerzenia

Zobaczmy, co daje szablon kreatora, 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 VS Code, aby uruchomić narzędzie Azure Data Studio w trybie debugowania z uruchomionym rozszerzeniem. Następnie w narzędziu Azure Data Studio, uruchom polecenie Uruchom Kreatora z palety poleceń (Ctr+Shift+P) w nowym oknie. Spowoduje to uruchomienie domyślnego kreatora dostarczanego przez to rozszerzenie.

Następnie przyjrzymy się, jak zmodyfikować tego kreatora domyślnego.

Opracuj kreatora

Najważniejsze pliki do rozpoczęcia programowania rozszerzeń to package.json, src/main.ts i vsc-extension-quickstart.md:

• package.json: jest to plik manifestu, w którym zarejestrowano polecenie Kreatora uruchamiania. Jest to również miejsce, w którym main.ts jest deklarowany główny punkt wejścia programu.
• main.ts: zawiera kod służący do dodawania elementów interfejsu użytkownika do Kreatora, takich jak strony, tekst i przyciski
• vsc-extension-quickstart.md: Zawiera dokumentację techniczną, która może być pomocną dokumentacją podczas opracowywania

Wprowadźmy zmianę w kreatorze: dodamy czwartą pustą stronę. Zmodyfikuj src/main.ts , jak pokazano poniżej, a po uruchomieniu kreatora powinna zostać wyświetlona dodatkowa strona.

Po zapoznaniu się z szablonem poniżej przedstawiono kilka dodatkowych pomysłów, które warto wypróbować:

• Dodaj przycisk o szerokości 300 do nowej strony
• Dodaj element flex, aby umieścić przycisk w nim.
• Dodaj akcję do przycisku. Na przykład po kliknięciu przycisku uruchom okno dialogowe otwierania pliku lub otwórz edytor zapytań.

Zapakuj swoje rozszerzenie

Aby udostępnić je innym osobom, musisz spakować rozszerzenie w jeden plik. Można to opublikować w witrynie Marketplace rozszerzeń usługi Azure Data Studio lub udostępnić je zespołowi lub społeczności. W tym celu należy zainstalować inny pakiet npm z wiersza polecenia:

npm install -g vsce

Zmodyfikuj README.md, a następnie przejdź do katalogu głównego rozszerzenia i uruchom vsce package. Opcjonalnie możesz połączyć repozytorium z rozszerzeniem lub kontynuować bez niego. 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 został utworzony plik my-test-extension-0.0.1.vsix i gotowy do zainstalowania w narzędziu Azure Data Studio.

Publikowanie rozszerzenia na platformie handlowej

Platforma rynku rozszerzeń Azure Data Studio nie jest jeszcze w pełni zaimplementowana, ale obecny proces polega na hostowaniu rozszerzenia VSIX w jakimś miejscu (na przykład na stronie wydania w GitHubie), a następnie na złożeniu PR (żądania ściągnięcia), aby zaktualizować 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:

• Instalowanie generatora rozszerzeń
• Tworzenie rozszerzenia
• Dodaj kreatora niestandardowego do rozszerzenia
• Testowanie rozszerzenia
• Zapakuj swoje rozszerzenie
• Publikowanie rozszerzenia na platformie handlowej

Mamy nadzieję, że po przeczytaniu tego artykułu utworzysz własne rozszerzenie dla usługi Azure Data Studio. Obsługujemy szczegółowe informacje o pulpicie nawigacyjnym (ładne wykresy, które działają na serwerze SQL), wiele interfejsów API specyficznych dla SQL i ogromny zestaw punktów rozszerzeń dziedziczony z Visual Studio Code.

Jeśli masz pomysł, ale nie masz pewności, jak rozpocząć pracę, otwórz problem lub tweet w zespole: azuredatastudio.

Zawsze możesz zapoznać się z przewodnikiem rozszerzenia programu Visual Studio Code, ponieważ obejmuje on 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