SQL Server-Erweiterung für Visual Studio Code

Gilt für:SQL ServerAzure SQL-DatenbankAzure SQL Managed InstanceAzure Synapse Analytics

In diesem Artikel wird gezeigt, wie Sie die mssql-Erweiterung für Visual Studio Code verwenden, um mit Datenbanken in SQL Server unter Windows, macOS und Linux sowie mit Azure SQL-Datenbank, Azure SQL Managed Instance und Azure Synapse Analytics zu arbeiten. Die mssql-Erweiterung für Visual Studio Code ermöglicht Ihnen das Herstellen einer Verbindung mit einer SQL Server-Instanz, das Abfragen mithilfe von Transact-SQL (T-SQL) und das Anzeigen der Ergebnisse.

Erstellen oder Öffnen einer SQL-Datei

Die mssql-Erweiterung ermöglicht mssql-Befehle und T-SQL-IntelliSense im Code-Editor, wenn der Sprachmodus auf SQL festgelegt ist.

  1. Klicken Sie auf Datei>Neue Datei, oder drücken Sie STRG+N. Visual Studio Code öffnet standardmäßig eine neue Nur-Textdatei.

  2. Wählen Sie Nur-Text in der unteren Statusleiste aus, oder drücken Sie STRG+K>M, und wählen Sie SQL aus der Dropdownliste für Sprachen aus.

    Screenshot der Visual Studio Code G U I, SQL Sprachmodus.

    Hinweis

    Wenn Sie die Erweiterung zum ersten Mal verwenden, installiert die Erweiterung den SQL Tools Service-Dienst im Hintergrund.

Wenn Sie eine vorhandene Datei mit der Erweiterung .sql öffnen, wird der Sprachmodus automatisch auf SQL festgelegt.

Verbindung mit SQL Server herstellen

Führen Sue die folgenden Schritte aus, um ein Verbindungsprofil zu erstellen und eine Verbindung mit einer SQL Server-Instanz herzustellen.

  1. Drücken Sie STRG+UMSCHALT+P oder F1, um die Befehlspalette zu öffnen.

  2. Geben Sie sql ein, um die mssql-Befehle anzuzeigen, oder geben Sie sqlcon ein, und wählen Sie dann im Dropdownmenü MS SQL: Connect aus.

    Screenshot der Visual Studio Code G U I, m s s q l Sprachmodus.

    Hinweis

    Eine SQL-Datei wie die leere SQL-Datei, die Sie erstellt haben, muss im Code-Editor über den Fokus verfügen, bevor Sie die mssql-Befehle ausführen können.

  3. Wählen Sie den Befehl MS SQL: Manage Connection Profiles aus.

  4. Klicken Sie anschließend auf Erstellen, um ein neues Verbindungsprofil für Ihre SQL Server-Instanz zu erstellen.

  5. Befolgen Sie die Anweisungen, um die Eigenschaften für das neue Verbindungsprofil anzugeben. Nachdem Sie sämtliche Werte angegeben haben, drücken Sie die EINGABETASTE, um fortzufahren.

    Verbindungseigenschaft BESCHREIBUNG
    Servername oder ADO-Verbindungszeichenfolge Gibt den Namen der SQL Server-Instanz an. Verwenden Sie localhost, um eine Verbindung mit einer SQL Server-Instanz auf Ihrem lokalen Computer herzustellen. Geben Sie den Namen oder die IP-Adresse der SQL Server-Zielinstanz ein, um eine Verbindung mit einer SQL Server-Remoteinstanz herzustellen. Geben Sie die IP-Adresse des Hostcomputers des Containers an, um eine Verbindung mit einem SQL Server-Container herzustellen. Wenn Sie einen Port festlegen müssen, verwenden Sie ein Komma, um ihn vom Namen zu trennen. Geben Sie für einen Server, der an Port 1401 lauscht, beispielsweise <servername or IP>,1401 ein.

    Standardmäßig verwendet die Verbindungszeichenfolge Port 1433. Sofern keine andere Einstellung vorgenommen wird, verwenden Standardinstanzen von SQL Server Port 1433. Wenn Ihre Instanz an Port 1433 lauscht, müssen Sie den Port nicht angeben.

    Alternativ können Sie hier die ADO-Verbindungszeichenfolge für Ihre Datenbank eingeben.
    Datenbankname (optional) Hier können Sie die Datenbank angeben, die Sie verwenden möchten. Geben Sie hier keinen Datenbanknamen an, wenn Sie eine Verbindung mit der Standarddatenbank herstellen möchten.
    Authentifizierungstyp Wählen Sie entweder Integriert oder SQL-Anmeldung aus.
    Benutzername Wenn Sie SQL-Anmeldung ausgewählt haben, geben Sie den Namen eines Benutzers mit Zugriff auf eine Datenbank auf dem Server aus.
    Kennwort Geben Sie das Kennwort für den angegebenen Benutzer ein.
    Kennwort speichern Drücken Sie die EINGABETASTE, um Ja auszuwählen und das Kennwort zu speichern. Wählen Sie Nein aus, um bei jeder Verwendung des Verbindungsprofils zur Eingabe des Kennworts aufgefordert zu werden.
    Profilname (optional) Geben Sie einen Namen für das Verbindungsprofil ein, z. B. localhost-Profil.

    Sobald Sie alle Werte eingegeben und auf Eingeben geklickt haben, erstellt Visual Studio Code das Verbindungsprofil und stellt eine Verbindung zur SQL Server-Instanz her.

    Tipp

    Wenn die Verbindung fehlschlägt, versuchen Sie das Problem mithilfe der Fehlermeldung im Ausgabebereich in Visual Studio Code zu diagnostizieren. Klicken Sie auf Ansicht>Ausgabe, um den Ausgabebereich zu öffnen. Überprüfen Sie auch die Empfehlungen zur Verbindungsproblembehandlung.

  6. Überprüfen Sie Ihre Verbindung in der unteren Statusleiste.

    Screenshot der Visual Studio Code G U I, Verbindungsstatus.

