Synopsis

codeql bqrs decode [--output=<file>] [--result-set=<name>] [--sort-key=<col>[,<col>...]] <options>... -- <file>

codeql bqrs decode [--output=<file>] [--result-set=<name>] [--sort-key=<col>[,<col>...]] <options>... -- <file>

Description

Convert result data from BQRS into other forms.

The decoded output will be written to standard output, unless the--output option is specified.

Options

Primary Options

<file>

[Mandatory] BQRS file to decode.

-o, --output=<file>

The file to write the desired output to.

-r, --result-set=<name>

Select a particular result set from the BQRS file to decode. Theavailable results sets can be listed bycodeql bqrs info.

If no result set is selected, all result sets will be decoded, providedthe selected output format and processing options support that.Otherwise an error results.

-k, --sort-key=<col>[,<col>...]

Sort the selected result set by the indicated columns.

--sort-direction=<direction>[,<direction>...]

Sort the selected result set using the indicated sort directions.

If sort directions are not specified, then ascending order will be usedfor all columns.

Output format options

--format=<fmt>

Select output format. Choices include:

text(default): A human-readable plain text table.

csv: Comma-separated values.

json: Streaming JSON.

bqrs: BQRS. This must be used with--output. Most useful togetherwith--sort-key.

--no-titles

Omit column titles fortext andcsv formats

--entities=<fmt>[,<fmt>...]

[Advanced] Control how result columns of entity type are shown. Acomma-separated list of the following choices:

url: A URL referring to a source location, if the query was compiledto produce such URLs for entity types.

string: A string computed by the toString() method in QL, if the querywas compiled to produce such strings for the column.

id: The internal ID of the entity, which may not be informative.

all: Show columns with all the information the BQRS file provides.

All the selected options are shown, if possible.

Options for pagination (for use by interactive front-ends)

--rows=<num>

[Advanced] Output this many rows from the selected resultset, startingat the top, or at the location given by--start-at.

--start-at=<offset>

[Advanced] Start printing the row defined at a particular byte offsetin the BQRS file. The offset must be gotten fromcodeql bqrs info, or from the "next" pointer found in JSON output from a previous invocation with--rowsset. Other offsets are likely to produce nonsense output and/or expliciterrors.

Must always be used together with--rows, and is incompatible with--sort-key.

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.