{"meta":{"title":"bqrs 解码","intro":"将结果数据从 BQRS 转换为其他形式。","product":"安全性和代码质量","breadcrumbs":[{"href":"/zh/code-security","title":"安全性和代码质量"},{"href":"/zh/code-security/reference","title":"Reference"},{"href":"/zh/code-security/reference/code-scanning","title":"代码扫描"},{"href":"/zh/code-security/reference/code-scanning/codeql","title":"CodeQL"},{"href":"/zh/code-security/reference/code-scanning/codeql/codeql-cli-manual","title":"CodeQL CLI 手册"},{"href":"/zh/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-decode","title":"bqrs 解码"}],"documentType":"article"},"body":"# bqrs 解码\n\n将结果数据从 BQRS 转换为其他形式。\n\n> \\[!NOTE]\n> 此内容描述了 CodeQL CLI 的最新版本。 有关此版本的详细信息，请参阅 <https://github.com/github/codeql-cli-binaries/releases> 。\n>\n> 若要查看早期版本中此命令可用选项的详细信息，请在终端中使用 <span style=\"white-space: nowrap;\">`--help`</span> 选项运行命令。\n\n## 概要\n\n```shell copy\ncodeql bqrs decode [--output=<file>] [--result-set=<name>] [--sort-key=<col>[,<col>...]] <options>... -- <file>\n```\n\n## Description\n\n将结果数据从 BQRS 转换为其他形式。\n\n除非指定 `--output` 选项，否则会将解码的输出写入标准输出。\n\n## 选项\n\n### 主要选项\n\n#### `<file>`\n\n```\n          \\[必选] 要解码的 BQRS 文件。\n```\n\n#### `-o, --output=<file>`\n\n要向其写入所需输出的文件。\n\n#### `-r, --result-set=<name>`\n\n从 BQRS 文件选择要解码的特定结果集。 可通过 [codeql bqrs info](/zh/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-info) 列出可用结果集。\n\n如果未选择任何结果集，则将解码所有结果集，前提是所选输出格式和处理选项支持这些结果集。\n否则会导致错误。\n\n#### `-k, --sort-key=<col>[,<col>...]`\n\n按指示的列对所选结果集进行排序。\n\n#### `--sort-direction=<direction>[,<direction>...]`\n\n使用指示的排序方向对所选结果集进行排序。\n\n如果未指定排序方向，则将对所有列使用升序。\n\n### 输出格式选项\n\n#### `--format=<fmt>`\n\n选择输出格式。 选项包括：\n\n```\n          `text`\n          _（默认）_：人类可读的纯文本表格。\n\n          `csv`：逗号分隔值。\n\n          `json`：流式 JSON。\n\n          `bqrs`：BQRS。 必须与 `--output` 一起使用。 与 `--sort-key` 一起使用最有用。\n```\n\n#### `--no-titles`\n\n省略 `text` 和 `csv` 格式的列标题\n\n#### `--entities=<fmt>[,<fmt>...]`\n\n```\n          \\[高级] 控制实体类型的结果列的显示方式。 以下选项的逗号分隔列表：\n\n          `url`：指向源位置的 URL（如果查询已编译为实体类型生成此类 URL）。\n\n          `string`：QL 中 toString() 方法计算的字符串（如果查询已编译为该列生成此类字符串）。\n\n          `id`：实体的内部 ID，可能无实际意义。\n\n          `all`：显示包含 BQRS 文件提供的所有信息的列。\n```\n\n如果可能，将显示所有选定的选项。\n\n### 分页选项（供交互式前端使用）\n\n#### `--rows=<num>`\n\n```\n          \\[高级] 从所选结果集中输出指定数量的行，从顶部开始或从 `--start-at` 给定的位置开始。\n```\n\n#### `--start-at=<offset>`\n\n```\n          \\[高级] 从 BQRS 文件中特定字节偏移量处定义的行开始打印。 偏移量必须从 [codeql bqrs info](/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-info) 获取，或从上一次设置了 `--rows` 的调用的 JSON 输出中找到的“next”指针获取。 其他偏移量可能会产生无意义的输出和/或显式错误。\n```\n\n必须始终与 `--rows` 一起使用，并且与 `--sort-key` 不兼容。\n\n### 常用选项\n\n#### `-h, --help`\n\n显示此帮助文本。\n\n#### `-J=<opt>`\n\n```\n          \\[高级] 向运行命令的 JVM 提供选项。\n```\n\n（请注意，无法正确处理包含空格的选项。）\n\n#### `-v, --verbose`\n\n以增量方式增加输出的进度消息数。\n\n#### `-q, --quiet`\n\n以增量方式减少输出的进度消息数。\n\n#### `--verbosity=<level>`\n\n```\n          \\[高级] 明确将详细级别设置为 errors、warnings、progress、progress+、progress++、progress+++ 之一。 重写 `-v` 和 `-q`。\n```\n\n#### `--logdir=<dir>`\n\n```\n          \\[高级] 将详细日志写入指定目录中的一个或多个文件，生成的文件名包含时间戳和正在运行的子命令名称。\n```\n\n（要使用可以完全控制的名称编写日志文件，请根据需要提供 `--log-to-stderr` 并重定向 stderr。）\n\n#### `--common-caches=<dir>`\n\n```\n          \\[高级] 控制磁盘上缓存数据的位置，这些数据将在 CLI 的多次运行之间保留，例如下载的 QL 包和编译的查询计划。 如果未明确设置，则默认为用户主目录中名为 `.codeql` 的目录；如果尚不存在，则会创建该目录。\n```\n\n自 `v2.15.2` 起可用。"}