Extension SQL Server pour Visual Studio Code

S’applique à : SQL Server Azure SQL Database Azure SQL Managed Instance Azure Synapse Analytics

Cet article explique comment utiliser l’extension mssql pour Visual Studio Code (Visual Studio Code) pour utiliser des bases de données dans SQL Server sur Windows, macOS et Linux, ainsi qu’Azure SQL Database, Azure SQL Managed Instance et Azure Synapse Analytics. L’extension mssql pour Visual Studio Code vous permet de vous connecter à une instance SQL Server, d’effectuer une requête avec Transact-SQL (T-SQL) et d’afficher les résultats.

Créer ou ouvrir un fichier SQL

L’extension mssql active les commandes mssql et T-SQL IntelliSense dans l’éditeur de code lorsque le mode de langage est défini sur SQL.

  1. Sélectionnez Fichier>Nouveau fichier, ou appuyez sur Ctrl+N. Visual Studio Code ouvre par défaut un nouveau fichier texte brut.

  2. Sélectionnez Texte brut dans la barre d’état inférieure, ou appuyez sur Ctrl+K>M et sélectionnez SQL à partir de la liste déroulante de langages.

    Capture d’écran de l’interface Visual Studio Code, mode Langage SQL.

    Remarque

    Si c’est la première fois que vous utilisez l’extension, elle installe le service SQL Tools en arrière-plan.

Si vous ouvrez un fichier existant qui a une extension de fichier .sql, le mode de langage est automatiquement défini sur SQL.

Se connecter à SQL Server

Procédez comme suit pour créer un profil de connexion et vous connecter à une instance SQL Server.

  1. Appuyez sur Ctrl+MAJ+P ou sur F1 pour ouvrir la palette de commandes.

  2. Tapez sql pour afficher les commandes mssql ou tapez sqlcon, puis sélectionnez MS SQL : Se connecter dans la liste déroulante.

    Capture d’écran de la palette de commandes Visual Studio Code, filtrée pour les commandes « MS SQL ».

    Remarque

    Un fichier SQL tel que le fichier SQL vide que vous avez créé doit avoir son focus dans l’éditeur de code avant que vous puissiez exécuter les commandes mssql.

  3. Sélectionnez la commande MS SQL : Gérer les profils de connexion.

  4. Sélectionnez ensuite Créer afin de créer un profil de connexion pour votre instance SQL Server.

  5. Suivez les invites afin de spécifier les propriétés du nouveau profil de connexion. Après avoir spécifié chaque valeur, appuyez sur Entrée pour continuer.

    Propriété de connexion Description
    Nom du serveur ou chaîne de connexion ADO Spécifiez le nom de l'instance SQL Server. Utilisez localhost pour vous connecter à une instance SQL Server sur votre ordinateur local. Pour vous connecter à une instance SQL Server distante, entrez le nom de l’instance SQL Server cible ou son adresse IP. Pour vous connecter à un conteneur SQL Server, spécifiez l’adresse IP de l’ordinateur hôte du conteneur. Si vous devez spécifier un port, utilisez une virgule pour le séparer du nom. Par exemple, pour un serveur qui écoute sur le port 1401, entrez <servername or IP>,1401.

    Par défaut, la chaîne de connexion utilise le port 1433. Une instance par défaut de SQL Server utilise 1433, sauf en cas de modification. Si votre instance écoute sur 1433, vous n’avez pas besoin de spécifier le port.
    Vous pouvez également entrer ici la chaîne de connexion ADO pour votre base de données.
    Nom de base de données (facultatif) La base de données à utiliser. Pour vous connecter à la base de données par défaut, ne spécifiez pas de nom de base de données ici.
    Type d'authentification Choisissez Intégrée ou SQL.
    Nom d'utilisateur Si vous avez sélectionné Connexion SQL, entrez le nom d’un utilisateur ayant accès à une base de données sur le serveur.
    Mot de passe Entrez le mot de passe de l'utilisateur spécifié.
    Enregistrer le mot de passe Appuyez sur Entrée pour sélectionner Oui et enregistrer le mot de passe. Sélectionnez Non pour être invité à entrer le mot de passe chaque fois que le profil de connexion est utilisé.
    Nom du profil (facultatif) Tapez un nom pour le profil de connexion, par exemple profil localhost.

    Une fois que vous avez entré toutes les valeurs et sélectionné Entrée, Visual Studio Code crée le profil de connexion et se connecte à l’instance SQL Server.

    Conseil

    Si la connexion échoue, essayez de diagnostiquer le problème à partir du message d’erreur dans le panneau Sortie de Visual Studio Code. Pour ouvrir le panneau Sortie, sélectionnez Afficher>Sortie. Examinez également les recommandations en matière de résolution des problèmes de connexion.

  6. Vérifiez votre connexion dans la barre d’état inférieure.

    Capture d’écran de l’interface Visual Studio Code, état de la connexion.

