Erweitern der Funktionalität durch Erstellen von Erweiterungen für Azure Data StudioExtend functionality by creating Azure Data Studio extensions

Erweiterungen in Azure Data Studio bieten eine einfache Möglichkeit, der Basisinstallation von Azure Data Studio weitere Funktionen hinzuzufügen.Extensions in Azure Data Studio provide an easy way to add more functionality to the base Azure 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 third-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 Erweiterungskatalog veröffentlichen.If you're interested in extending Azure Data Studio, you can create your own extension and publish it to the extensions gallery.

Erstellen einer ErweiterungWrite 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 is used to install the extension generator.

Zum Erstellen der neuen Erweiterung können Sie den Erweiterungs-Generator für Azure Data Studio verwenden.To create your new extension, you can use the Azure Data Studio extension generator. Der Erweiterungs-Generator von Yeoman ist ein guter Ausgangspunkt für Erweiterungsprojekte.The Yeoman extension generator is a beneficial starting point for extension projects. Geben Sie den folgenden Befehl in eine Eingabeaufforderung ein, um den Generator zu starten:To start the generator, enter the following command in a command prompt:

npm install -g yo generator-azuredatastudio
yo azuredatastudio

Ausführliche Anleitungen zu den ersten Schritten mit Ihrer Erweiterungsvorlage finden Sie unter keymap-Erweiterung. Dort erhalten Sie schrittweise Anleitungen zum Erstellen einer Erweiterung.For an in-depth guide on how to get started with your extension template, see keymap extension, which walks you through the creation of an extension.

Referenzen zur ErweiterbarkeitExtensibility 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 by using the Visual Studio Code extension Azure Data Studio Debug.

So debuggen Sie die Erweiterung:To debug your extension:

  1. Öffnen Sie Ihre Erweiterung mit Visual Studio Code.Open your extension with Visual Studio Code.
  2. Installieren Sie die Azure Data Studio-Debug-Erweiterung.Install the Azure Data Studio Debug extension.
  3. Drücken Sie F5, oder wählen Sie das Debugsymbol aus, und klicken Sie dann auf Starten.Select F5, or select the Debug icon and then select Start.
  4. Eine neue Instanz von Azure Data Studio wird in einem speziellen Modus (Extension Development Host, Erweiterungsentwicklungshost) gestartet.A new instance of Azure Data Studio starts in a special mode (Extension Development Host). Diese neue Instanz erkennt nun Ihre Erweiterung.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, das in Azure Data Studio installiert wird.After writing your extension, you need to create a VSIX package that installs in Azure Data Studio. Sie können vscode-vsce (Visual Studio Code-Erweiterungen) zum Erstellen des VSIX-Pakets verwenden.You can use vscode-vsce (Visual Studio Code Extensions) to create the VSIX package.

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

Mit einem VSIX-Paket können Sie Ihre Erweiterung lokal und privat freigeben, indem Sie die VSIX-Datei freigeben und den Befehl Extensions: Install From VSIX File (Erweiterungen: Aus VSIX-Datei installieren) aus der Befehlspalette ausführen, um die Erweiterung in Azure Data Studio zu installieren.With a VSIX package, you can share your extension locally and privately by sharing the .vsix file and using the command Extensions: Install From VSIX File from the command palette to install the extension in Azure Data Studio.

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 dem Erweiterungskatalog Ihre Erweiterung hinzu.Add your extension to the extensions gallery.
  2. Derzeit werden keine Drittanbietererweiterungen unterstützt.We currently don't have support to host third-party extensions. Anstatt die Erweiterung herunterzuladen, bietet Azure Data Studio die Option, eine Downloadseite aufzurufen.Instead of downloading the extension, Azure Data Studio has the option to browse to a download page. Zum Festlegen einer Downloadseite für Ihre Erweiterung müssen Sie den Wert der Ressource Microsoft.AzureDataStudio.DownloadPage festlegen.To set a download page for your extension, set the value of the 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.

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

Veröffentlichen von Updates für ErweiterungenPublish extension updates

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

Nächste SchritteNext steps

In den folgenden Tutorials zum Entwickeln von Erweiterungen finden Sie ausführliche Informationen zum Einstieg:See one of the following extension authoring tutorials for step-by-step instructions on how to get started: