Udostępnij za pośrednictwem


Rozszerzanie funkcjonalności przez tworzenie rozszerzeń usługi Azure Data Studio

Rozszerzenia w narzędziu Azure Data Studio zapewniają łatwy sposób dodawania większej funkcjonalności do podstawowej instalacji narzędzia Azure Data Studio.

Rozszerzenia są udostępniane przez zespół usługi Azure Data Studio (Microsoft), a także społeczność innych firm (Ty!).

Tworzenie rozszerzenia

Jeśli interesuje Cię rozszerzenie usługi Azure Data Studio, możesz utworzyć własne rozszerzenie i opublikować je w galerii rozszerzeń.

Pisanie rozszerzenia

Wymagania wstępne

Aby opracować rozszerzenie, musisz 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ń.

Aby utworzyć nowe rozszerzenie, możesz użyć generatora rozszerzeń usługi Azure Data Studio. Generator rozszerzeń Yeoman jest korzystnym punktem wyjścia dla projektów rozszerzeń. Aby uruchomić generator, wprowadź następujące polecenie w wierszu polecenia:

npm install -g yo generator-azuredatastudio
yo azuredatastudio

Aby zapoznać się ze szczegółowym przewodnikiem dotyczącym rozpoczynania pracy z szablonem rozszerzenia, zobacz rozszerzenie mapy kluczy, które przeprowadzi Cię przez proces tworzenia rozszerzenia.

Odwołania do rozszerzalności

Aby dowiedzieć się więcej o rozszerzalności narzędzia Azure Data Studio, zobacz Omówienie rozszerzalności. Przykłady użycia interfejsu API można również zobaczyć w istniejących przykładach.

Debugowanie rozszerzenia

Nowe rozszerzenie można debugować przy użyciu rozszerzenia programu Visual Studio Code w narzędziu Azure Data Studio Debug.

Aby debugować rozszerzenie:

  1. Otwórz rozszerzenie za pomocą programu Visual Studio Code.
  2. Zainstaluj rozszerzenie Azure Data Studio Debug.
  3. Wybierz F5 lub wybierz ikonę Debuguj, a następnie wybierz pozycję Uruchom.
  4. Nowe wystąpienie narzędzia Azure Data Studio jest uruchamiane w trybie specjalnym (Host programowania rozszerzeń). To nowe wystąpienie jest teraz świadome rozszerzenia.

Tworzenie pakietu rozszerzenia

Po napisaniu rozszerzenia należy utworzyć pakiet VSIX instalowany w narzędziu Azure Data Studio. Aby utworzyć pakiet VSIX, możesz użyć polecenia vscode-vsce (rozszerzenia programu Visual Studio Code).

npm install -g @vscode/vsce
cd myExtensionName
vsce package
# The myExtensionName.vsix file has now been generated

Pakiet VSIX umożliwia udostępnianie rozszerzenia lokalnie i prywatnie, udostępniając plik vsix i używając rozszerzeń poleceń : Zainstaluj z pliku VSIX z palety poleceń, aby zainstalować rozszerzenie w narzędziu Azure Data Studio.

Publikowanie rozszerzenia

Aby opublikować nowe rozszerzenie w narzędziu Azure Data Studio:

  1. Dodaj rozszerzenie do galerii rozszerzeń.
  2. Obecnie nie mamy obsługi hostowania rozszerzeń innych firm. Zamiast pobierać rozszerzenie, program Azure Data Studio ma możliwość przeglądania strony pobierania. Aby ustawić stronę pobierania dla rozszerzenia, ustaw wartość elementu zawartości Microsoft.AzureDataStudio.DownloadPage.
  3. Utwórz żądanie ściągnięcia względem gałęzi release/extensions.
  4. Wyślij żądanie przeglądu do zespołu.

Rozszerzenie zostanie przejrzyone i dodane do galerii rozszerzeń.

Publikowanie aktualizacji rozszerzeń

Proces publikowania aktualizacji jest podobny do publikowania rozszerzenia. Upewnij się, że wersja została zaktualizowana w package.json.

Następne kroki

Zapoznaj się z jednym z następujących samouczków tworzenia rozszerzeń, aby uzyskać instrukcje krok po kroku dotyczące rozpoczynania pracy: