bqrs 解码

概要

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>

[高级] 将详细程度显式设置为错误、警告、进度、进度+、进度++、进度+++ 之一。覆盖-v和-q。

--logdir=<dir>

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

（要写入名称完全可控的日志文件，请改用--log-to-stderr并按需要重定向 stderr。）

--common-caches=<dir>

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

自v2.15.2版本起可用。