database import
[Advanced] [Plumbing] Import unfinalized database(s) into anotherunfinalized database.
Who can use this feature?
CodeQL is available for the following repository types:
- Public repositories on GitHub.com, seeGitHub CodeQL Terms and Conditions
- Organization-owned repositories on GitHub Team withGitHub Code Security enabled
In this article
Note
This content describes the most recent release of the CodeQL CLI. For more information about this release, seehttps://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.
Synopsis
codeql database import [--dbscheme=<file>] [--threads=<num>] [--ram=<MB>] <options>... -- <database> <additionalDbs>...
codeql database import [--dbscheme=<file>] [--threads=<num>] [--ram=<MB>] <options>... -- <database> <additionalDbs>...Description
[Advanced] [Plumbing] Import unfinalized database(s) into anotherunfinalized database.
The result of this command is that the target database (the one in thefirst argument) will be augmented with the data from all the otherdatabases passed. In particular, TRAP files from the other databaseswill be imported and sources in them will be copied.
Note that this command will probably not have the desired effect in mostcases. In particular, the resulting database may not correctly trackdataflow between the partial databases that were combined. It is onlyintended to be used in certain advanced scenarios involving distributedbuild systems where special care has been taken in how the build wasseparated in order to ensure that the resulting final database ismeaningful.
Options
Primary Options
<database>
[Mandatory] Path to the CodeQL database under construction. This musthave been prepared for extraction withcodeql database init.
If the--db-cluster option is given, this is not a database itself,but a directory thatcontains databases, and all of those databaseswill be processed together.
<additionalDbs>...
[Mandatory] Paths to the unfinished database(s) that should importedinto the first database.
If the--db-cluster option is given, it is expected that these will bedatabase clusters rather than individual CodeQL databases.
--[no-]db-cluster
Indicates that the directory given on the command line is not a databaseitself, but a directory thatcontains one or more databases underconstruction. Those databases will be processed together.
Options for controlling the TRAP import operation
-S, --dbscheme=<file>
[Advanced] Override the auto-detected dbscheme definition that theTRAP files are assumed to adhere to. Normally, this is taken from thedatabase's extractor.
-j, --threads=<num>
Use this many threads for the import operation.
Defaults to 1. You can pass 0 to use one thread per core on the machine,or -N to leaveN cores unused (except still use at least onethread).
-M, --ram=<MB>
Use this much memory for the import operation.
Options for checking imported TRAP
--[no-]check-undefined-labels
[Advanced] Report errors for undefined labels.
--[no-]check-unused-labels
[Advanced] Report errors for unused labels.
--[no-]check-repeated-labels
[Advanced] Report errors for repeated labels.
--[no-]check-redefined-labels
[Advanced] Report errors for redefined labels.
--[no-]check-use-before-definition
[Advanced] Report errors for labels used before they're defined.
--[no-]fail-on-trap-errors
[Advanced] Exit non-zero if an error occurs during trap import.
--[no-]include-location-in-star
[Advanced] Construct entity IDs that encode the location in the TRAPfile they came from. Can be useful for debugging of TRAP generators, buttakes up a lot of space in the dataset.
--[no-]linkage-aware-import
[Advanced] Controls whethercodeql dataset import is linkage-aware(default) or not. On projects where this part of database creationconsumes too much memory, disabling this option may help them progressat the expense of database completeness.
Available sincev2.15.3.
Common options
-h, --help
Show this help text.
-J=<opt>
[Advanced] Give option to the JVM running the command.
(Beware that options containing spaces will not be handled correctly.)
-v, --verbose
Incrementally increase the number of progress messages printed.
-q, --quiet
Incrementally decrease the number of progress messages printed.
--verbosity=<level>
[Advanced] Explicitly set the verbosity level to one of errors,warnings, progress, progress+, progress++, progress+++. Overrides-vand-q.
--logdir=<dir>
[Advanced] Write detailed logs to one or more files in the givendirectory, with generated names that include timestamps and the name ofthe running subcommand.
(To write a log file with a name you have full control over, insteadgive--log-to-stderr and redirect stderr as desired.)
--common-caches=<dir>
[Advanced] Controls the location of cached data on disk that willpersist between several runs of the CLI, such as downloaded QL packs andcompiled query plans. If not set explicitly, this defaults to adirectory named.codeql in the user's home directory; it will becreated if it doesn't already exist.
Available sincev2.15.2.