Créer une extension de tableau de bord Azure Data Studio

  • Article

Ce tutoriel montre comment créer une extension de tableau de bord Azure Data Studio. L’extension donne un tableau de bord de connexion Azure Data Studio. Vous pouvez donc étendre les fonctionnalités d’Azure Data Studio d’une manière facilement visible pour les utilisateurs.

Dans cet article, vous apprendrez comment :

  • Installer le générateur d’extension.
  • Créer votre extension.
  • Contribuer au tableau de bord dans votre extension.
  • Tester votre extension.
  • Empaqueter votre extension.
  • Publier votre extension sur le marketplace.

Prérequis

Azure Data Studio repose sur la même infrastructure que Visual Studio Code, ainsi les extensions pour Azure Data Studio sont générées à l’aide de Visual Studio Code. Pour commencer, vous avez besoin des composants suivants :

  • Node.js installé et disponible dans votre $PATH. Node. js comprend npm, le gestionnaire de packages Node.js, qui est utilisé pour installer le générateur d’extensions.
  • Visual Studio Code pour déboguer l’extension.
  • L’extension de débogage d’Azure Data Studio (facultatif). L’extension de débogage vous permet de tester votre extension sans avoir à empaqueter et à l’installer dans Azure Data Studio.
  • Vérifiez que azuredatastudio se trouve dans votre chemin d’accès. Pour Windows, veillez à choisir l’option Ajouter au chemin d’accès dans setup.exe. Pour Mac ou Linux, exécutez Installer la commande 'azuredatastudio' dans PATH à partir de la palette de commandes dans Azure Data Studio.

Installer le générateur d’extensions

Pour simplifier le processus de création d’extensions, nous avons créé un générateur d’extensions à l’aide de Yeoman. Pour l’installer, exécutez la commande suivante à partir de l’invite de commandes :

npm install -g yo generator-azuredatastudio

Créer votre extension de tableau de bord

Présentation du tableau de bord

Le tableau de bord de connexion Azure Data Studio est un outil puissant qui récapitule et donne des informations sur les connexions d’un utilisateur.

Il existe deux variantes du tableau de bord. Le tableau de bord du serveur récapitule l’ensemble du serveur et le tableau de bord de la base de données récapitule une base de données individuelle. Vous pouvez accéder à l’un ou l’autre tableau de bord en cliquant avec le bouton droit sur un serveur ou une base de données dans le Viewlet Connexions d’Azure Data Studio, puis en sélectionnant Gérer.

Screenshot that shows dashboards introduction.

Il existe trois points de contribution clés pour les extensions permettant d’ajouter des fonctionnalités au tableau de bord :

  1. Onglet du tableau de bord complet : Onglet distinct dans le tableau de bord pour votre extension. Peut être ajouté à un tableau de bord de serveur ou de base de données. Personnalisable avec des widgets, une barre d’outils et une section de navigation.

  2. Actions de la page d’accueil : Boutons d’action situés en haut de la barre d’outils de connexion.

  3. Widgets : Graphiques qui s’exécutent sur votre serveur SQL Server.

    Screenshot that shows contribution points.

Exécuter le générateur d’extensions

Pour créer une extension :

  1. Démarrez le générateur d’extension avec la commande suivante :

    yo azuredatastudio

  2. Choisissez Nouveau tableau de bord dans la liste des types d’extension.

  3. Renseignez les invites, comme indiqué ci-dessous, pour créer une extension qui fournit un onglet au tableau de bord du serveur.

    Screenshot that shows the extension generator.

    Le nombre d’invites étant élevé, voici un peu plus d’informations sur ce que signifie chaque question :

    Screenshot that shows a dashboard flowchart.

L’exécution des étapes précédentes crée un dossier. Ouvrez le dossier dans Visual Studio Code et vous êtes prêt à créer votre propre extension de tableau de bord.

Exécuter l’extension

Voyons ce que nous obtenons avec le modèle de tableau de bord en exécutant l’extension. Avant l’exécution, vérifiez que l’extension de débogage Azure Data Studio est installée dans Visual Studio Code.

Appuyez sur F5 dans Visual Studio Code pour lancer Azure Data Studio en mode débogage avec l’extension en cours d’exécution. Ensuite, vous pouvez voir comment ce modèle par défaut contribue au tableau de bord.

Nous allons ensuite voir comment modifier ce tableau de bord par défaut.

Développer le tableau de bord

Le fichier le plus important pour la prise en main du développement d’extensions est package.json. Il s’agit du fichier manifeste, dans lequel les contributions du tableau de bord sont inscrites. Remarquez les sections dashboard.tabs, dashboard.insights et dashboard.containers.

Voici quelques modifications à essayer :

  • Expérimentez les types d’insights, notamment bar, horizontalBar et timeSeries.
  • Écrivez vos propres requêtes pour les exécuter sur votre connexion SQL Server.
  • Reportez-vous à ce tutoriel ou à celui-ci pour découvrir des tutoriels sur des insights spécifiques.

Empaqueter votre extension

Pour partager votre extension avec d’autres personnes, vous avez besoin de l’empaqueter dans un fichier unique. Votre extension peut être publiée sur le marketplace d’extensions Azure Data Studio ou partagée avec votre équipe ou votre communauté. Pour ce faire, vous devez installer un autre package npm à partir de la ligne de commande.

npm install -g vsce

Modifiez le fichier README.md à votre convenance. Puis, accédez au répertoire de base de l’extension, puis exécutez vsce package. Vous pouvez éventuellement lier un référentiel à votre extension ou continuer sans référentiel. Pour en ajouter un, ajoutez une ligne similaire à votre fichier package.json.

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

Une fois ces lignes ajoutées, un fichier my-test-extension-0.0.1.vsix est créé et prêt à être installé dans Azure Data Studio.

Screenshot that shows installing VSIX.

Publier votre extension sur le marketplace

Le marketplace d’extension Azure Data Studio est en construction. Le processus en cours consiste à héberger l’extension VSIX quelque part, par exemple, sur une page de version GitHub. Ensuite, envoyez une demande de tirage (pull request) qui met à jour ce fichier JSON avec vos informations d’extension.

Étapes suivantes

Dans ce didacticiel, vous avez appris à :

  • Installer le générateur d’extension.
  • Créer votre extension.
  • Contribuer au tableau de bord dans votre extension.
  • Tester votre extension.
  • Empaqueter votre extension.
  • Publier votre extension sur le marketplace.

Nous espérons qu’après avoir lu cet article, vous serez inspiré pour créer votre propre extension pour Azure Data Studio. Nous prenons en charge les insights de tableau de bord (de jolis graphiques qui s’exécutent sur SQL Server), un certain nombre d’API spécifiques à SQL et un ensemble de points d’extension existants hérités de Visual Studio Code.

Si vous avez une idée mais que vous ne savez pas par où commencer, ouvrez un problème ou envoyer un tweet à l’équipe azuredatastudio.

Pour plus d’informations, le guide d’extension Visual Studio Code couvre l’ensemble des API et modèles existants.

Pour savoir comment utiliser T-SQL dans Azure Data Studio, suivez le didacticiel de l’éditeur T-SQL :

Utiliser l’éditeur Transact-SQL pour créer des objets de base de données