Início rápido: Usar o modo agente do Copilot do GitHub

O modo Agente permite ao GitHub Copilot orquestrar as ferramentas contribuídas pela extensão MSSQL para Visual Studio Code. Quando a extensão está instalada e ativa, o GitHub Copilot pode listar ligações ao Microsoft SQL Server, ligar-se a um servidor e a uma base de dados, recuperar metadados do esquema, executar consultas e investigar o desempenho do Query Store, tudo a partir de prompts em linguagem natural. Os requisitos de aprovação dependem da ferramenta.

Todas as ações utilizam o mesmo contexto de ligação e credenciais da extensão MSSQL. O modo agente não introduz outra autenticação nem alterações de permissões.

Tip

Use o modo agente para fluxos de trabalho em vários passos, exploração em escala e alterações delegadas. Usa o modo pergunta quando precisares de uma resposta única ou de uma pergunta one-shot. Utilize o modo de plano quando precisar de refletir sobre uma conceção antes de escrever linguagem de definição de dados (DDL) em Transact-SQL (T-SQL).

Principais conclusões

  • O modo agente capta automaticamente as ferramentas de extensão MSSQL. Não @mssql é necessário mencionar.
  • Revise e aprove chamadas de ferramentas quando solicitado. As leituras de diagnóstico do Query Store não solicitam confirmação; forçar ou desforçar um plano requer revisão e confirmação.
  • O modo de agente é ciente do esquema através das ferramentas que utiliza: cada chamada a uma ferramenta devolve dados reais da sua base de dados ligada.
  • Para contexto arquitetónico em todas as superfícies, veja Como o GitHub Copilot funciona com a extensão MSSQL.

Quando usar o modo agente

O modo agente é o melhor para:

  • Fluxos de trabalho em vários passos. Liga-te ao LocalDev, muda para AdventureWorks e depois mostra-me todas as tabelas que tenham uma chave estrangeira para Customer.
  • Exploração em escala. "Encontre quaisquer procedimentos armazenados que refiram ao SalesOrderHeader e resuma o que cada um faz."
  • Investigações de desempenho. Utilize o Query Store para encontrar as consultas com maior utilização de CPU nas últimas 24 horas e, depois, analise o histórico, as esperas e os planos da consulta principal.
  • Alterações delegadas. "Adicionar colunas de auditoria a cada tabela no esquema de Vendas e regenerar os procedimentos armazenados relacionados."

Use modo de pergunta quando uma única pergunta ou uma consulta pontual satisfaz a sua necessidade. Usa comandos de corte quando já sabes qual ação queres. Usa o modo plano quando quiseres um plano escrito antes de qualquer alteração.

Para detalhes sobre como o modo agente seleciona e executa ferramentas, consulte a documentação do Visual Studio Code sobre o modo agente.

O que é o modo agente?

O modo Agente permite ao GitHub Copilot executar ações relacionadas com SQL utilizando a extensão MSSQL. As ferramentas que requerem confirmação apresentam a ação solicitada para revisão antes da execução.

Pode invocar estas ações usando variáveis de chat como #mssql_connect, ou emitindo pedidos equivalentes em linguagem natural, por exemplo:

Connect to my Library database using my LocalDev profile

Captura de ecrã da interface de chat do Modo Agente do GitHub Copilot.

Referência da ferramenta MSSQL Modo de Agente

Esta seção fornece uma referência detalhada para as ferramentas específicas do SQL disponíveis no GitHub Copilot Agent Mode. A extensão MSSQL contribui com essas ferramentas, permitindo que o GitHub Copilot execute ações por meio de variáveis de chat ou prompts de linguagem natural. As ferramentas de diagnóstico do Query Store leem dados de desempenho capturados sem solicitar confirmação. Revise e aprove outras ações quando solicitado.

Captura de ecrã da lista de ferramentas específicas para SQL fornecidas pela extensão MSSQL no modo Copilot agent.

Tip

Você também pode usar variáveis de bate-papo, como #mssql_connect invocar essas ferramentas diretamente, ou escrever prompts em linguagem natural, como:

Connect to my development database

O GitHub Copilot lida com a seleção de ferramentas automaticamente.

Gestão de ligações

