# bqrs info

显示 BQRS 文件的元数据。

> \[!NOTE]
> 此内容描述了 CodeQL CLI 的最新版本。 有关此版本的详细信息，请参阅 <https://github.com/github/codeql-cli-binaries/releases> 。
>
> 若要查看早期版本中此命令可用选项的详细信息，请在终端中使用 <span style="white-space: nowrap;">`--help`</span> 选项运行命令。

## 概要

```shell copy
codeql bqrs info <options>... -- <file>
```

## Description

显示 BQRS 文件的元数据。

此命令显示压缩二进制 BQRS 文件中包含的数据概览，该文件是执行查询的结果。 它显示 BQRS 文件中每个结果集（表）的名称和大小，以及每个结果集的列类型。

它还可以选择预先计算偏移量，以使用 [codeql bqrs decode](/zh/enterprise-server@3.20/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-decode) 的分页选项。 这主要适用于 IDE 插件。

## 选项

### 主要选项

#### `<file>`

```
          \[必选] 要显示其信息的 BQRS 文件。
```

#### `--format=<fmt>`

选择输出格式，可选`text`*（默认）* 或 `json`。

### 在 codeql bqrs decode 中支持分页

#### `--paginate-rows=<num>`

```
          \[高级] 与 `--format=json` 一起使用时，计算字节偏移量表，该表稍后可提供给 `--start-at` 的 [](/code-security/reference/code-scanning/codeql/codeql-cli-manual/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` 起可用。