数据集检查

注意

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

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

概要

Shell

codeql dataset check <options>... -- <dataset>

codeql dataset check <options>... -- <dataset>

描述

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

此命令通常对 CodeQL 提取器的开发者最有用，因为它会验证提取器生成的数据。如果对数据库的查询出现不一致的结果，它也可能有帮助，以排除底层数据问题导致的原因。

选项

主要选项

`<dataset>`

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

`--failing-exitcode=<code>`

[高级] 设置在出现任何失败时要返回的退出代码。通常为 1，但解析输出的工具可能会发现将其设为 0 更有用。

`--format=<fmt>`

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

text (default): 人类可读的文本渲染。

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

谁可以使用此功能？

本文内容

概要

描述

选项