dataset check

[Conexão] Verifique se há consistência interna em um conjunto de dados específico.

Quem pode usar esse recurso?

O CodeQL do GitHub é licenciado por usuário após a instalação. Você pode usar o CodeQL somente para determinadas tarefas sob as restrições de licença. Para obter mais informações, confira "Sobre a CLI do CodeQL".

Se você tiver uma licença do GitHub Advanced Security, poderá usar o CodeQL para análise automatizada, integração contínua e entrega contínua. Para obter mais informações, confira "Sobre a Segurança Avançada do GitHub".

Neste artigo

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

Shell

codeql dataset check <options>... -- <dataset>

codeql dataset check <options>... -- <dataset>

Descrição

[Conexão] Verifique um conjunto de dados específico quanto à consistência interna.

Esse comando é mais comumente útil para desenvolvedores de extratores CodeQL, pois valida os dados produzidos pelo extrator. Também pode ser útil se as consultas em um banco de dados estão fornecendo resultados inconsistentes, para descartar problemas nos dados subjacentes como a causa.

Opções

Opções principais

`<dataset>`

[Obrigatório] Caminho para o conjunto de dados QL bruto a ser verificado.

`--failing-exitcode=<code>`

[Avançado] Defina o código de saída a ser produzido em caso de falhas. Normalmente 1, mas as ferramentas que analisam a saída podem achar útil defini-la como 0.

`--format=<fmt>`

Selecione o formato de saída. Possíveis opções:

text (padrão) : uma renderização textual legível por humanos.

json: uma matriz JSON transmitida de objetos.

jsonz: um fluxo de objetos JSON terminado em zero.

`--[no-]precise-locations`

[Avançado] Realize esforços extras para calcular locais precisos quanto a inconsistências. Isso levará mais tempo, mas pode facilitar a depuração do comportamento do extrator.

`--max-resolve-depth=<n>`

[Avançado] A profundidade máxima para a qual as IDs devem ser resolvidas a fim de explicar as inconsistências. (Padrão: 3)

`--max-errors-per-checker=<n>`

O número máximo de erros de inconsistência de cada tipo que deve ser relatado explicitamente. (Padrão: 5)

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.