Schnellstart: Verwenden des GitHub-Copilot-Agent-Modus

Im Agentmodus kann GitHub Copilot die von der MSSQL-Erweiterung für Visual Studio Code bereitgestellten Tools orchestrieren. Wenn die Erweiterung installiert und aktiv ist, kann GitHub Copilot Microsoft SQL Server-Verbindungen auflisten, sich mit einem Server und einer Datenbank verbinden, Schema-Metadaten abrufen, Abfragen ausführen und die Leistung des Abfragespeicher untersuchen – alles über Spracheingaben in natürlicher Sprache. Die Genehmigungsanforderungen hängen vom Tool ab.

Alle Aktionen verwenden denselben Verbindungskontext und dieselben Anmeldeinformationen wie die MSSQL-Erweiterung. Der Agentmodus führt keine weiteren Authentifizierungs- oder Berechtigungsänderungen ein.

Tip

Verwenden Sie den Agentmodus für mehrstufige Arbeitsabläufe, umfangreiche Erkundungen und delegierte Änderungen. Verwenden Sie Fragemodus, wenn Sie eine einzelne Antwort oder eine einmalige Abfrage benötigen. Verwenden Sie den Planungsmodus, wenn Sie vor dem Schreiben von Transact-SQL (T-SQL)-Data Definition Language (DDL) einen Entwurf durchdenken müssen.

Wichtige Erkenntnisse

  • Der Agentmodus nimmt MSSQL-Erweiterungstools automatisch auf. Keine @mssql Nennung erforderlich.
  • Überprüfen und genehmigen Sie Toolaufrufe, wenn Sie darum aufgefordert werden. Diagnoselesevorgänge im Abfragespeicher erfordern keine Bestätigung; das Erzwingen oder Aufheben der Erzwingung eines Plans erfordert eine Prüfung und Bestätigung.
  • Der Agentmodus ist über seine Tools schemafähig : Jeder Toolaufruf gibt echte Daten aus Ihrer verbundenen Datenbank zurück.
  • Informationen zum Architekturkontext auf allen Oberflächen finden Sie unter How GitHub Copilot works with the MSSQL extension.

Wann der Agentmodus verwendet werden sollte

Der Agentmodus eignet sich am besten für:

  • Mehrstufige Workflows. „Eine Verbindung mit LocalDev herstellen, zu AdventureWorks wechseln und mir jede Tabelle mit einem Fremdschlüssel zu Customer anzeigen”.
  • Erkundung in großem Maßstab. "Suchen Sie alle gespeicherten Prozeduren, die auf SalesOrderHeader verweisen, und fassen Sie zusammen, was jeder tut."
  • Leistungsanalysen. "Verwenden Sie den Abfragespeicher, um die CPU-Anfragen mit der höchsten Anzahl der letzten 24 Stunden zu finden, und analysieren Sie dann die Historie, Wartezeiten und Pläne der Topabfrage."
  • Delegierte Änderungen. "Fügen Sie jeder Tabelle im Schema "Vertrieb" Überwachungsspalten hinzu, und generieren Sie die zugehörigen gespeicherten Prozeduren neu."

Verwenden Sie den Ask-Modus , wenn eine einzelne Frage oder eine Einzelabfrage Ihren Bedarf beantwortet. Verwenden Sie Schrägstrichbefehle , wenn Sie bereits wissen, welche Aktion Sie verwenden möchten. Verwenden Sie den Planmodus , wenn Sie einen schriftlichen Plan vor Änderungen wünschen.

Ausführliche Informationen dazu, wie der Agentmodus Tools auswählt und ausführt, finden Sie in der Visual Studio Code Dokumentation zum Agentmodus.

Was ist der Agentmodus?

Im Agent-Modus kann GitHub Copilot SQL-bezogene Aktionen mithilfe der MSSQL-Erweiterung ausführen. Tools, die eine Bestätigung erfordern, zeigen die angeforderte Aktion vor der Ausführung zur Überprüfung an.

Sie können diese Aktionen aufrufen, indem Sie Chatvariablen wie #mssql_connectz. B. oder entsprechende Anforderungen in natürlicher Sprache ausgeben, z. B.:

Connect to my Library database using my LocalDev profile

Screenshot der GitHub Copilot Agent Mode-Chatoberfläche.

MSSQL-Agentmodus-Toolreferenz

