dataset import
[Plumbing] Import a set of TRAP files to a raw dataset.
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 dataset import --dbscheme=<file> [--threads=<num>] <options>... -- <dataset> <trap>...
codeql dataset import --dbscheme=<file> [--threads=<num>] <options>... -- <dataset> <trap>...Description
[Plumbing] Import a set of TRAP files to a raw dataset.
Create a dataset by populating it with TRAP files, or add data from TRAPfiles to an existing dataset. Updating a dataset is only possible if ithas the correct dbschemeand its ID pool has been preserved from theinitial import.
Options
Primary Options
<dataset>
[Mandatory] Path to the raw QL dataset to create or update. Thedirectory will be created if it doesn't already exist.
<trap>...
Paths to .trap(.gz) files to import, or to directories that will berecursively scanned for .trap(.gz) files. If no files are given, anempty dataset will be created.
-S, --dbscheme=<file>
[Mandatory] The dbscheme definition that describes the TRAP files youwant to import.
-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).
--[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.