Synopsis

codeql database finalize [--dbscheme=<file>] [--threads=<num>] [--ram=<MB>] <options>... -- <database>

codeql database finalize [--dbscheme=<file>] [--threads=<num>] [--ram=<MB>] <options>... -- <database>

Description

[Plumbing] Final steps in database creation.

Finalize a database that was created withcodeql database init and subsequently seeded with analysis data usingcodeql database trace-command. This needs to happen before the new database can be queried.

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.

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

--additional-dbs=<database>[:<database>...]

[Advanced] Path to additional CodeQL databases under construction.These will not themselves be finalized, but the data from them will beincluded in the finalized database being created. This is an advancedoption that may not have the desired effect in all cases. For moreinformation, please refer to the documentation ofcodeql database import.

If the--db-cluster option is given, it is expected that these will bedatabase clusters rather than individual CodeQL databases.

(Note: On Windows the path separator is;).

--no-cleanup

[Advanced] Suppress all database cleanup after finalization. Usefulfor debugging purposes.

--no-pre-finalize

[Advanced] Skip any pre-finalize script specified by the active CodeQLextractor.

--[no-]skip-empty

[Advanced] Output a warning instead of failing if a database is emptybecause no source code was seen during the build. The empty databasewill be left unfinalized.

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.

Low-level dataset cleanup options

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

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.