bqrs info
Display metadata for a BQRS file.
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 bqrs info <options>... -- <file>
codeql bqrs info <options>... -- <file>Description
Display metadata for a BQRS file.
This command displays an overview of the data contained in the compactbinary BQRS file that is the result of executing a query. It shows thenames and sizes of each result set (table) in the BQRS file, and thecolumn types of each result set.
It can also optionally precompute offsets for using the paginationoptions ofcodeql bqrs decode. This is mainly useful for IDE plugins.
Options
Primary Options
<file>
[Mandatory] BQRS file to show information about.
--format=<fmt>
Select output format, eithertext(default) orjson.
Supporting pagination in codeql bqrs decode
--paginate-rows=<num>
[Advanced] When given together with--format=json, compute a tableof byte offsets that can later be given to the--start-at option ofcodeql bqrs decode, to start streaming results at positions 0,<num>, 2*<num>, and soforth.
--paginate-result-set=<name>
[Advanced] Only process--paginate-rows for result sets with thisname. (If the name does not match any result set,--paginate-rows is ano-op).
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.