Partager via


Utilisez Visual Studio Code pour connecter et interroger les instances Azure Cosmos DB

Visual Studio Code est un éditeur de code polyvalent pour Linux, macOS et Windows qui prend en charge de nombreuses extensions. Ce guide de démarrage rapide vous montre comment vous connecter à Azure Cosmos DB pour NoSQL et Azure Cosmos DB pour MongoDB à l’aide de Visual Studio Code. Il couvre l’exécution d’opérations de base de données de base, notamment la requête, l’insertion, la mise à jour et la suppression de données.

Prérequis

  • Un compte Azure Cosmos DB pour NoSQL configuré avec une base de données et un conteneur. Utilisez l’un de ces guides de démarrage rapide ici pour configurer une ressource :

Installer l’extension

Pour connecter et gérer des données dans Azure Cosmos DB au sein de Visual Studio, installez d’abord l’extension Bases de données Azure.

  1. Ouvrez Visual Studio Code.
  2. Accédez au volet Extensions en sélectionnant Extensions d’affichage > ou en utilisant le raccourci Ctrl + Maj + X sur Windows et Commande + Maj + X sur macOS.
  3. Dans la barre de recherche, tapez DocumentDB pour Visual Studio Code et sélectionnez l’extension. Ensuite, sélectionnez Installer.
  4. Après l’installation, rechargez Visual Studio Code si vous y êtes invité.

Connexion à une instance Azure Cosmos DB for NoSQL

  1. Dans Visual Studio Code, accédez au panneau Azure (sélectionnez l’icône Azure dans la barre d’activités).

  2. Connectez-vous à votre compte Azure Cosmos DB pour NoSQL via l’ID Microsoft Entra :

    Remarque

    Utilisez le contrôle d’accès en fonction du rôle Microsoft Entra ID lors de l’accès à vos ressources Azure Cosmos DB.

  3. Une fois connecté, dans l’arborescence Azure, recherchez votre abonnement Azure et explorez Azure Cosmos DB.

  4. Sélectionnez un compte existant ou cliquez avec le bouton droit pour créer une ressource.

Interroger et afficher vos données

Les étapes suivantes utilisent l’Éditeur de requête pour exécuter une requête et afficher les résultats de la requête :

  1. Dans le menu de votre collection, cliquez avec le bouton droit sur la collection pour ouvrir l’Éditeur de requête en Préversion.

    Capture d’écran de l’éditeur de requête dans Visual Studio Code.

  2. Exécutez la requête fournie dans l’éditeur de requête pour afficher vos données dans l’affichage Table :

    Capture d’écran des résultats de l’éditeur de requête dans Visual Studio Code.

  3. Explorez vos données dans d’autres affichages pris en charge :

    • Affichage JSON : consultez la structure de données brutes.

      Capture d’écran des résultats de l’éditeur de requête dans l’affichage JSON.

    • Arborescence : explorez facilement des données imbriquées.

      Capture d’écran des résultats de l’éditeur de requête dans l’arborescence.

Afficher des métriques d’indexation et de requête

Dans l’éditeur de requête, affichez davantage de métriques de requête et d’index pour optimiser les performances de votre requête.

  1. Sélectionnez l’onglet Statistiques près de la requête Résultats. Capture d’écran des statistiques de requête dans Visual Studio Code.

  2. Pour découvrir plus d’informations sur les définitions de métrique, consultez la documentation sur les métriques de requête.

Insérer, modifier et supprimer des documents

  • Modification de document en temps réel : ajoutez, affichez, modifiez et supprimez instantanément des documents, en ayant les modifications reflétées en temps réel.

  • Importer à partir de JSON : chargez vos données rapidement à partir de fichiers JSON. Capture d’écran de la modification de documents dans Visual Studio Code.

Exporter des résultats de requête

  • Téléchargement de résultats : téléchargez des résultats de requête dans des fichiers CSV ou JSON. Capture d’écran des résultats d’exportation dans Visual Studio Code.

Prérequis

  • Un compte Azure Cosmos DB pour NoSQL configuré avec une base de données et un conteneur.
  • Un interpréteur de commandes MongoDB (mongosh) installé pour des interactions de ligne de commande (facultatif, mais recommandé).

Installer l’extension

Pour connecter et gérer des données dans Azure Cosmos DB, vous devez installer l’extension Bases de données Azure pour Visual Studio Code.

  1. Ouvrez Visual Studio Code.
  2. Accédez au volet Extensions en sélectionnant Extensions d’affichage > ou en utilisant le raccourci Ctrl + Maj + X sur Windows et Commande + Maj + X sur macOS.
  3. Dans la barre de recherche, tapez DocumentDB pour Visual Studio Code et sélectionnez l’extension. Ensuite, sélectionnez Installer.
  4. Après l’installation, rechargez Visual Studio Code si vous y êtes invité.

Connexion à une charge de travail MongoDB