Comme alternative aux étapes précédentes, vous pouvez également créer et modifier des profils de connexion dans le fichier de paramètres utilisateur(settings.json). Pour ouvrir le fichier de paramètres, sélectionnez Fichier>Préférences>Paramètres. Pour plus d’informations, consultez Gérer les profils de connexion.

Chiffrer et faire confiance au certificat de serveur

À compter de l’extension mssql pour VS Code v1.17.0 :

  • La propriété Encrypt est activée (définie sur True) par défaut pour les connexions de fournisseur MSSQL
  • SQL Server doit être configuré avec des certificats TLS signés par une autorité de certification racine approuvée

Par ailleurs, si une tentative de connexion initiale échoue avec le chiffrement activé (valeur par défaut), l’extension mssql fournit une invite de notification offrant la possibilité de tenter la connexion avec la propriété Faire confiance au certificat de serveur activée.

Vous pouvez modifier les propriétés Chiffrer et Faire confiance au certificat de serveur dans le fichier de paramètres utilisateur (settings.json). La bonne pratique consiste à prendre en charge une connexion chiffrée de confiance au serveur.

Capture d’écran de l’interface utilisateur graphique de Visual Studio Code, Notification avec invite pour Faire confiance au certificat de serveur.

Pour les utilisateurs qui se connectent à Azure SQL Database, il n’y a aucun changement, il faut des connexions sécurisées. Azure SQL Database prend en charge les connexions chiffrées et est configuré avec des certificats approuvés.

Pour les utilisateurs qui se connectent à un serveur SQL Server local ou à SQL Server dans une machine virtuelle, si Chiffrer a la valeur Vrai, assurez-vous de disposer d’un certificat provenant d’une autorité de certification de confiance (p. ex., pas un certificat auto-signé). Vous pouvez également choisir de vous connecter sans chiffrement (Chiffrer défini sur Faux) ou de faire confiance au certificat de serveur (Chiffrer défini sur Vrai et Faire confiance au certificat de serveur défini sur Vrai).

Création d'une base de données

  1. Dans le nouveau fichier SQL que vous avez démarré précédemment, tapez sql pour afficher une liste d’extraits de code modifiables.

    Capture d’écran de l’interface utilisateur graphique de Visual Studio Code, extraits de code SQL.

  2. Sélectionnez sqlCreateDatabase.

  3. Dans l’extrait de code, tapez TutorialDB pour remplacer « DatabaseName » :

    -- Create a new database called 'TutorialDB'
    -- Connect to the 'master' database to run this snippet
    USE master
    GO
    IF NOT EXISTS (
       SELECT name
       FROM sys.databases
       WHERE name = N'TutorialDB'
    )
    CREATE DATABASE [TutorialDB]
    GO
    
  4. Appuyez sur Ctrl+MAJ+E pour exécuter les commandes Transact-SQL. Affichez les résultats dans la fenêtre de requête.

    Capture d’écran de l’interface Visual Studio Code, créer des messages de base de données.

    Conseil

    Vous pouvez personnaliser les touches de raccourci pour les commandes mssql. Consultez Personnaliser les raccourcis.

