Skip to main content
Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais atualizadas, acesse a documentação em inglês.

Esta versão do GitHub Enterprise foi descontinuada em 2023-03-15. Nenhum lançamento de patch será feito, mesmo para questões críticas de segurança. Para obter melhor desempenho, segurança aprimorada e novos recursos, atualize para a última versão do GitHub Enterprise. Para obter ajuda com a atualização, entre em contato com o suporte do GitHub Enterprise.

bqrs decode

Converta os dados de resultado do BQRS em outros formatos.

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".

This content describes the most recent release of the CodeQL CLI. For more information about this release, see https://github.com/github/codeql-cli-binaries/releases.

To see details of the options available for this command in an earlier release, run the command with the --help option in your terminal.

Sinopse

Shell
codeql bqrs decode [--output=<file>] [--result-set=<name>] [--sort-key=<col>[,<col>...]] <options>... -- <file>

Descrição

Converta os dados de resultado do BQRS em outros formatos.

A saída decodificada será gravada na saída padrão, a menos que a opção --output seja especificada.

Opções principais

<file>

[Obrigatório] Arquivo BQRS a ser decodificado.

-o, --output=<file>

O arquivo no qual a saída desejada será gravada.

-r, --result-set=<name>

Selecione um conjunto de resultados específico no arquivo BQRS para decodificação. Os conjuntos de resultados disponíveis podem ser listados por codeql bqrs info.

Se nenhum conjunto de resultados for selecionado, todos os conjuntos de resultados serão decodificados, desde que o formato de saída selecionado e as opções de processamento deem suporte a isso. Caso contrário, ocorrerá um erro.

-k, --sort-key=<col>[,<col>...]

Classifique o conjunto de resultados selecionado pelas colunas indicadas.

--sort-direction=<direction>[,<direction>...]

Classifique o conjunto de resultados selecionado usando as instruções de classificação indicadas.

Se as instruções de classificação não forem especificadas, a ordem ascendente será usada para todas as colunas.

Opções de formato de saída

--format=<fmt>

Selecione o formato de saída. As opções incluem:

text (padrão) : uma tabela de texto sem formatação legível por humanos.

csv: valores separados por vírgula.

json: streaming de JSON.

bqrs: BQRS. Isso precisa ser usado com --output. Mais útil com --sort-key.

--no-titles

Omitir os títulos de colunas para formatos text e csv

--entities=<fmt>[,<fmt>...]

[Avançado] Controle como as colunas de resultados do tipo de entidade são mostradas. Uma lista separada por vírgula das seguintes opções:

url: uma URL referente a um local de origem, caso a consulta tenha sido compilada para produzir essas URLs para tipos de entidades.

string: uma cadeia de caracteres computada pelo método toString() em QL, caso a consulta tenha sido compilada para produzir essas cadeias de caracteres para a coluna.

id: a ID interna da entidade, que pode não ser informativa.

all: mostre as colunas com todas as informações fornecidas pelo arquivo BQRS.

Todas as opções selecionadas são mostradas, se possível.

Opções de paginação (para uso dos front-ends interativos)

--rows=<num>

[Avançado] Gere esse número de linhas com base no conjunto de resultados selecionado, começando no início ou no local fornecido por --start-at.

--start-at=<offset>

[Avançado] Comece imprimindo a linha definida em um deslocamento de bytes específico no arquivo BQRS. O deslocamento precisa ser obtido de codeql bqrs info ou do ponteiro "next" encontrado na saída JSON de uma invocação anterior com --rows definido. É provável que outros deslocamentos produzam saídas sem sentido e/ou erros explícitos.

Sempre precisa ser usado com --rows e é incompatível com --sort-key.

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.)