À présent, connectez-vous à la charge de travail MongoDB dans Azure Cosmos DB pour MongoDB.

  1. Dans le panneau Espace de travail, développez la section Comptes MongoDB.

  2. Ici, vous pouvez voir tous vos comptes MongoDB. Connectez-vous à un nouveau compte MongoDB à l’aide de vos informations d’identification.

    Remarque

    Tous les clusters MongoDB connectés avec succès restent répertoriés dans la section comptes MongoDB, même après la fermeture de Visual Studio Code.

Gestion des données intuitive

Gérez facilement vos bases de données dans Visual Studio Code :

  • Créer et supprimer des bases de données/collections : créez ou supprimez des bases de données et des collections à l’aide du menu contextuel de votre compte, de votre base de données ou de votre collection dans le volet de ressources.

  • Importer à partir de JSON : importez rapidement des données à partir de fichiers JSON dans votre collection.

    • Importation initiale
      1. Cliquez avec le bouton droit sur le nom de collection dans l’affichage des ressources et sélectionnez Importer des documents dans une collection.
      2. Vous pouvez également ouvrir le mode Collection en cliquant sur l’entrée Documents de votre collection, puis sélectionnez le bouton Importer .
    • Sélectionner un fichier JSON
      1. Parcourez pour trouver le fichier *.json contenant vos données.
      2. Confirmez pour démarrer le processus d’importation.
  • Exporter des données : enregistrez des collections ou de résultats de requête au format JSON pour la sauvegarde ou le partage.

    • Initiation d’une exportation :
      • Option 1 :
        1. Cliquez avec le bouton droit sur le nom de collection dans l’affichage des ressources et sélectionnez Exporter des documents à partir de la collection pour exporter la collection entière.
      • Option 2 :
        1. Ouvrez le mode Collection en cliquant sur l’entrée Documents de votre collection, puis sélectionnez le bouton Exporter .
        2. Choisissez d’exporter la collection entière ou les résultats de la requête actuelle.
    • Spécifier le fichier de destination :
      1. Entrez le nom et l’emplacement du fichier *.json de destination.
      2. Confirmez l’exportation pour commencer à enregistrer les données.
  • Modification de document en temps réel : ajoutez, affichez, modifiez et supprimez instantanément des documents avec les mises à jour en temps réel.

    • Ouvrir la modification de document :
      • Accédez aux options de modification de documents directement dans l’« affichage de collection ». Ces contrôles sont bien situés au-dessus de l’affichage des données pour y accéder facilement.
    • Actions disponibles :
      • Ajouter : créer des documents dans la collection.
      • Afficher : consultez le contenu du document sélectionné.
      • Modifier : modifiez le contenu de documents sélectionnés.
      • Supprimer : supprimez les documents sélectionnés dont les modifications sont immédiatement reflétées.

Capture d’écran de l’extension VS-code d’une instance MongoDB.

Outils de requête puissants

Exécutez et affinez vos requêtes en toute transparence :

  • Résultats instantanées : consultez immédiatement les résultats de la requête dans votre format préféré (affichage Table, JSON ou Arborescence).

    • Changez facilement de vue en utilisant le menu déroulant Affichage.
  • Exécuter des requêtes directement : écrivez et exécutez des requêtes MongoDB avec des fonctionnalités comme la mise en surbrillance de la syntaxe et l’auto-complétion.

    • Pour exécuter votre requête, sélectionnez le bouton Rechercher une requête ou appuyez Ctrl/Cmd+Enter sur l’éditeur de requête.

Remarque

Seules les requêtes de recherche de requête sont prises en charge. Des fonctionnalités de requête étendues seront bientôt disponibles.

Affichages de données flexibles

Explorez vos données en utilisant plusieurs affichages pour diverses perspectives :

  • Affichage JSON : consultez la structure de données JSON brute.

    Capture d’écran de l’extension VS-code d’une instance MongoDB en mode JSON.

  • Arborescence : naviguez et explorez des données imbriquées sans aucun effort.

    Capture d’écran de l’extension VS Code d’une instance MongoDB en mode arborescence.

  • Affichage Table : analysez rapidement des données et explorez au niveau du détail des documents imbriqués.

    • Pour explorer au niveau du détail : recherchez des entrées avec l’icône {} qui indique des objets incorporés. Double-cliquez pour développer et afficher du contenu.

    • Pour revenir en arrière : revenez aux niveaux précédents à l’aide des barres de navigation sous l’affichage Tableau.

    Capture d’écran de l’extension VS-code d’une instance MongoDB en mode Table.

Intégration d’interpréteur de commandes Mongo

La fonctionnalité de ligne de commande est disponible :

  • Lancementmongosh : exécutez des commandes MongoDB avancées directement à partir de Visual Studio Code.

Remarque

L’interpréteur de commandes MongoDB (mongosh) n’est pas inclus dans l’extension. Il doit être installé séparément et configuré manuellement.

Gestion du cluster

Restez informé sur vos ressources :

  • Afficher les détails d’un cluster : consultez le niveau de votre cluster, la version de serveur et l’utilisation des ressources.

  • Gérer les étiquettes : organisez vos clusters avec des balises qui se synchronisent avec le portail Azure.