Skip to main content

Esta versão do GitHub Enterprise Server será descontinuada em 2024-06-29. 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 Server. Para obter ajuda com a atualização, entre em contato com o suporte do GitHub Enterprise.

database bundle

Crie um arquivo relocável de um banco de dados CodeQL.

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

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 database bundle --output=<output> [--mode=<mode>] <options>... -- <database>

Descrição

Crie um arquivo relocável de um banco de dados CodeQL.

Um comando que compacta as partes úteis do banco de dados. Isso só incluirá os componentes obrigatórios, a menos que o usuário solicite especificamente que os resultados, os logs, o TRAP ou itens semelhantes sejam incluídos.

Opções

Opções principais

<database>

[Obrigatório] Caminho para o banco de dados CodeQL a ser empacotado.

-o, --output=<output>

[Obrigatório] O arquivo de saída, normalmente com a extensão ".zip".

--include-diagnostics

Incluir diagnósticos no pacote.

Disponível desde v2.16.0.

--include-results

Inclua os resultados da consulta computada previamente no pacote.

--include-temp

Inclui o diretório "temp", em que todos os pacotes, consultas e pacotes gerados estão localizados.

Disponível desde v2.13.3.

--include-uncompressed-source

Inclua uma versão descompactada do diretório de arquivo morto de origem. Isso é necessário para plug-ins herdados do CodeQL (como o CodeQL para Eclipse).

--name=<name>

O nome do diretório de nível superior no pacote. Se isso não for fornecido, ele usará como padrão o nome do diretório do banco de dados.

Opções de limpeza de conjunto de dados de baixo nível

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

-m, --mode=<mode>

Selecione o nível de agressividade de corte do cache. As opções incluem:

clear: remova todo o cache, reduzindo-o ao estado de um conjunto de dados recém-extraído

trim (padrão) : corte tudo, exceto os predicados explicitamente "armazenados em cache".

fit: verifique se os limites de tamanho definidos para o cache de disco são observados, excluindo quantos intermediários forem necessários.

--cleanup-upgrade-backups

Exclua todos os diretórios de backup resultantes das atualizações de banco de dados.

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.