{"meta":{"title":"bqrs interpret","intro":"[Conexão] Interprete os dados em um só BQRS.","product":"Qualidade de segurança e código","breadcrumbs":[{"href":"/pt/code-security","title":"Qualidade de segurança e código"},{"href":"/pt/code-security/reference","title":"Referência"},{"href":"/pt/code-security/reference/code-scanning","title":"Varredura de código"},{"href":"/pt/code-security/reference/code-scanning/codeql","title":"CodeQL"},{"href":"/pt/code-security/reference/code-scanning/codeql/codeql-cli-manual","title":"Manual da CLI do CodeQL"},{"href":"/pt/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-interpret","title":"bqrs interpret"}],"documentType":"article"},"body":"# bqrs interpret\n\n[Conexão] Interprete os dados em um só BQRS.\n\n> [!NOTE]\n> 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.\n>\n> Para ver os detalhes das opções disponíveis para esse comando em uma versão anterior, execute o comando com a opção <span style=\"white-space: nowrap;\">`--help`</span> no terminal.\n\n## Sinopse\n\n```shell copy\ncodeql bqrs interpret --format=<format> --output=<output> -t=<String=String> [--threads=<num>] [--source-archive=<sourceArchive>] [--source-location-prefix=<sourceLocationPrefix>] <options>... -- <bqrs-file>\n```\n\n## Description\n\n              \\[Conexão] Interprete os dados em um só BQRS.\n\nUm comando que interpreta um só arquivo BQRS de acordo com os metadados fornecidos e gera a saída no formato especificado.\n\n## Opções\n\n### Opções principais\n\n#### `<bqrs-file>`\n\n              \\[Obrigatório] O arquivo BQRS a ser interpretado.\n\n#### `--format=<format>`\n\n              \\[Obrigatório] O formato no qual os resultados serão gravados. Um destes:\n\n              `csv`: valores formatados separados por vírgula, incluindo colunas com metadados de regra e de alerta.\n\n              `sarif-latest`: SARIF (Static Analysis Results Interchange Format), um formato baseado em JSON usado para descrever os resultados da análise estática. Essa opção de formato usa a versão mais recente com suporte (v2.1.0). Essa opção não é adequada para uso na automação, pois produzirá diferentes versões do SARIF entre diferentes versões do CodeQL.\n\n              `sarifv2.1.0`: SARIF v2.1.0.\n\n              `graphtext`: um formato textual que representa um grafo. Compatível apenas com consultas com o grafo @kind.\n\n              `dgml`: Directed Graph Markup Language, um formato baseado em XML para a descrição de grafos. Compatível apenas com consultas com o grafo @kind.\n\n              `dot`: linguagem DOT do Graphviz, um formato baseado em texto para a descrição de grafos.\nCompatível apenas com consultas com o grafo @kind.\n\n#### `-o, --output=<output>`\n\n              \\[Obrigatório] O caminho de saída no qual os resultados serão gravados. Para formatos de grafo, esse deve ser um diretório, e o resultado (ou os resultados, caso o comando dê suporte à interpretação de mais de uma consulta) será gravado nesse diretório.\n\n#### `-t=<String=String>`\n\n              \\[Obrigatório] Um par de valores de chave de metadados de consulta. Repita isso para cada parte dos metadados. No mínimo, as chaves 'kind' e 'id' precisam ser especificadas. As chaves não precisam ser prefixadas com @.\n\n#### `--max-paths=<maxPaths>`\n\nO número máximo de caminhos a serem produzidos para cada alerta com caminhos.\n(Padrão: 4)\n\n#### `--[no-]sarif-add-file-contents`\n\n              \\[Somente formatos SARIF] Inclua o conteúdo completo do arquivo para todos os arquivos referenciados em, pelo menos, um resultado.\n\n#### `--[no-]sarif-add-snippets`\n\n              \\[Somente formatos SARIF] Inclua snippets de código para cada local mencionado nos resultados, com duas linhas de contexto antes e depois do local relatado.\n\n#### `--[no-]sarif-add-query-help`\n\n              \\[Somente formatos SARIF] \\[Preterido] Inclua ajuda de consulta Markdown para todas as consultas. Isso carrega a ajuda de consulta para /path/to/query.ql por meio do arquivo /path/to/query.md. Se esse sinalizador não for fornecido, o comportamento padrão será incluir ajuda apenas para consultas personalizadas, ou seja, aquelas em pacotes de consulta que não são na forma \\`codeql/\\<lang\\&rt;-queries\\`. Essa opção não tem nenhum efeito quando transmitida para codeql bqrs interpret.\n\n#### `--sarif-include-query-help=<mode>`\n\n              \\[Somente formatos SARIF] Especifique se deseja incluir ajuda de consulta na saída SARIF. Um destes:\n\n              `always`: Incluir ajuda de consulta para todas as consultas.\n\n              `custom_queries_only`\n              _(padrão)_: inclua ajuda de consulta apenas para consultas personalizadas, ou seja, aquelas em pacotes de consulta que não são do formulário \\`codeql/\\<lang\\&rt;-queries\\`.\n\n              `never`: Não inclua ajuda de consulta para quaisquer consultas.\n\nEssa opção não tem nenhum efeito quando transmitida para codeql bqrs interpret.\n\nDisponível desde `v2.15.2`.\n\n#### `--no-sarif-include-alert-provenance`\n\n              \\[Avançado] \\[Somente formatos SARIF] Não inclua informações de procedência de alerta na saída SARIF.\n\nDisponível desde `v2.18.1`.\n\n#### `--[no-]sarif-group-rules-by-pack`\n\n              \\[Somente formatos SARIF] Coloque o objeto de regra para cada consulta no pacote QL correspondente na propriedade `<run>.tool.extensions`. Essa opção não tem nenhum efeito quando transmitida para codeql bqrs interpret.\n\n#### `--[no-]sarif-multicause-markdown`\n\n              \\[Somente formatos SARIF] Para alertas que têm várias causas, inclua-os como uma lista de itens formatados em Markdown na saída, além de uma cadeia de caracteres sem formatação.\n\n#### `--no-sarif-minify`\n\n              \\[Somente formatos SARIF] Produza uma saída SARIF impressa bonita. Por padrão, a saída SARIF é minificada para reduzir o tamanho do arquivo de saída.\n\n#### `--sarif-run-property=<String=String>`\n\n              \\[Somente formatos SARIF] Um par de valores de chave a ser adicionado ao recipiente de propriedades 'run' do SARIF gerado. Pode ser repetido.\n\n#### `--no-group-results`\n\n              \\[Somente formatos SARIF] Produz um resultado por mensagem, em vez de um resultado por local exclusivo.\n\n#### `--csv-location-format=<csvLocationFormat>`\n\nO formato no qual os locais serão produzidos na saída CSV. Um dos seguintes: uri, line-column ou offset-length. (Padrão: linha-coluna)\n\n#### `--dot-location-url-format=<dotLocationUrlFormat>`\n\nUma cadeia de caracteres de formato que define o formato no qual as URLs de local do arquivo serão produzidas na saída DOT. Os seguintes espaços reservados podem ser usados: {path} {start:line} {start:column} {end:line} {end:column}, {offset} e {length}\n\n#### `--[no-]sublanguage-file-coverage`\n\n              \\[Somente para GitHub.com e GitHub Enterprise Server v3.12.0+] Use informações de cobertura de arquivo de sub-linguagem. Isso calcula, exibe e exporta informações de cobertura de arquivos separadas para linguagens que compartilham um extrator CodeQL como C e C++, Java e Kotlin e JavaScript e TypeScript.\n\nDisponível desde `v2.15.2`.\n\n#### `--sarif-category=<category>`\n\n              \\[Somente formatos SARIF] \\[Recomendado] Especifique uma categoria para essa análise incluir na saída SARIF. Uma categoria pode ser usada para distinguir várias análises executadas no mesmo commit e repositório, mas em diferentes linguagens ou partes do código.\n\nSe você analisar a mesma versão de uma base de código de várias maneiras diferentes (por exemplo, para diferentes linguagens) e carregar os resultados no GitHub para apresentação na verificação de código, esse valor deverá ser diferente entre cada uma das análises, o que informa à verificação de código de que as análises _suplementam_ umas às outras em vez de _substituí-las_. (Os valores devem ser consistentes entre as execuções da mesma análise para _diferentes_ versões da base de código.)\n\nEsse valor aparecerá (com uma barra à direita acrescentada se ainda não estiver presente) como a propriedade `<run>.automationDetails.id`.\n\n#### `-j, --threads=<num>`\n\nO número de threads usados para os caminhos de computação.\n\nO 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).\n\n#### `--column-kind=<columnKind>`\n\n              \\[Somente SARIF] O tipo de coluna usado para interpretar as colunas de local. Um dos seguintes: utf8, utf16, utf32 ou bytes.\n\n#### `--[no-]unicode-new-lines`\n\n              \\[Somente SARIF] Indica se os caracteres de nova linha Unicode LS (Separador de Linha, U+2028) e PS (Separador de Parágrafo, U+2029) são considerados como novas linhas quando os números de linha de local são interpretados.\n\n### Opções de arquivo de origem – Precisam ser fornecidas juntas ou não devem ser fornecidas\n\n#### `-s, --source-archive=<sourceArchive>`\n\nO diretório ou o arquivo zip que contém o arquivo de origem.\n\n#### `-p, --source-location-prefix=<sourceLocationPrefix>`\n\nO caminho do arquivo no sistema de arquivos original em que o código-fonte foi armazenado.\n\n### Opções comuns\n\n#### `-h, --help`\n\nMostre este texto de ajuda.\n\n#### `-J=<opt>`\n\n              \\[Avançado] Forneça a opção para a JVM que executa o comando.\n\n(Use-a com cautela, pois as opções que contêm espaços não serão tratadas corretamente.)\n\n#### `-v, --verbose`\n\nAumente incrementalmente o número de mensagens de progresso impressas.\n\n#### `-q, --quiet`\n\nDiminua incrementalmente o número de mensagens de progresso impressas.\n\n#### `--verbosity=<level>`\n\n              \\[Avançado] Defina explicitamente o nível de detalhamento como erros, avisos, progresso, progresso+, progresso++ ou progresso+++. Substitui `-v` e `-q`.\n\n#### `--logdir=<dir>`\n\n              \\[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.\n\n(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.)\n\n#### `--common-caches=<dir>`\n\n              \\[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.\n\nDisponível desde `v2.15.2`."}