Note
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
codeql database import [--dbscheme=<file>] [--threads=<num>] [--ram=<MB>] <options>... -- <database> <additionalDbs>...
codeql database import [--dbscheme=<file>] [--threads=<num>] [--ram=<MB>] <options>... -- <database> <additionalDbs>...
Descrição
[Avançado] [Conexão] Importe os bancos de dados não finalizados para outro banco de dados não finalizado.
O resultado desse comando é que o banco de dados de destino (aquele no primeiro argumento) será aumentado com os dados de todos os outros bancos de dados transmitidos. Em particular, os arquivos TRAP dos outros bancos de dados serão importados e as fontes deles serão copiadas.
Observe que esse comando provavelmente não terá o efeito desejado na maioria dos casos. Em particular, talvez o banco de dados resultante não acompanhe corretamente o fluxo de dados entre os bancos de dados parciais que foram combinados. Ele só se destina a ser usado em alguns cenários avançados que envolvem sistemas de build distribuídos em que foram tomados cuidados especiais em como o build foi separado, a fim de garantir que o banco de dados final resultante seja significativo.
Opções
Opções principais
<database>
[Obrigatório] Caminho para o banco de dados CodeQL em construção. Isso precisa ter sido preparado para extração com codeql database init.
Se a opção --db-cluster
for fornecida, esse não será um banco de dados propriamente dito, mas um diretório que contém bancos de dados, e todos esses bancos de dados serão processados juntos.
<additionalDbs>...
[Obrigatório] Caminhos para os bancos de dados não concluídos que devem ser importados para o primeiro banco de dados.
Se a opção --db-cluster
for fornecida, será esperado que eles sejam clusters de banco de dados em vez de bancos de dados CodeQL individuais.
--[no-]db-cluster
Indica que o diretório fornecido na linha de comando não é um banco de dados propriamente dito, mas um diretório que contém um ou mais bancos de dados em construção. Esses bancos de dados serão processados juntos.
Opções para controlar a operação de importação de TRAP
-S, --dbscheme=<file>
[Avançado] Substitua a definição de dbscheme detectada automaticamente a qual os arquivos TRAP devem seguir. Normalmente, isso é obtido do extrator do banco de dados.
-j, --threads=<num>
Use esse número de threads para a operação de importação.
O 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).
-M, --ram=<MB>
Use essa quantidade de memória para a operação de importação.
Opções para verificar o TRAP importado
--[no-]check-undefined-labels
[Avançado] Relate os erros de rótulos indefinidos.
--[no-]check-unused-labels
[Avançado] Relate os erros de rótulos não utilizados.
--[no-]check-repeated-labels
[Avançado] Relate os erros de rótulos repetidos.
--[no-]check-redefined-labels
[Avançado] Relate os erros de rótulos redefinidos.
--[no-]check-use-before-definition
[Avançado] Relate os erros de rótulos usados antes de serem definidos.
--[no-]fail-on-trap-errors
[Avançado] Gere uma saída diferente de zero se ocorrer um erro durante a importação do TRAP.
--[no-]include-location-in-star
[Avançado] Construa IDs de entidade que codificam o local no arquivo TRAP de origem. Pode ser útil para a depuração de geradores TRAP, mas ocupa muito espaço no conjunto de dados.
--[no-]linkage-aware-import
[Avançado] Controla se a importação do conjunto de dados codeql é compatível com vinculação (padrão) ou não. Em projetos em que essa parte da criação de banco de dados consome muita memória, desabilitar essa opção pode ajudá-los a progredir às custas da integridade do banco de dados.
Disponível desde v2.15.3
.
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
.