database export-diagnostics

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

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

摘要

Shell

codeql database export-diagnostics --format=<format> [--output=<output>] <options>... -- <database>

codeql database export-diagnostics --format=<format> [--output=<output>] <options>... -- <database>

说明

[实验性] 从数据库导出失败分析的诊断信息。

自 v2.12.6 起可用。

选项

主要选项

`<database>`

[必需] 正在构建的 CodeQL 数据库的路径。必须准备好此选项，以便使用 codeql database init 进行提取。

如果提供了 --db-cluster 选项，这不是数据库本身，而是一个包含数据库的目录，所有这些数据库将一起处理。

`--format=<format>`

[必需] 写入结果时采用的格式。下列其中一项：

raw：作为 JSON 对象的原始、未解释的诊断消息的列表。

sarif-latest：静态分析结果交换格式 (SARIF)，这是一种基于 JSON 的格式，用于描述静态分析结果。此格式选项使用最新的受支持版本 (v2.1.0)。此选项不适合用于自动化，因为它在不同 CodeQL 版本之间生成不同版本的 SARIF。

sarifv2.1.0：SARIF v2.1.0。

text：诊断消息的提要点列表。

`--[no-]db-cluster`

指示命令行上给定的目录不是数据库本身，而是包含一个或多个正在构建的数据库的目录。这些数据库将一起处理。

`-o, --output=<output>`

要向其写入诊断信息的输出路径。

`--sarif-exit-code=<sarifExitCode>`

[仅限 SARIF 格式] 失败进程的退出代码。

`--sarif-exit-code-description=<sarifExitCodeDescription>`

[仅限 SARIF 格式] 失败进程退出的原因。

`--sarif-category=<category>`

[仅限 SARIF 格式] [建议] 指定要包含在 SARIF 输出中的此分析的类别。类别可用于区分在同一提交和存储库上（但在不同语言或代码的不同部分）执行的多次分析。

如果以几种不同的方式（例如，针对不同的语言）分析同一版本的代码库并将结果上传到 GitHub 以在代码扫描中展示，则该值在每次分析之间应该不同，这告知代码扫描分析是相互补充的而不是相互取代的。（对于不同版本的代码库，相同分析的运行之间的值应保持一致。）

此值将显示为 <run>.automationDetails.id 属性（如果尚不存在，则会在结尾追加斜线）。

谁可以使用此功能？

本文内容

摘要

说明

选项

主要选项

`<database>`

`--format=<format>`

`--[no-]db-cluster`

`-o, --output=<output>`

`--sarif-exit-code=<sarifExitCode>`

`--sarif-exit-code-description=<sarifExitCodeDescription>`

`--sarif-category=<category>`

常用选项

`-h, --help`

`-J=<opt>`

`-v, --verbose`

`-q, --quiet`

`--verbosity=<level>`

`--logdir=<dir>`

`--common-caches=<dir>`