# 数据集检查

[管道] 检查特定数据集的内部一致性。

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

## 概要

```shell copy
codeql dataset check <options>... -- <dataset>
```

## Description

              \[管道] 检查特定数据集的内部一致性。

此命令对 CodeQL 提取程序的开发人员最有用，因为它验证提取程序生成的数据。 如果针对数据库的查询给出不一致的结果，它也可能很有用，因为它可排除基础数据中的问题。

## 选项

### 主要选项

#### `<dataset>`

              \[必选] 要检查的原始 QL 数据集的路径。

#### `--failing-exitcode=<code>`

              \[高级] 设置遇到任何失败时要生成的退出代码。 通常为 1，但分析输出的工具可能会发现将其设置为 0 很有用。

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

选择输出格式。 可能的选项：

              `text`
              _（默认）_：人类可读的文本呈现。

              `json`：对象的流式 JSON 数组。

              `jsonz`：零终止的 JSON 对象流。

#### `--[no-]precise-locations`

              \[高级] 花费额外精力计算不一致的精确位置。 这将花费更多时间，但可能会更容易调试提取程序行为。

#### `--max-resolve-depth=<n>`

              \[高级] 为解释不一致而应解析 ID 的最大深度。 （默认值：3）

#### `--max-errors-per-checker=<n>`

应明确报告的每种不一致错误的最大数量。 （默认值：5）

### 常用选项

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