此内容描述了 CodeQL CLI 的最新版本。 有关此版本的详细信息,请参阅 https://github.com/github/codeql-cli-binaries/releases 。
若要查看早期版本中此命令可用选项的详细信息,请在终端中使用 --help
选项运行命令。
摘要
codeql bqrs info <options>... -- <file>
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>
[高级] 将详细级别显式设置为“错误”、“警告”、“进度”、“进度+”、“进度++”、“进度+++”之一。 重写 -v
和 -q
。
--logdir=<dir>
[高级] 将详细日志写入给定目录中的一个或多个文件,其中生成的名称包括时间戳和正在运行的子命令的名称。
(若要使用可以完全控制的名称编写日志文件,请根据需要提供 --log-to-stderr
并重定向 stderr。)
--common-caches=<dir>
[高级] 控制磁盘上缓存数据的位置,此位置会在多次运行 CLI(例如下载的 QL 包和已编译查询计划)期间暂留。 如果未明确设置,则默认为用户主目录中名为 .codeql
的目录;如果尚不存在,则会创建该目录。
自 v2.15.2
起可用。