bqrs decode

概要

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>

描述

将 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 获取，或从上一次使用 --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 起可用。