informações sobre bqrs

Observação

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 bqrs info <options>... -- <file>

codeql bqrs info <options>... -- <file>

Esse comando exibe uma visão geral dos dados contidos no arquivo BQRS binário compacto que é o resultado da execução de uma consulta. Ele mostra os nomes e os tamanhos de cada conjunto de resultados (tabela) no arquivo BQRS e os tipos de colunas de cada conjunto de resultados.

Opcionalmente, também pode compilar previamente os deslocamentos para usar as opções de paginação de codeql bqrs decode. Isso é útil principalmente para plug-ins do IDE.

Opções

Opções principais

`<file>`

[Obrigatório] Arquivo BQRS sobre o qual as informações serão mostradas.

`--format=<fmt>`

Selecione o formato de saída, text(padrão) ou json.

Como dar suporte à paginação em codeql bqrs decode

`--paginate-rows=<num>`

[Avançado] Quando fornecido com --format=json, compute uma tabela de deslocamentos de bytes que posteriormente pode ser fornecida à opção --start-at de codeql bqrs decode, para iniciar o streaming de resultados nas posições 0, <num>, 2*<num> etc.

`--paginate-result-set=<name>`

[Avançado] Somente processe --paginate-rows para conjuntos de resultados com esse nome. (Se o nome não corresponder a nenhum conjunto de resultados, --paginate-rows ele será não operacional).

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.

Quem pode usar esse recurso?

Neste artigo