Vytvoření rozšíření řídicího panelu Azure Data Studio

Článek
10/16/2024

Tento kurz ukazuje, jak vytvořit nové rozšíření řídicího panelu Azure Data Studio. Rozšíření přispívá k řídicímu panelu připojení azure Data Studio, takže můžete rozšířit funkce nástroje Azure Data Studio způsobem, který je uživatelům snadno viditelný.

V tomto článku získáte informace o těchto tématech:

Nainstalujte generátor rozšíření.
Vytvořte rozšíření.
Přispívání na řídicí panel v rozšíření
Otestujte rozšíření.
Zabalte rozšíření.
Publikujte své rozšíření na marketplace.

Požadavky

Azure Data Studio je postavené na stejné platformě jako Visual Studio Code, takže rozšíření pro Azure Data Studio se vytvářejí pomocí editoru Visual Studio Code. Abyste mohli začít, potřebujete následující komponenty:

Node.js nainstalované a dostupné ve vašem $PATHsouboru . Node.js zahrnuje npm, Node.js Správce balíčků, který se používá k instalaci generátoru rozšíření.
Visual Studio Code pro ladění rozšíření
Rozšíření azure Data Studio Debug (volitelné) Rozšíření Ladění vám umožní otestovat rozšíření, aniž byste ho museli zabalit a nainstalovat do nástroje Azure Data Studio.
Ujistěte se azuredatastudio , že je ve vaší cestě. V systému Windows nezapomeňte v setup.exe zvolit možnost Přidat do cesty . Pro Mac nebo Linux spusťte příkaz Install 'azuredatastudio' v PATH z palety příkazů v Nástroji Azure Data Studio.

Instalace generátoru rozšíření

Abychom zjednodušili proces vytváření rozšíření, vytvořili jsme generátor rozšíření pomocí Yeomanu. Pokud ho chcete nainstalovat, spusťte z příkazového řádku následující příkaz:

npm install -g yo generator-azuredatastudio

Vytvoření rozšíření řídicího panelu

Úvod do řídicího panelu

Řídicí panel připojení azure Data Studio je výkonný nástroj, který shrnuje a poskytuje přehled o připojeních uživatele.

Řídicí panel má dvě varianty. Řídicí panel serveru shrnuje celý server a řídicí panel databáze shrnuje jednotlivé databáze. K řídicímu panelu se dostanete tak, že kliknete pravým tlačítkem na server nebo databázi v zobrazení Připojení v nástroji Azure Data Studio a vyberete Spravovat.

Snímek obrazovky znázorňující úvod k řídicím panelům

Existují tři klíčové body příspěvků pro rozšíření, která dají do řídicího panelu přidat funkce:

Karta Celý řídicí panel: Samostatná karta na řídicím panelu pro vaše rozšíření. Dá se přidat na server nebo na řídicí panel databáze. Přizpůsobitelné pomocí widgetů, panelu nástrojů a navigačního oddílu
Akce domovské stránky: Tlačítka akcí v horní části panelu nástrojů připojení
Widgety: Grafy, které běží na SQL Serveru.

Spuštění generátoru rozšíření

Vytvoření rozšíření:

Spusťte generátor rozšíření pomocí následujícího příkazu:

yo azuredatastudio
V seznamu typů rozšíření zvolte Nový řídicí panel .
Vyplňte výzvy, jak je znázorněno, a vytvořte rozšíření, které přispívá tabulátorem na řídicí panel serveru.

Existuje mnoho výzev, takže tady je trochu více informací o tom, co každá otázka znamená:

Dokončením předchozích kroků se vytvoří nová složka. Otevřete složku v editoru Visual Studio Code a jste připraveni vytvořit vlastní rozšíření řídicího panelu.

Spuštění rozšíření

Pojďme se podívat, co nám šablona řídicího panelu poskytuje, spuštěním rozšíření. Než ho spustíte, ujistěte se, že je v editoru Visual Studio Code nainstalované rozšíření Azure Data Studio Debug.

Výběrem klávesy F5 v editoru Visual Studio Code spusťte Azure Data Studio v režimu ladění se spuštěným rozšířením. Pak uvidíte, jak tato výchozí šablona přispívá k řídicímu panelu.

Dále se podíváme, jak upravit tento výchozí řídicí panel.

Vývoj řídicího panelu

Nejdůležitějším souborem, který chcete začít s vývojem přípony, je package.json. Tento soubor je soubor manifestu, kde jsou zaregistrovány příspěvky řídicího panelu. Poznamenejte si dashboard.tabsoddíly a dashboard.insightsdashboard.containers oddíly.

Tady jsou některé změny, které můžete vyzkoušet:

Seznamte se s typy přehledů, mezi které patří pruh, vodorovnýbar a timeSeries.
Napište vlastní dotazy, které se mají spouštět pro připojení k SQL Serveru.
Konkrétní kurzy s přehledy najdete v tomto ukázkovém kurzu nebo v tomto kurzu .

Zabalení rozšíření

Pokud chcete sdílet s ostatními, musíte příponu zabalit do jednoho souboru. Vaše rozšíření můžete publikovat na marketplace rozšíření Azure Data Studio nebo sdílet s týmem nebo komunitou. Pokud chcete tento krok provést, musíte z příkazového řádku nainstalovat další balíček npm.

npm install -g vsce

README.md Upravte soubor podle svých představ. Pak přejděte do základního adresáře rozšíření a spusťte vsce packagepříkaz . Volitelně můžete propojit úložiště s rozšířením nebo pokračovat bez tohoto úložiště. Pokud ho chcete přidat, přidejte do souboru podobný řádek package.json .

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

Po přidání my-test-extension-0.0.1.vsix těchto řádků se vytvoří soubor připravený k instalaci v nástroji Azure Data Studio.

Snímek obrazovky znázorňující instalaci VSIX

Publikování rozšíření na marketplace

Marketplace rozšíření Azure Data Studio probíhá ve výstavby. Aktuálním procesem je hostování rozšíření VSIX někde, například na stránce verze GitHubu. Pak odešlete žádost o přijetí změn, která aktualizuje tento soubor JSON informacemi o rozšíření.

Další kroky

V tomto kurzu jste se naučili, jak:

Nainstalujte generátor rozšíření.
Vytvořte rozšíření.
Přispívání na řídicí panel v rozšíření
Otestujte rozšíření.
Zabalte rozšíření.
Publikujte své rozšíření na marketplace.

Doufáme, že po přečtení tohoto článku jste inspirovaní k vytvoření vlastního rozšíření pro Azure Data Studio. Podporujeme přehledy řídicích panelů (atraktivní grafy, které běží na SQL Serveru), řadu rozhraní API specifických pro SQL a obrovskou existující sadu bodů rozšíření zděděných z editoru Visual Studio Code.

Pokud máte nápad, ale nevíte, jak začít, otevřete problém nebo tweetujte tým v azuredatastudio.

Další informace najdete v průvodci rozšířením editoru Visual Studio Code, který obsahuje všechna existující rozhraní API a vzory.

Pokud chcete zjistit, jak pracovat s T-SQL v Nástroji Azure Data Studio, dokončete kurz editoru T-SQL:

Vytvoření databázových objektů pomocí editoru Transact-SQL

Sdílet prostřednictvím