跳至主要内容

bqrs 信息

显示 BQRS 文件的元数据。

谁可以使用此功能?

CodeQL 可用于以下存储库类型

本文内容

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

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

概要

Shell
codeql bqrs info <options>... -- <file>

描述

显示 BQRS 文件的元数据。

此命令显示执行查询后生成的紧凑型二进制 BQRS 文件中包含的数据概述。它显示 BQRS 文件中每个结果集(表)的名称和大小,以及每个结果集的列类型。

它还可以选择性地预计算偏移量,以便使用 codeql bqrs decode 的分页选项。这主要对 IDE 插件有用。

选项

主要选项

<file>

[必填] 要显示信息的 BQRS 文件。

--format=<fmt>

选择输出格式,text (默认)json

在 codeql bqrs decode 中支持分页

--paginate-rows=<num>

[高级] 与 --format=json 一起使用时,计算字节偏移量表,稍后可将其提供给 codeql bqrs decode--start-at 选项,以从位置 0、<num>、2*<num> 等开始流式传输结果。

--paginate-result-set=<name>

[高级] 仅对名称与此名称匹配的结果集处理 --paginate-rows。(如果名称与任何结果集都不匹配,则 --paginate-rows 为无操作)。

常用选项

-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 起可用。