Dieser Abschnitt enthält eine detaillierte Referenz zu den SQL-spezifischen Tools, die im GitHub Copilot Agent Mode verfügbar sind. Die MSSQL-Erweiterung trägt diese Tools bei, sodass GitHub Copilot Aktionen über Chatvariablen oder Aufforderungen in natürlicher Sprache ausführt. Abfragespeicher-Diagnosetools lesen erfasste Leistungsdaten, ohne eine Bestätigung anzufordern. Überprüfen und genehmigen Sie weitere Maßnahmen, wenn Sie dazu aufgefordert werden.

Screenshot einer Liste SQL-spezifischer Werkzeuge, die von der MSSQL-Erweiterung im Copilot agent-Modus beigesteuert wurden.

Tip

Sie können auch Chatvariablen wie #mssql_connect verwenden, um diese Tools direkt aufzurufen oder Eingabeaufforderungen in natürlicher Sprache zu schreiben, zum Beispiel, indem Sie Aufforderungen in natürlicher Sprache schreiben:

Connect to my development database

GitHub Copilot behandelt die Toolauswahl automatisch.

Verbindungsverwaltung

TPoolname Description
connect Stellt eine Verbindung zu einer Datenbank mithilfe eines gespeicherten Verbindungsprofils oder eines angegebenen Servers und einer angegebenen Datenbank her.
disconnect Beendet die aktuelle aktive Verbindungssitzung.
change_database Ändert die Datenbank für eine vorhandene Verbindungssitzung.
get_connection_details Ruft Verbindungsdetails für eine bestimmte MSSQL-Verbindung ab.
list_servers Listet alle gespeicherten SQL Server-Verbindungsprofile in Ihrer Umgebung auf.
list_databases Listet alle verfügbaren Datenbanken für einen verbundenen MSSQL-Server auf.

Examples

Verwenden Sie die folgenden Ausdrücke, um mit GitHub Copilot zu interagieren.

- Connect to my LocalDev environment
- Disconnect from my current database
- List my available connection profiles
- List all databases in the localhost server
- Set the active connection to localhost
- Set AdventureWorks as the active database
- Get the connection string for AdventureWorks on localhost

Screenshot eines Beispiels, bei dem man ein Agent-Tool verwendet, um sich im GitHub Copilot-Chat mit einer Datenbank zu verbinden.

Funktionsweise der Verbindungslogik

Der GitHub Copilot Agent Mode unterstützt flexible Methoden zum Herstellen einer Verbindung mit Ihrer SQL-Datenbank, entweder durch Verweisen auf gespeicherte Profile oder durch direkte Angabe eines Servers und einer Datenbank. Hier erfahren Sie, wie die Verbindungslogik funktioniert.

Wenn Sie eine Verbindung mit einem gespeicherten Profil herstellen:

  1. Sie stellen eine Verbindung her, indem Sie auf den Namen eines gespeicherten Verbindungsprofils verweisen.
  2. GitHub Copilot verwendet das mssql_list_servers Tool, um zu überprüfen, ob das Profil vorhanden ist.
  3. Das mssql_connect Tool verwendet dann die gespeicherten profileId und zugehörigen Parameter, um die Verbindung herzustellen.

Wenn Sie eine Verbindung herstellen, indem Sie einen Server und eine Datenbank angeben:

  • Wenn ein gespeichertes Profil mit dem angegebenen Server und der angegebenen Datenbank übereinstimmt:

    1. GitHub Copilot verwendet mssql_list_servers , um die Übereinstimmung zu finden.
    2. Anschließend wird mssql_connect mit dem vollständigen Profil aufgerufen.
  • Wenn ein gespeichertes Profil nur mit dem Server übereinstimmt:

    1. GitHub Copilot findet das entsprechende Serverprofil.
    2. Es wird versucht, eine Verbindung herzustellen, indem die vom Benutzer angeforderte Datenbank in dieses Profil eingefügt wird.
    3. Wenn die Verbindung fehlschlägt, wird ein Fehler angezeigt.
  • Wenn kein Profil mit dem angegebenen Server übereinstimmt:

    • GitHub Copilot meldet einen Fehler.

Dieses flexible Abgleichssystem ermöglicht es GitHub Copilot, verschiedene Verbindungsszenarien zu verarbeiten. Dadurch wird der Benutzeraufwand minimiert, während sichere, bestätigbare Aktionen sichergestellt werden.

Schema-Untersuchung

TPoolname Description
show_schema Zeigt ein allgemeines Diagramm ihres verbundenen Datenbankschemas an, einschließlich Tabellen und Beziehungen.
list_schemas Listet alle Schemas in einer Datenbank für einen verbundenen MSSQL-Server auf.
list_tables Listet alle Tabellen in einer Datenbank für einen verbundenen MSSQL-Server auf.
list_views Listet alle Ansichten in einer Datenbank für einen verbundenen MSSQL-Server auf.
list_functions Listet alle Funktionen in einer Datenbank für einen verbundenen MSSQL-Server auf.

