Erweitern der Funktionalität durch Erstellen von Erweiterungen zu Azure Data StudioExtend the functionality by creating Azure Data Studio extensions

Erweiterungen in Azure Data StudioAzure Data Studio bieten eine einfache Möglichkeit, der Basisinstallation von Azure Data StudioAzure Data Studio weitere Funktionen hinzuzufügen.Extensions in Azure Data StudioAzure Data Studio provide an easy way to add more functionality to the base Azure Data StudioAzure Data Studio installation.

Erweiterungen werden vom Azure Data Studio-Team (Microsoft) sowie von der Drittanbietercommunity (Ihnen!) bereitgestellt.Extensions are provided by the Azure Data Studio team (Microsoft), as well as the 3rd party community (you!).

Erstellen einer ErweiterungAuthor an extension

Wenn Sie Azure Data Studio erweitern möchten, können Sie eine eigene Erweiterung erstellen und im Erweiterungenkatalog veröffentlichen.If you're interested in extending Azure Data Studio, you can create your own extension and publish it to the extension gallery.

Schreiben einer ErweiterungWriting an Extension

VoraussetzungenPrerequisites

Zum Entwickeln einer Erweiterung muss Node.js in Ihrem $PATH installiert und verfügbar sein.To develop an extension you need Node.js installed and available in your $PATH. Node.js enthält npm, den Node.js-Paket-Manager, der zum Installieren des Erweiterungsgenerators verwendet wird.Node.js includes npm, the Node.js Package Manager, which will be used to install the extension generator.

Um die neue Erweiterung zu starten, können Sie den Azure Data Studio-Erweiterungsgenerator verwenden.To start your new extension, you can use the Azure Data Studio Extension generator. Der Yeoman-Erweiterungsgenerator vereinfacht das Erstellen einfacher Erweiterungsprojekte erheblich.The Yeoman extension generator makes it very easy to create simple extension projects. Um den Generator zu starten, geben Sie Folgendes in der Eingabeaufforderung ein:To Launch the generator, type the following in a command prompt:

npm install -g yo generator-azuredatastudio

yo azuredatastudio

ErweiterbarkeitsreferenzenExtensibility References

Weitere Informationen zur Erweiterbarkeit von Azure Data Studio finden Sie in der Erweiterbarkeitsübersicht.To learn about Azure Data Studio Extensibility see Extensibility overview. Hier finden Sie auch Beispiele für die Verwendung der API.You can also see examples of how to use the API in existing samples.

Debuggen einer ErweiterungDebug an extension

Sie können die neue Erweiterung mithilfe der Visual Studio Code-Erweiterung Azure Data Studio Debug debuggen.You can debug your new extension using Visual Studio Code extension Azure Data Studio Debug.

SchritteSteps

  • Öffnen Sie die Erweiterung mit Visual Studio Code.Open your extension with Visual Studio Code
  • Installieren der Erweiterung Azure Data Studio DebugInstall Azure Data Studio Debug extension
  • Drücken Sie F5, oder klicken Sie auf das Debugsymbol und dann auf Start.Press F5 or click the Debug icon and click Start.
  • Eine neue Instanz von Azure Data Studio wird in einem speziellen Modus (Extension Development Host, Erweiterungsentwicklungshost) gestartet, und diese neue Instanz erkennt nun Ihre Erweiterung.A new instance of Azure Data Studio starts in a special mode (Extension Development Host) and this new instance is now aware of your extension.

Erstellen eines ErweiterungspaketsCreate an extension package

Nachdem Sie Ihre Erweiterung geschrieben haben, müssen Sie ein VSIX-Paket erstellen, um es in Azure Data Studio installieren zu können.After writing your extension, you need to create a VSIX package to be able to install it in Azure Data Studio. Sie können vsce zum Erstellen des VSIX-Pakets verwenden.You can use vsce to create the VSIX package.

npm install -g vsce

vsce package

Veröffentlichen einer ErweiterungPublish an extension

So veröffentlichen Sie die neue Erweiterung in Azure Data Studio:To publish your new extension to Azure Data Studio:

  1. Fügen Sie die Erweiterung https://github.com/Microsoft/azuredatastudio/blob/release/extensions/extensionsGallery.json hinzu.Add your extension to https://github.com/Microsoft/azuredatastudio/blob/release/extensions/extensionsGallery.json
  2. Wir bieten derzeit keine Unterstützung zum Hosten von Erweiterungen von Drittanbietern. Statt die Erweiterung herunterzuladen, nutzen Sie die Option von Azure Data Studio, zu einer Downloadseite zu navigieren.We currently don't have support to host third party extensions, so instead of downloading the extension, Azure Data Studio has the option to browse to a download page. Um eine Downloadseite für Ihre Erweiterung festzulegen, legen Sie den Wert der Ressource „Microsoft.AzureDataStudio.DownloadPage“ fest.To set a download page for your extension, set the value of asset "Microsoft.AzureDataStudio.DownloadPage".
  3. Erstellen Sie einen Pull Request für den release/extensions-Branch.Create a PR against release/extensions branch.
  4. Senden Sie eine Überprüfungsanforderung an das Team.Send a review request to the team.

Die Erweiterung wird überprüft und dem Erweiterungenkatalog hinzugefügt.Your extension will be reviewed and added to the extension gallery.

Veröffentlichung von Erweiterungsupdates Der Prozess zum Veröffentlichen von Updates entspricht der Veröffentlichung der Erweiterung.Publishing Extension Updates The process to publish updates is similar to publishing the extension. Stellen Sie sicher, dass die Version in „package.json“ aktualisiert wird.Please make sure the version is updated in package.json