Créer une table

  1. Supprimez les contenus de la fenêtre de l’éditeur de code.

  2. Appuyez sur Ctrl+MAJ+P ou sur F1 pour ouvrir la palette de commandes.

  3. Tapez sql pour afficher les commandes mssql ou tapez sur sqluse, puis sélectionnez la commande MS SQL : Utiliser une base de données.

  4. Sélectionnez la nouvelle base de données TutorialDB.

    Capture d’écran de l’interface Visual Studio Code, choix d’une base de données.

  5. Dans l’éditeur de code, tapez sql pour afficher les extraits de code, sélectionnez sqlCreateTable, puis appuyez sur Entrée.

  6. Dans l’extrait de code, tapez Employees pour le nom de la table.

  7. Appuyez sur Onglet pour accéder au champ suivant, puis tapez dbo pour le nom du schéma.

  8. Remplacez les définitions de colonne par les colonnes suivantes :

    EmployeesId INT NOT NULL PRIMARY KEY,
    Name [NVARCHAR](50)  NOT NULL,
    Location [NVARCHAR](50)  NOT NULL
    
  9. Appuyez sur Ctrl+MAJ+E pour créer la table.

Insérer et interroger

  1. Ajoutez les instructions suivantes pour insérer quatre lignes dans la table Employees.

    -- Insert rows into table 'Employees'
    INSERT INTO Employees
       ([EmployeesId],[Name],[Location])
    VALUES
       ( 1, N'Jared', N'Australia'),
       ( 2, N'Nikita', N'India'),
       ( 3, N'Tom', N'Germany'),
       ( 4, N'Jake', N'United States')
    GO
    -- Query the total count of employees
    SELECT COUNT(*) as EmployeeCount FROM dbo.Employees;
    -- Query all employee information
    SELECT e.EmployeesId, e.Name, e.Location
    FROM dbo.Employees as e
    GO
    

    Pendant que vous tapez, T-SQL IntelliSense vous aide à compléter les instructions :

    Capture d’écran de l’interface Visual Studio Code, IntelliSense T-SQL.

    Conseil

    L’extension mssql contient également des commandes pour vous aider à créer des instructions INSERT et SELECT. Elles n’étaient pas utilisées dans l’exemple précédent.

  2. Appuyez sur Ctrl+MAJ+E pour exécuter les commandes. Les deux jeux de résultats s’affichent dans la fenêtre Résultats.

    Capture d’écran de l’interface Visual Studio Code, volet Résultats.

Affichez et enregistrez le résultat

  1. Sélectionnez Afficher>Disposition de l’éditeur>Disposition de basculement pour passer à une disposition de division verticale ou horizontale.

  2. Sélectionnez les en-têtes Résultats et Messages du panneau pour réduire et développer les panneaux.

    Capture d’écran de l’interface Visual Studio Code, basculer les en-têtes.

    Conseil

    Vous pouvez personnaliser le comportement par défaut de l’extension mssql. Consultez Options de personnalisation d’extension.

  3. Sélectionnez l’icône d’agrandissement de la grille sur la deuxième grille de résultats pour effectuer un zoom avant sur ces résultats.

    Capture d’écran de l’interface Visual Studio Code, agrandir la grille au maximum.

    Remarque

    L’icône d’agrandissement s’affiche lorsque votre script T-SQL produit au moins deux grilles de résultats.

  4. Ouvrez le menu contextuel de la grille en cliquant avec le bouton droit sur la grille.

    Capture d’écran de l’interface Visual Studio Code, menu contextuel.

  5. Sélectionnez Sélectionner tout.

  6. Rouvrez le menu contextuel de la grille et sélectionnez Enregistrer au format JSON pour enregistrer le résultat dans un fichier .json.

  7. Spécifiez un nom de fichier pour le fichier JSON.

  8. Vérifiez que le fichier JSON est enregistré et s’ouvre dans Visual Studio Code.

    Capture d’écran de l’interface Visual Studio Code, Enregistrer au format JSON.

Si vous avez besoin d’enregistrer et d’exécuter ultérieurement des scripts SQL, pour l’administration ou pour un projet de développement plus important, enregistrez les scripts avec une extension .sql.