Examples

Verwenden Sie die folgenden Ausdrücke, um mit GitHub Copilot zu interagieren.

- Show me the schema for this database
- Show me all tables in the current database
- List all views from this MSSQL database
- Give me a list of all the functions available in this schema
- What schemas are available in this database?

Screenshot einer Animation, die das Datenbank-Schema-Visualizer-Tool im Copilot-Agent-Modus zeigt.

Abfrageausführung

TPoolname Description
run_query Führt eine SQL-Abfrage für die verbundene Datenbank aus.

Examples

Verwenden Sie die folgenden Ausdrücke, um mit GitHub Copilot zu interagieren.

- Give me the top five posts published this week
- Execute the current file to find how many comments each post has
- Get all categories along with the number of posts in each

Screenshot eines Beispiels, bei dem man ein Agent-Tool verwendet, um sich mit einer Datenbank zu verbinden und Daten abzurufen.

Screenshot eines weiteren Beispiels mit einem Agent-Werkzeug, um sich mit einer Datenbank zu verbinden und Daten abzurufen.

Abfragespeicher-Performance-Tools (Vorschau)

Verwenden Sie diese Tools, um die Leistung erfasster Abfragen zu untersuchen, anstatt SQL diagnostisch manuell zu erstellen. Sie benötigen eine Datenbank, die Abfragespeicher unterstützt, erfasste Daten für den von Ihnen angeforderten Zeitraum sowie die Berechtigung, diese Daten zu lesen. Sie können ein Ziel über eine bestehende Verbindung oder ein gespeichertes Verbindungsprofil und einen Datenbanknamen identifizieren.

TPoolname Description
mssql_query_store_status Liest den Abfragespeicher-Zustand, die Gründe für den Nur-Lese-Modus und den verfügbaren Verlauf.
mssql_query_store_top_queries Findet Abfragen, die nach einer Ressourcenmetrik oder Ausführungszahl in einem Zeitfenster geordnet sind.
mssql_query_store_query_details Liest den Text einer Abfrage, Laufzeitstatistiken und Pläne mit deren Statistiken.
mssql_query_store_query_history Liest die Leistung einer Abfrage im Zeitverlauf aus, einschließlich Statistiken für die Pläne, die in jedem Intervall ausgeführt wurden.
mssql_query_store_wait_stats Liest die Wartezeit nach Kategorie für eine Datenbank, Abfrage oder einen Plan. Erfordert Unterstützung und Erfassung von Wartestatistiken im Abfragespeicher.
mssql_query_store_plan_summary Fasst die Anweisungsinformationen, Warnungen, Fehlindex-Empfehlungen und kostspieligen Operatoren eines gespeicherten Plans zusammen.
mssql_query_store_analyze_query Vereint Abfragedetails, Pläne, Ausführungshistorie, Wartezeiten und Zusammenfassungen der Hauptpläne in einem einzigen Diagnoseaufruf.
mssql_open_performance_dashboard Öffnet das Abfrage-Performance-Dashboard für eine Datenbank oder für eine bestimmte Abfrage und Registerkarte.
mssql_query_store_plan_forcing Erzwingt oder entzieht einen Abfrageplan, nachdem Sie das generierte SQL überprüft und bestätigt haben.
mssql_query_store_verify_forced_plan Prüft, ob Ausführungen, nachdem ein Plan erzwungen wurde, diesen Plan angewendet haben.

Um eine Untersuchung zu starten, identifizieren Sie die Datenbank und den Zeitraum in Ihrem Prompt:

Use Query Store to find the queries with the highest total CPU time in AdventureWorksLT in the past 24 hours. Analyze the top query, explain its execution history and waits, and open it in the performance dashboard. Don't make changes.

Ersetzen Sie den Namen der Beispieldatenbank durch Ihre Datenbank. Sie können auch explizit auf ein Tool verweisen, zum Beispiel #mssql_query_store_analyze_query, wenn Sie die Abfrage-ID und Zieldatenbank bereits kennen.

Die Chat-Aktion des Dashboards öffnet den Agentenmodus und sendet eine Aufforderung, die explizit auf den Server, die Datenbank, die gespeicherte Profil-ID, die Abfrage-ID und den Zeitbereich der ausgewählten Abfrage verweist #mssql_query_store_analyze_query und diese bereitstellt. Für eine Anleitung und Folgeanfragen siehe Leistung im Abfragespeicher untersuchen.

Important

