跳至主要内容

bqrs info

显示 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 一起使用时,计算字节偏移表,稍后可将其提供给 --start-at 选项的 codeql bqrs decode,以在位置 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 起可用。

© . This site is unofficial and not affiliated with GitHub, Inc.