Nome da ferramenta Description
connect Liga-se a uma base de dados usando um perfil de ligação guardado ou um servidor e base de dados especificados.
disconnect Termina a sessão de ligação ativa atual.
change_database Altera o banco de dados para uma sessão de conexão existente.
get_connection_details Obtém detalhes de conexão para uma conexão MSSQL específica.
list_servers Lista todos os perfis de conexão do SQL Server salvos em seu ambiente.
list_databases Lista todos os bancos de dados disponíveis para um servidor MSSQL conectado.

Examples

Use as seguintes frases para interagir com o GitHub Copilot.

- 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

Captura de ecrã de exemplo usando uma ferramenta de agente para ligar a uma base de dados no chat GitHub Copilot.

Como funciona a lógica de conexão

O GitHub Copilot Agent Mode suporta maneiras flexíveis de se conectar ao seu banco de dados SQL, seja fazendo referência a perfis salvos ou especificando um servidor e um banco de dados diretamente. Eis como funciona a lógica da ligação.

Quando se liga a um perfil guardado:

  1. Conecta-se consultando o nome de um perfil de ligação guardado.
  2. O GitHub Copilot usa a mssql_list_servers ferramenta para verificar se o perfil existe.
  3. A ferramenta mssql_connect então utiliza os dados guardados de profileId e os seus parâmetros para estabelecer a conexão.

Quando se liga especificando um servidor e uma base de dados:

  • Se um perfil salvo corresponder ao servidor e ao banco de dados especificados:

    1. O GitHub Copilot usa mssql_list_servers para encontrar a correspondência.
    2. Em seguida, liga mssql_connect usando o perfil completo.
  • Se um perfil guardado corresponder apenas a um servidor:

    1. O GitHub Copilot encontra o perfil de servidor correspondente.
    2. Ele tenta se conectar substituindo o banco de dados solicitado pelo usuário nesse perfil.
    3. Se a conexão falhar, um erro será mostrado.
  • Se nenhum perfil corresponder ao servidor especificado:

    • O Copilot do GitHub relata um erro.

Este sistema de correspondência flexível permite ao GitHub Copilot lidar com uma variedade de cenários de ligação. Minimiza o esforço do utilizador, garantindo ações seguras e confirmáveis.

Exploração de esquemas

Nome da ferramenta Description
show_schema Exibe um diagrama de alto nível do esquema do banco de dados conectado, incluindo tabelas e relações.
list_schemas Lista todos os esquemas em um banco de dados para um servidor MSSQL conectado.
list_tables Lista todas as tabelas em um banco de dados para um servidor MSSQL conectado.
list_views Lista todas as vistas numa base de dados de um servidor MSSQL conectado.
list_functions Lista todas as funções em um banco de dados para um servidor MSSQL conectado.

Examples

Use as seguintes frases para interagir com o GitHub Copilot.

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

Captura de ecrã da animação mostrando a ferramenta visualizadora de esquemas da base de dados no Copilot agent.

Execução da consulta

Nome da ferramenta Description
run_query Executa uma consulta SQL na base de dados conectada.

Examples

Use as seguintes frases para interagir com o GitHub Copilot.

- 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

Captura de ecrã de exemplo usando uma ferramenta de agente para ligar a uma base de dados e recuperar dados.

Captura de ecrã de outro exemplo usando uma ferramenta de agente para ligar a uma base de dados e recuperar dados.

Ferramentas de desempenho do Query Store (pré-visualização)

Utilize estas ferramentas para investigar o desempenho das consultas capturadas em vez de construir manualmente SQL de diagnóstico. Exigem uma base de dados que suporte o Query Store, dados recolhidos para o período solicitado e permissão para ler esses dados. Pode identificar um destino através de uma ligação existente ou de um perfil de ligação guardado e do nome da base de dados.

