bqrs 解码

注意

此内容描述了 CodeQL CLI 的最新版本。有关此版本的详细信息，请参阅 https://github.com/github/codeql-cli-binaries/releases 。

若要查看早期版本中此命令可用选项的详细信息，请在终端中使用 --help 选项运行命令。

概要

Shell

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

将结果数据从 BQRS 转换为其他形式。

除非指定 --output 选项，否则会将解码的输出写入标准输出。

选项

主要选项

`<file>`

          \[必选] 要解码的 BQRS 文件。

`-o, --output=<file>`

要向其写入所需输出的文件。

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

从 BQRS 文件选择要解码的特定结果集。可通过 codeql bqrs info 列出可用结果集。

如果未选择任何结果集，则将解码所有结果集，前提是所选输出格式和处理选项支持这些结果集。否则会导致错误。

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

按指示的列对所选结果集进行排序。

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

使用指示的排序方向对所选结果集进行排序。

如果未指定排序方向，则将对所有列使用升序。

输出格式选项

`--format=<fmt>`

选择输出格式。选项包括：

          `text`              _（默认）_：人类可读的纯文本表格。

          `csv`：逗号分隔值。

          `json`：流式 JSON。

          `bqrs`：BQRS。 必须与 `--output` 一起使用。 与 `--sort-key` 一起使用最有用。

`--no-titles`

省略 text 和 csv 格式的列标题

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

          \[高级] 控制实体类型的结果列的显示方式。 以下选项的逗号分隔列表：

          `url`：指向源位置的 URL（如果查询已编译为实体类型生成此类 URL）。

          `string`：QL 中 toString() 方法计算的字符串（如果查询已编译为该列生成此类字符串）。

          `id`：实体的内部 ID，可能无实际意义。

          `all`：显示包含 BQRS 文件提供的所有信息的列。

如果可能，将显示所有选定的选项。

分页选项（供交互式前端使用）

`--rows=<num>`

          \[高级] 从所选结果集中输出指定数量的行，从顶部开始或从 `--start-at` 给定的位置开始。

`--start-at=<offset>`

          \[高级] 从 BQRS 文件中特定字节偏移量处定义的行开始打印。 偏移量必须从 [codeql bqrs info](/code-security/codeql-cli/codeql-cli-manual/bqrs-info) 获取，或从上一次设置了 `--rows` 的调用的 JSON 输出中找到的“next”指针获取。 其他偏移量可能会产生无意义的输出和/或显式错误。

必须始终与 --rows 一起使用，并且与 --sort-key 不兼容。

常用选项

`-h, --help`

显示此帮助文本。

`-J=<opt>`

          \[高级] 向运行命令的 JVM 提供选项。

（请注意，无法正确处理包含空格的选项。）

`-v, --verbose`

以增量方式增加输出的进度消息数。

`-q, --quiet`

以增量方式减少输出的进度消息数。

`--verbosity=<level>`

          \[高级] 明确将详细级别设置为 errors、warnings、progress、progress+、progress++、progress+++ 之一。 重写 `-v` 和 `-q`。

`--logdir=<dir>`

          \[高级] 将详细日志写入指定目录中的一个或多个文件，生成的文件名包含时间戳和正在运行的子命令名称。

（要使用可以完全控制的名称编写日志文件，请根据需要提供 --log-to-stderr 并重定向 stderr。）

`--common-caches=<dir>`

          \[高级] 控制磁盘上缓存数据的位置，这些数据将在 CLI 的多次运行之间保留，例如下载的 QL 包和编译的查询计划。 如果未明确设置，则默认为用户主目录中名为 `.codeql` 的目录；如果尚不存在，则会创建该目录。

自 v2.15.2 起可用。

谁可以使用此功能？

本文内容

概要