dataset cleanup
[Plumbing] Clean up temporary files from a 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 cleanup <options>... -- <dataset>
codeql dataset cleanup <options>... -- <dataset>Description
[Plumbing] Clean up temporary files from a dataset.
This should not be used for datasets still under construction, as itwill make it impossible to import further data into the dataset.
Options
Primary Options
<dataset>
[Mandatory] Path to the raw QL dataset to clean up.
--max-disk-cache=<MB>
Set the maximum amount of space that the disk cache for intermediatequery results can use.
If this size is not configured explicitly, the evaluator will try to usea "reasonable" amount of cache space, based on the size of the datasetand the complexity of the queries. Explicitly setting a higher limitthan this default usage will enable additional caching which can speedup later queries.
--min-disk-free=<MB>
[Advanced] Set target amount of free space on file system.
If--max-disk-cache is not given, the evaluator will try hard tocurtail disk cache usage if the free space on the file system dropsbelow this value.
--min-disk-free-pct=<pct>
[Advanced] Set target fraction of free space on file system.
If--max-disk-cache is not given, the evaluator will try hard tocurtail disk cache usage if the free space on the file system dropsbelow this percentage.
--cache-cleanup=<mode>
Select how aggressively to trim the cache. Choices include:
clear: Remove the entire cache, trimming down to the state of afreshly extracted dataset
trim(default): Trim everything except explicitly "cached"predicates.
fit: Simply make sure the defined size limits for the disk cache areobserved, deleting as many intermediates as necessary.
--cleanup-upgrade-backups
Delete any backup directories resulting from database upgrades.
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.