Skapa ett Azure Data Studio-guidetillägg

Artikel
10/16/2024

Den här självstudien visar hur du skapar ett nytt Azure Data Studio-guidetillägg. Tillägget bidrar med en guide för att interagera med användare i Azure Data Studio.

I den här artikeln lär du dig hur du:

Installera tilläggsgeneratorn
Skapa ditt tillägg
Lägga till en anpassad guide i tillägget
Testa tillägget
Paketera tillägget
Publicera ditt tillägg på Marketplace

Förutsättningar

Azure Data Studio bygger på samma ramverk som Visual Studio Code, så tillägg för Azure Data Studio skapas med hjälp av Visual Studio Code. För att komma igång behöver du följande komponenter:

Node.js installerat och tillgängligt i .$PATH Node.js innehåller npm, Node.js Package Manager, som används för att installera tilläggsgeneratorn.
Visual Studio Code för att felsöka tillägget.
Azure Data Studio-felsökningstillägget (valfritt). På så sätt kan du testa tillägget utan att behöva paketera och installera det i Azure Data Studio.
Se till att azuredatastudio är i din sökväg. För Windows kontrollerar du att du väljer alternativet Add to Path i setup.exe. För Mac eller Linux kör du kommandot Installera "azuredatastudio" i PATH från kommandopaletten i Azure Data Studio.

Installera tilläggsgeneratorn

För att förenkla processen med att skapa tillägg har vi skapat en tilläggsgenerator med Hjälp av Yeoman. Installera det genom att köra följande från kommandotolken:

npm install -g yo generator-azuredatastudio

Skapa guidetillägget

Introduktion till guider

Guider är en användargränssnittstyp som innehåller stegvisa sidor som användarna kan fylla i för att utföra en uppgift. Vanliga exempel är guider för installation av programvara och felsökningsguider. Till exempel:

Guiden Dacpac

Eftersom guider ofta är användbara när du arbetar med data och utökar funktionerna i Azure Data Studio, erbjuder Azure Data Studio API:er för att skapa egna anpassade guider. Vi går igenom hur du skapar en mall för guiden och ändrar den för att skapa en egen anpassad guide.

Kör tilläggsgeneratorn

Så här skapar du ett tillägg:

Starta tilläggsgeneratorn med följande kommando:

yo azuredatastudio
Välj Ny guide eller Dialog i listan över tilläggstyper. Välj sedan guiden följt av mallen Komma igång
Följ stegen för att fylla i tilläggsnamnet (för den här självstudien använder du Mitt testtillägg) och lägg till en beskrivning.

När du slutför föregående steg skapas en ny mapp. Öppna mappen i Visual Studio Code så är du redo att skapa ett eget guidetillägg!

Kör tillägget

Nu ska vi se vad guidens mall ger oss genom att köra tillägget. Kontrollera att Azure Data Studio Debug-tillägget är installerat i Visual Studio Code innan du kör det.

Välj F5 i VS Code för att starta Azure Data Studio i felsökningsläge med tillägget igång. Kör sedan kommandot Starta guiden i Azure Data Studio från kommandopaletten (Ctr+Skift+P) i det nya fönstret. Då startas standardguiden som det här tillägget bidrar med:

Mall för guide

Nu ska vi titta på hur du ändrar den här standardguiden.

Utveckla guiden

De viktigaste filerna för att komma igång med tilläggsutveckling är package.json, src/main.tsoch vsc-extension-quickstart.md:

package.json: Det här är manifestfilen, där kommandot Starta guiden är registrerat. Det är också här main.ts som huvudprogrammets startpunkt deklareras.
main.ts: Innehåller koden för att lägga till gränssnittselement i guiden, till exempel sidor, text och knappar
vsc-extension-quickstart.md: Innehåller teknisk dokumentation som kan vara en användbar referens när du utvecklar

Nu ska vi göra en ändring i guiden: vi lägger till en 4:e, tom sida. Ändra src/main.ts enligt nedan och du bör se ytterligare en sida när du startar guiden.

Huvudguiden När du är bekant med mallen finns här några ytterligare idéer att prova:

Lägg till en knapp med bredden 300 på den nya sidan
Lägg till en flexkomponent för att placera knappen i
Lägg till en åtgärd i knappen. När du till exempel klickar på knappen startar du en dialogruta för filöppning eller öppnar en frågeredigerare.

Paketera tillägget

Om du vill dela med andra måste du paketera tillägget i en enda fil. Detta kan publiceras på Azure Data Studio-tilläggets marknadsplats eller delas mellan ditt team eller din community. För att göra detta måste du installera ett annat npm-paket från kommandoraden:

npm install -g vsce

README.md Redigera efter behov, navigera sedan till baskatalogen för tillägget och kör vsce package. Du kan också länka en lagringsplats med ditt tillägg eller fortsätta utan en. Lägg till en rad som liknar din package.json fil om du vill lägga till en rad.

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

När dessa rader har lagts till skapades en my-test-extension-0.0.1.vsix-fil som är redo att installeras i Azure Data Studio.

Installera VSIX

Publicera ditt tillägg på Marketplace

Marknadsplatsen för Azure Data Studio-tillägget är inte helt implementerad än, men den aktuella processen är att vara värd för tillägget VSIX någonstans (till exempel en GitHub-versionssida) och sedan skicka en PR som uppdaterar den här JSON-filen med din tilläggsinformation.

Nästa steg

I den här självstudiekursen lärde du dig att:

Installera tilläggsgeneratorn
Skapa ditt tillägg
Lägga till en anpassad guide i tillägget
Testa tillägget
Paketera tillägget
Publicera ditt tillägg på Marketplace

Vi hoppas att du efter att ha läst detta kommer att inspireras att skapa ett eget tillägg för Azure Data Studio. Vi har stöd för Instrumentpanelsinsikter (vackra grafer som körs mot din SQL Server), ett antal SQL-specifika API:er och en enorm befintlig uppsättning tilläggspunkter som ärvts från Visual Studio Code.

Om du har en idé men inte vet hur du kommer igång kan du öppna ett problem eller en tweet i teamet: azuredatastudio.

Du kan alltid läsa tilläggsguiden för Visual Studio Code eftersom den omfattar alla befintliga API:er och mönster.

Om du vill lära dig hur du arbetar med T-SQL i Azure Data Studio slutför du självstudiekursen för T-SQL-redigeraren:

Använda Transact-SQL-redigeraren för att skapa databasobjekt

Dela via