Diagnostische Liesvorgänge verändern die Datenbank nicht und erfordern keine Bestätigung. Das Erzwingen oder Aufheben des Erzwingens eines Plans ist eine separate Änderung: Das Tool präsentiert das genaue SQL sowie alle Warnungen zur Überprüfung und Bestätigung. Die Überprüfung eines erzwungenen Plans ist schreibgeschützt. Diagnostiziere das Problem und prüfe die Belege, bevor du eine Planänderung beantragst.

Die Abfragespeicher-Aufbewahrungs- und Erfassungseinstellungen bestimmen die verfügbaren Daten. Wenn der Abfragespeicher deaktiviert ist oder der angeforderte Zeitraum keine erfassten Daten enthält, können die Tools keine Leistungsdiagnose für diesen Zeitraum liefern. Für Details zur Einrichtung siehe Abfrage-Performance-Dashboard-Voraussetzungen.

Wie Tools im Agentmodus verwaltet werden

GitHub Copilot kann MSSQL-spezifische Tools und andere von der Erweiterung bereitgestellte Tools nutzen, während es Ihre Anforderung verarbeitet. Sie können diese Tools in der Agentmodus-Schnittstelle im Menü "Extras " sehen, wo Sie auch bestimmte Tools aktivieren oder deaktivieren können.

Wenn ein Tool eine Bestätigung erfordert, bittet GitHub Copilot Sie, die angeforderte Aktion zu überprüfen, bevor es ausgeführt wird. Sie können das Tool nur für die aktuelle Sitzung, den Arbeitsbereich oder dauerhaft zulassen. Diagnoselesungen in Abfragespeicher erfordern keine Bestätigung; das Erzwingen und Aufheben von Plänen schon.

Weitere Informationen zur Sichtbarkeit und Genehmigung von Tools finden Sie unter Verwalten von Toolgenehmigungen.

Bestätigungsworkflow für den Agentmodus

Für Tools, die eine Bestätigung erfordern, zeigt GitHub Copilot Details zur angeforderten Aktion an. Überprüfen Sie die Anfrage, bevor Sie eine Genehmigungsoption auswählen:

  • In dieser Sitzung zulassen
  • In diesem Arbeitsbereich zulassen
  • Immer zulassen

Dieser Bestätigungsschritt trägt dazu bei, sichere, absichtliche Interaktionen mit Ihrer Entwicklungsumgebung sicherzustellen.

Note

Weitere Informationen dazu, wie die Bestätigung für alle Tools im Agentmodus funktioniert, finden Sie in der Visual Studio Code-Dokumentation zu Toolgenehmigungen.

Promptkatalog für den Agentenmodus

Verwenden Sie diese Anweisungen in natürlicher Sprache, um MSSQL-Erweiterungstools über den Agentmodus aufzurufen. Für jede Kategorie ist ein entsprechender Slash-Befehl oder Prompt im Fragmodus als Querverweis angegeben.

Verbindungsverwaltung

Connect to my LocalDev profile and set AdventureWorks as the active database.
List all my saved connection profiles and tell me which one I'm currently connected to.
Disconnect from my current database.

Entsprechende Schrägstrichbefehle: /connect, /listServers, /changeDatabase, /disconnect.

Schema-Untersuchung

Show me every table in the SalesLT schema, grouped by whether they're
referenced by a foreign key from another table.
Find all stored procedures that reference SalesLT.SalesOrderHeader and
summarize what each one does in one sentence.
Which tables in the current database have no primary key?

Äquivalente Frage-Prompts finden Sie unter: Mit dem @mssql Teilnehmer chatten.

Abfrageausführung

Run a query to count the number of active customers in SalesLT.Customer,
then show me the top 10 by order total.
Show me the execution plan for this query: SELECT ... FROM ...
Execute the last query I ran against my Dev database instead.

Mehrstufige Workflows

Connect to LocalDev, switch to AdventureWorks, list all tables with a
foreign key to SalesLT.Customer, and save the list to a file called
customer-dependents.md.
Find every stored procedure that uses dynamic SQL and open each one
in a new editor tab so I can review them.

Delegierte Schemaänderungen

Note

Schemaänderungen eignen sich gut dafür, zunächst im Planmodus ausgeführt zu werden. Planen Sie die Änderungen, überprüfen Sie sie, und übergeben Sie dann den Plan zum Agentmodus für die Ausführung.

Add createdAt and updatedAt audit columns to every table in the Sales
schema that doesn't already have them. Use DATETIME2(7) with a default
of GETUTCDATE().
Regenerate every stored procedure that inserts into SalesLT.Customer
to include the new email column.