Nome da ferramenta Description
mssql_query_store_status Leitura do estado do Query Store, motivos de apenas leitura e o histórico disponível.
mssql_query_store_top_queries Encontra consultas classificadas por uma métrica de recurso ou contagem de execuções numa janela temporal.
mssql_query_store_query_details Lê o texto, as estatísticas de execução e os planos de uma consulta com as suas estatísticas.
mssql_query_store_query_history Lê o desempenho de uma consulta ao longo do tempo, incluindo estatísticas dos planos que foram executados em cada intervalo.
mssql_query_store_wait_stats Lê o tempo de espera por categoria para uma base de dados, consulta ou plano. Requer suporte e captura de estatísticas de espera do Query Store.
mssql_query_store_plan_summary Resume a informação da instrução de um plano armazenado, avisos, recomendações de índice em falta e operadores dispendiosos.
mssql_query_store_analyze_query Combina detalhes de consultas, planos, histórico de execução, esperas e resumos dos planos principais numa única chamada de diagnóstico.
mssql_open_performance_dashboard Abre o Painel de Desempenho da Consulta para uma base de dados, ou numa consulta e num separador específicos.
mssql_query_store_plan_forcing Força ou deixa de forçar um plano de consulta após rever e confirmar o SQL gerado.
mssql_query_store_verify_forced_plan Verifica se as execuções após um plano ter sido forçado usaram esse plano.

Para iniciar uma investigação, identifique a base de dados e o período no seu 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.

Substitua o nome da base de dados de exemplo pela sua base de dados. Também pode referenciar uma ferramenta explicitamente, como #mssql_query_store_analyze_query, quando já conhece o ID da consulta e a base de dados de destino.

A ação Chat do dashboard abre o modo agente e envia um prompt que referencia #mssql_query_store_analyze_query explicitamente e fornece o servidor, a base de dados, o ID do perfil guardado, o ID da consulta e o intervalo temporal da consulta selecionada. Para um passo a passo e perguntas de seguimento, consulte Investigar o desempenho do Query Store.

Importante

As leituras de diagnóstico não modificam a base de dados nem exigem confirmação. Forçar ou desreforçar um plano é uma alteração separada: a ferramenta apresenta o SQL exato e quaisquer avisos para revisão e confirmação. Verificar um plano forçado é só de leitura. Diagnosticar o problema e rever as provas antes de pedir uma alteração de plano.

As definições de retenção e captura do Query Store determinam os dados disponíveis. Se o Query Store estiver desligado ou se o período solicitado não tiver dados capturados, as ferramentas não podem fornecer um diagnóstico de desempenho para esse período. Para detalhes de configuração, consulte Pré-requisitos do Painel de Desempenho de Consulta.

Como as ferramentas são gerenciadas no Modo de Agente

O GitHub Copilot pode usar ferramentas específicas do MSSQL e outras ferramentas contribuídas por extensões enquanto processa o seu pedido. Podes ver estas ferramentas na interface do Modo Agente, no menu Ferramentas , onde também podes ativar ou desativar ferramentas específicas.

Quando uma ferramenta exige confirmação, o GitHub Copilot pede-lhe que reveja a ação solicitada antes de esta ser executada. Podes permitir a ferramenta apenas para a sessão atual, o espaço de trabalho ou permanentemente. As leituras de diagnóstico do Query Store não solicitam confirmação; a imposição e a remoção da imposição do plano solicitam.

Para mais informações sobre visibilidade e aprovações de ferramentas, consulte Gerenciar aprovações de ferramentas.

Fluxo de trabalho de confirmação do Modo de Agente

Para ferramentas que requerem confirmação, o GitHub Copilot mostra detalhes sobre a ação solicitada. Revise o pedido antes de escolher uma opção de aprovação:

  • Permitir nesta sessão
  • Permitir neste espaço de trabalho
  • Permitir sempre

Esta etapa de confirmação ajuda a garantir interações seguras e intencionais com seu ambiente de desenvolvimento.

Note

Para obter mais informações sobre como a confirmação funciona em todas as ferramentas no Modo de Agente, consulte a documentação do Visual Studio Code sobre aprovações de ferramentas.

Catálogo de prompts em modo agente

Use estes prompts em linguagem natural para invocar ferramentas de extensão MSSQL através do modo agente. Para cada categoria, é feita uma referência cruzada a um comando de barra equivalente ou a um prompt do modo Perguntar.

Gestão de ligações

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.

Comandos equivalentes com barra: /connect, /listServers, /changeDatabase, /disconnect.

Exploração de esquemas

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?

Os equivalentes pedem instruções: consulte Conversar com o @mssql participante.

Execução da consulta

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.

Fluxos de trabalho em várias etapas

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.

Alterações delegadas ao esquema

Note

As alterações ao esquema são adequadas para serem testadas primeiro em modo de planeamento. Planeia as alterações, revê-as e depois entrega o plano para o modo agente para execução.

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.