Este conteúdo descreve a versão mais recente do CodeQL CLI. Para obter mais informações sobre essa versão, confira https://github.com/github/codeql-cli-binaries/releases.
Para ver os detalhes das opções disponíveis para esse comando em uma versão anterior, execute o comando com a opção --help no terminal.
Sinopse
codeql dataset upgrade [--threads=<num>] [--ram=<MB>] <options>... -- <dataset>
codeql dataset upgrade [--threads=<num>] [--ram=<MB>] <options>... -- <dataset>
Descrição
[Conexão] Atualize um conjunto de dados para que ele possa ser usado pelas ferramentas atuais.
Isso faz o mesmo que a codeql database upgrade, mas funciona em um conjunto de dados bruto em vez de em um banco de dados inteiro.
Opções
Opções principais
<dataset>
[Obrigatório] Caminho para o conjunto de dados de QL bruto a ser atualizado.
--search-path=<dir>[:<dir>...]
Uma lista de diretórios nos quais podem ser encontrados pacotes QL que contêm receitas de atualização. Cada diretório pode ser um pacote QL (ou um conjunto de pacotes que contém um arquivo .codeqlmanifest.json na raiz) ou o pai imediato de um ou mais desses diretórios.
Se o caminho contiver árvores de diretórios, a ordem deles definirá a precedência entre eles: se for encontrada uma correspondência do nome de um pacote que precisa ser resolvido em mais de uma das árvores de diretórios, a primeira fornecida vencerá.
Se você apontar isso para um check-out do repositório do CodeQL de código aberto, isso deverá funcionar durante a consulta de uma das linguagens que se encontram nele.
(Observação: no Windows, o separador de caminho é ;).
--additional-packs=<dir>[:<dir>...]
[Avançado] Se essa lista de diretórios for fornecida, nesses diretórios, será feita a pesquisa de atualizações antes daquelas contidas em --search-path. A ordem entre eles não importa: será indicado um erro se o nome de um pacote for encontrado em dois locais diferentes nessa lista.
Isso será útil se você estiver desenvolvendo temporariamente uma nova versão de um pacote que também aparece no caminho padrão. Por outro lado, não recomendamos substituir essa opção em um arquivo de configuração. Algumas ações internas adicionarão essa opção em tempo real, substituindo qualquer valor configurado.
(Observação: no Windows, o separador de caminho é ;).
--target-dbscheme=<file>
O dbscheme de destino para o qual queremos fazer a atualização. Se isso não for fornecido, um caminho de atualização máximo será construído
--target-sha=<sha>
[Avançado] Uma alternativa a --target-dbscheme que fornece o hash interno do dbscheme de destino em vez do arquivo dbscheme.
--[no-]allow-downgrades
Inclua qualquer downgrade relevante se não houver atualizações
Opções para controlar a avaliação de consultas de atualização
--[no-]tuple-counting
[Avançado] Veja as contagens de tupla de cada etapa de avaliação nos logs do avaliador de consulta. Se a opção --evaluator-log for fornecida, as contagens de tupla serão incluídas nos logs JSON baseados em texto e estruturados produzidos pelo comando. (Isso pode ser útil para a otimização de desempenho de um código QL complexo).
--timeout=<seconds>
[Avançado] Defina o tempo limite para a avaliação da consulta, em segundos.
O recurso de tempo limite se destina a capturar casos em que uma consulta complexa levará um tempo prologado indeterminado para ser avaliada. Não é uma forma eficaz de limitar o tempo total que a avaliação de consulta pode levar. A avaliação terá permissão para continuar, desde que cada parte cronometrada separadamente da computação seja concluída dentro do tempo limite. Atualmente, essas partes cronometradas separadamente são "camadas de RA" da consulta otimizada, mas isso poderá mudar no futuro.
Se nenhum tempo limite for especificado ou for fornecido como 0, nenhum tempo limite será definido (exceto codeql test run, sendo que o tempo limite padrão é de cinco minutos).
-j, --threads=<num>
Use esse número de threads para avaliar as consultas.
O valor padrão é 1. Você pode transmitir 0 para usar um thread por núcleo no computador ou -N para manter N núcleos não utilizados (com a exceção de que ainda será usado, pelo menos, um thread).
--[no-]save-cache
[Avançado] Grava agressivamente os resultados intermediários no cache de disco. Isso leva mais tempo e usa (muito) mais espaço em disco, mas pode acelerar a execução seguinte de consultas semelhantes.
--[no-]expect-discarded-cache
[Avançado] Tome decisões sobre os predicados que serão avaliados e o que será gravado no cache de disco, com base na suposição de que o cache será descartado após a execução das consultas.
--[no-]keep-full-cache
[Avançado] Não limpe o cache de disco após a conclusão da avaliação. Isso poderá economizar tempo se você executar codeql dataset cleanup ou codeql database cleanup posteriormente de qualquer maneira.
--max-disk-cache=<MB>
Defina a quantidade máxima de espaço que pode ser usada pelo cache de disco para os resultados intermediários da consulta.
Se esse tamanho não for configurado explicitamente, o avaliador tentará usar uma quantidade "razoável" de espaço em cache, com base no tamanho do conjunto de dados e na complexidade das consultas. Se você definir explicitamente um limite mais alto do que esse uso padrão, isso habilitará o cache adicional, que pode acelerar as consultas posteriores.
--min-disk-free=<MB>
[Avançado] Defina a quantidade de destino de espaço livre no sistema de arquivos.
Se --max-disk-cache não for fornecido, o avaliador tentará reduzir o uso do cache de disco se o espaço livre no sistema de arquivos ficar abaixo desse valor.
--min-disk-free-pct=<pct>
[Avançado] Defina a fração de destino de espaço livre no sistema de arquivos.
Se --max-disk-cache não for fornecido, o avaliador tentará reduzir o uso do cache de disco se o espaço livre no sistema de arquivos ficar abaixo desse percentual.
--external=<pred>=<file.csv>
Um arquivo CSV que contém linhas para o predicado externo <pred> .
É possível fornecer várias opções --external.
--xterm-progress=<mode>
[Avançado] Controla se o acompanhamento de progresso deve ser mostrado durante a avaliação de QL usando sequências do controle xterm. Os valores possíveis são:
no: nunca produza um progresso sofisticado; pressuponha um terminal burro.
auto (padrão) : detecte automaticamente se o comando está sendo executado em um terminal apropriado.
yes: suponha que o terminal possa entender as sequências do controle xterm. O recurso ainda depende da capacidade de fazer a detecção automática do tamanho do terminal, sendo também desabilitado se -q for fornecido.
25x80 (ou semelhante): como yes, além de fornecer explicitamente o tamanho do terminal.
25x80:/dev/pts/17 (ou semelhante): mostre um progresso sofisticado em um terminal diferente do stderr. Principalmente útil para testes internos.
Opções para controlar a saída de logs estruturados do avaliador
--evaluator-log=<file>
[Avançado] Saída de logs estruturados sobre o desempenho do avaliador para o arquivo especificado. O formato desse arquivo de log está sujeito a alterações sem aviso prévio, mas será um fluxo de objetos JSON separados por dois caracteres de nova linha (por padrão) ou um se a opção --evaluator-log-minify for transmitida. Use codeql generate log-summary <file> para produzir um resumo mais estável desse arquivo e evitar a análise direta dele. O arquivo será substituído se ele já existir.
--evaluator-log-minify
[Avançado] Se a opção --evaluator-log for transmitida, também transmitir essa opção minimizará o tamanho do log JSON produzido, em detrimento de torná-lo muito menos legível por humanos.
Opções para controlar o uso de RAM do processo de atualização
-M, --ram=<MB>
O avaliador de consulta se esforçará para manter seu volume de memória total abaixo desse valor. (No entanto, para bancos de dados grandes, é possível que o limite seja quebrado por mapas de memória com suporte de arquivo, que podem ser transferidos para disco em caso de pressão de memória).
O valor deve ser de pelo menos 2048 MB; valores menores serão arredondados de forma transparente.
Opções comuns
-h, --help
Mostre este texto de ajuda.
-J=<opt>
[Avançado] Forneça a opção para a JVM que executa o comando.
(Use-a com cautela, pois as opções que contêm espaços não serão tratadas corretamente.)
-v, --verbose
Aumente incrementalmente o número de mensagens de progresso impressas.
-q, --quiet
Diminua incrementalmente o número de mensagens de progresso impressas.
--verbosity=<level>
[Avançado] Defina explicitamente o nível de detalhamento como erros, avisos, progresso, progresso+, progresso++ ou progresso+++. Substitui -v e -q.
--logdir=<dir>
[Avançado] Escreva logs detalhados em um ou mais arquivos no diretório fornecido, com nomes gerados que incluem carimbos de data/hora e o nome do subcomando em execução.
(Para gravar um arquivo de log com um nome sobre o qual você tem controle completo, forneça --log-to-stderr e redirecione stderr conforme desejado.)
--common-caches=<dir>
[Avançado] Controle a localização dos dados armazenados em cache no disco que persistirão entre várias execuções da CLI, como pacotes QL baixados e planos de consulta compilada. Se não for definido explicitamente, o padrão corresponde a um diretório intitulado .codeql no diretório inicial do usuário; que será criado se ainda não existir.
Disponível desde v2.15.2.