Alternativ zu den vorherigen Schritten können Sie Verbindungsprofile auch in der Benutzereinstellungsdatei (settings.json) erstellen und bearbeiten. Klicken Sie auf Datei>Einstellungen>Einstellungen, um die Einstellungsdatei zu öffnen. Weitere Informationen finden Sie unter Manage connection profiles (Verwalten von Verbindungsprofilen).

Verschlüsseln und Vertrauen des Serverzertifikats

Die mssql-Erweiterung für VS Code v1.17.0 und höher enthält eine wichtige Änderung der Eingenschaft „Verschlüsseln“, die jetzt standardmäßig für MSSQL-Anbieterverbindungen aktiviert ist (auf TRUE festgelegt). Außerdem muss SQL Server mit TLS-Zertifikaten konfiguriert werden, die von einer vertrauenswürdigen Stammzertifizierungsstelle signiert sind. Wenn zusätzlich bei einem anfänglichen Verbindungsversuch mit aktivierter Verschlüsselung (Standard) ein Fehler auftritt, stellt die MSSQL-Erweiterung eine Benachrichtigungseingabeaufforderung mit einer Option bereit, zu versuchen, die Verbindung mit aktiviertem vertrauenswürdigem Serverzertifikat herzustellen. Sowohl die Zertifikateigenschaften „Verschlüsseln“ als auch „Vertrauen“ sind auch für die manuelle Bearbeitung in der Benutzereinstellungsdatei (settings.json) verfügbar. Die bewährte Methode besteht darin, eine vertrauenswürdige verschlüsselte Verbindung mit dem Server zu unterstützen.

Screenshot: Visual Studio Code GUI, Benachrichtigung mit Aufforderung zum Zertifikat des Vertrauensservers

Für Benutzer*innen, die eine Verbindung mit Azure SQL-Datenbank herstellen, sind keine Änderungen an vorhandenen, gespeicherten Verbindungen erforderlich. Azure SQL-Datenbank unterstützt verschlüsselte Verbindungen und ist mit vertrauenswürdigen Zertifikaten konfiguriert.

Vergewissern Sie sich für Benutzer*innen, die eine Verbindung mit einer lokalen SQL Server-Instanz oder mit SQL Server auf einer VM herstellen, wenn Verschlüsseln auf True festgelegt ist, dass Sie über ein Zertifikat von einer vertrauenswürdigen Zertifizierungsstelle verfügen (z. B. kein selbstsigniertes Zertifikat). Alternativ können Sie eine Verbindung ohne Verschlüsselung herstellen (Verschlüsseln auf False festgelegt) oder dem Serverzertifikat vertrauen (Verschlüsseln auf True und Serverzertifikat vertrauen auf True festgelegt).

