Como gerenciar bancos de dados do CodeQL

Você pode trabalhar com bancos de dados do CodeQL usando a extensão.

Neste artigo

Sobre os bancos de dados do CodeQL

Para analisar um projeto, você precisa selecionar um banco de dados do CodeQL para o projeto. Escolha um banco de dados localmente (por meio de um arquivo zip ou de uma pasta não pesquisada), de uma URL pública, ou da URL de um projeto no GitHub. Como alternativa, você pode criar um banco de dados por meio da CodeQL CLI. Confira “Como preparar seu código para a análise do CodeQL”.

Como baixar um banco de dados do GitHub

O GitHub.com armazena bancos de dados do CodeQL para mais de 200.000 repositórios de software livre que você pode usar para testar a análise. Você também pode acessar bancos de dados para repositórios hospedados no GitHub Enterprise Cloud com residência de dados editando as configurações e definindo a URL do sistema. Confira “Como alterar a URL do GitHub usada pela extensão”.

Você pode verificar se um repositório tem algum banco de dados do CodeQL disponível para download, e caso tenha, baixá-lo usando a API REST. Para obter mais informações, confira "List CodeQL databases for a repository" e "Get a CodeQL database for a repository" na documentação da API REST do GitHub.

Escolher um banco de dados para analisar

  1. Passe o mouse sobre a barra de título do modo de exibição "Bancos de Dados" e escolha o ícone apropriado para selecionar seu banco de dados. Escolha um banco de dados local (por meio de um arquivo ZIP ou de uma pasta não arquivada), de uma URL pública ou da URL de um projeto no GitHub.

  2. Depois de escolher um banco de dados, ele será exibido no modo de exibição "Bancos de Dados". Para ver as opções de menu para interagir com um banco de dados, clique com o botão direito do mouse em uma entrada na lista. Você pode selecionar vários bancos de dados de uma vez.

Observação: você também pode analisar bancos de dados de teste. Os bancos de dados de teste (pastas com uma extensão .testproj) são gerados quando você executa testes de regressão em consultas personalizadas usando a CodeQL CLI. Se uma consulta falhar em um teste de regressão, convém importar o banco de dados de teste para o Visual Studio Code para depurar a falha. Para obter mais informações sobre como executar testes de consulta, confira "Testar consultas personalizadas".

Filtrar bancos de dados e consultas por linguagem

Opcionalmente, para ver bancos de dados que contêm uma linguagem específica e consultas escritas para ela, você pode aplicar um filtro de linguagem usando o seletor de linguagem.

  1. Para ver os filtros de linguagem disponíveis, na barra lateral, abra o modo de exibição "Linguagem".

  2. Passe o mouse sobre o filtro de linguagem que você deseja aplicar e clique em Selecionar.

Próximas etapas

Para saber como usar a extensão para analisar seus projetos executando consultas em bancos de dados do CodeQL, confira "Como executar consultas do CodeQL".