Erstellen einer Datenbank

  1. Geben Sie sql in die neue SQL-Datei ein, die Sie zuvor gestartet haben, um eine Liste bearbeitbarer Codeausschnitte anzuzeigen.

    Screenshot des Editors in Visual Studio Code, SQL-Ausschnitte.

  2. Wählen Sie sqlCreateDatabase aus.

  3. Ersetzen Sie „DatabaseName“ im Codeausschnitt durch TutorialDB:

    -- 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. Drücken Sie STRG+UMSCHALT+E, um die Transact-SQL-Befehle auszuführen. Sehen Sie sich die Ergebnisse im Abfragefenster an.

    Screenshot der Visual Studio Code G U I, Datenbanknachrichten erstellen.

    Tipp

    Sie können die Tastenkombinationen für die mssql-Befehle anpassen. Weitere Informationen hierzu finden Sie unter Customize shortcuts (Anpassen von Tastenkombinationen).

Erstellen einer Tabelle

  1. Löschen Sie den Inhalt im Fenster des Code-Editors.

  2. Drücken Sie STRG+UMSCHALT+P oder F1, um die Befehlspalette zu öffnen.

  3. Geben Sie sql ein, um die mssql-Befehle anzuzeigen, oder geben Sie sqluse ein, und wählen Sie dann den Befehl MS SQL: Use Database aus.

  4. Wählen Sie die neue Datenbank TutorialDB aus.

    Screenshot der Visual Studio Code G U I, Datenbank auswählen.

  5. Geben Sie sql im Code-Editor ein, um die Ausschnitte anzuzeigen. Wählen Sie sqlCreateTable aus, und drücken Sie dann die EINGABETASTE.

  6. Geben Sie im Codeausschnitt Employees als Tabellennamen ein.

  7. Drücken Sie die TAB-TASTE, um zum nächsten Feld zu gelangen, und geben Sie dann dbo als Schemanamen ein.

  8. Ersetzen Sie die Spaltendefinitionen durch die folgenden Spalten:

    EmployeesId INT NOT NULL PRIMARY KEY,
    Name [NVARCHAR](50)  NOT NULL,
    Location [NVARCHAR](50)  NOT NULL
    
  9. Drücken Sie STRG+UMSCHALT+E, um die Tabelle zu erstellen.

Einfügen und Abfragen

  1. Fügen Sie die folgenden Anweisungen hinzu, um vier Zeilen in die Tabelle Employees einzufügen.

    -- 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
    

    Beim Schreiben unterstützt Sie T-SQL-IntelliSense bei der Vervollständigung der Anweisungen:

    Screenshot der Visual Studio Code U I , T-SQL IntelliSense.

    Tipp

    Die mssql-Erweiterung verfügt ebenfalls über Befehle, die Ihnen beim Erstellen von INSERT- und SELECT-Anweisungen helfen. Diese wurden im vorherigen Beispiel nicht verwendet.

  2. Drücken Sie STRG+UMSCHALT+E, um die Befehle auszuführen. Die beiden Ergebnisse werden im Fenster Ergebnisse angezeigt.

    Screenshot der Visual Studio Code U I, der Ergebnisbereich.

Anzeigen und Speichern der Ergebnisse

  1. Klicken Sie auf Ansicht>Editorlayout>Layout spiegeln, um zwischen einem vertikal oder horizontal aufgeteilten Layout zu wechseln.

  2. Wählen Sie die Header der Bereiche Ergebnisse und Nachrichten aus, um die Bereiche zuzuklappen oder aufzuklappen.

    Screenshot der Visual Studio Code U I, Header umschalten.

    Tipp

    Sie können das Standardverhalten der mssql-Erweiterung anpassen. Informationen dazu finden Sie unter Customize extension options (Anpassen der Erweiterungsoptionen).

  3. Klicken Sie im zweiten Ergebnisraster auf das Symbol „Raster maximieren“, um diese Ergebnisse zu vergrößern.

    Screenshot der Visual Studio Code U I, Raster maximieren.

    Hinweis

    Das Symbol wird angezeigt, wenn Ihr T-SQL-Skript mindestens zwei Ergebnisraster erzeugt.

  4. Öffnen Sie das Rasterkontextmenü, indem Sie mit der rechten Maustaste auf das Raster klicken.

    Screenshot der Visual Studio Code U I, Kontextmenü.

  5. Wählen Sie Alles auswählen aus.

  6. Öffnen Sie das Rasterkontextmenü erneut, und wählen Sie Als JSON speichern aus, um das Ergebnis in einer JSON-Datei zu speichern.

  7. Geben Sie einen Dateinamen für die JSON-Datei an.

  8. Überprüfen Sie, ob die JSON-Datei gespeichert wurde und in Visual Studio Code geöffnet werden kann.

    Screenshot des Editors in Visual Studio Code U I, als J SON speichern.

Wenn Sie SQL-Skripts für die Verwaltung oder für ein größeres Entwicklungsprojekt später speichern und ausführen müssen, speichern Sie die Skripts mit der Erweiterung .sql.

Nächste Schritte