{"meta":{"title":"database interpret-results","intro":"[管道] 将计算出的查询结果解释为有意义的格式，如 SARIF 或 CSV。","product":"安全性和代码质量","breadcrumbs":[{"href":"/zh/code-security","title":"安全性和代码质量"},{"href":"/zh/code-security/reference","title":"Reference"},{"href":"/zh/code-security/reference/code-scanning","title":"代码扫描"},{"href":"/zh/code-security/reference/code-scanning/codeql","title":"CodeQL"},{"href":"/zh/code-security/reference/code-scanning/codeql/codeql-cli-manual","title":"CodeQL CLI 手册"},{"href":"/zh/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-interpret-results","title":"database interpret-results"}],"documentType":"article"},"body":"# database interpret-results\n\n\\[管道] 将计算出的查询结果解释为有意义的格式，如 SARIF 或 CSV。\n\n> \\[!NOTE]\n> 此内容描述了 CodeQL CLI 的最新版本。 有关此版本的详细信息，请参阅 。\n>\n> 若要查看早期版本中此命令可用选项的详细信息，请在终端中使用 `--help` 选项运行命令。\n\n## 概要\n\n```shell copy\ncodeql database interpret-results --format= --output= [--threads=] ... -- ...\n```\n\n## Description\n\n```\n \\[管道] 将计算出的查询结果解释为有意义的格式，如 SARIF 或 CSV。\n```\n\n结果应已使用 [codeql database run-queries](/zh/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-run-queries) 计算并存储在 CodeQL 数据库目录中。 （通常需要使用 [codeql database analyze](/zh/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-analyze) 一起执行这些步骤）。\n\n## 选项\n\n### 主要选项\n\n#### ``\n\n```\n \\[必选] 已查询的 CodeQL 数据库的路径。\n```\n\n#### `...`\n\n在此处重复指定执行了哪些查询。\n\n如果省略，CLI 将使用与 [codeql database run-queries](/zh/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-run-queries) 相同的逻辑来确定一组合适的查询。\n\n（在将来的版本中，应该可以省略此内容，改为解释在数据库中找到的所有结果。 目前还无法享受此便利。 很抱歉。）\n\n#### `--format=`\n\n```\n \\[必选] 写入结果的格式。 下列其中一项：\n\n `csv`：带格式的逗号分隔值，包括包含规则和警报元数据的列。\n\n `sarif-latest`：静态分析结果交换格式 (SARIF)，一种基于 JSON 的静态分析结果描述格式。 此格式选项使用最新的受支持版本 (v2.1.0)。 此选项不适合用于自动化，因为它在不同 CodeQL 版本之间生成不同版本的 SARIF。\n\n `sarifv2.1.0`：SARIF v2.1.0。\n\n `graphtext`：表示图形的文本格式。 仅与具有 @kind 图形的查询兼容。\n\n `dgml`：有向图标记语言，一种基于 XML 的图形描述格式。 仅与具有 @kind 图形的查询兼容。\n\n `dot`：Graphviz DOT 语言，一种基于文本的图形描述格式。\n```\n\n仅与具有 @kind 图形的查询兼容。\n\n#### `-o, --output=`\n\n```\n \\[必选] 写入结果的输出路径。 对于图形格式，这应该是一个目录，结果（如果此命令支持解释多个查询，则为多个结果）将写入该目录中。\n```\n\n#### `--max-paths=`\n\n要为每个具有路径的警报生成的最大路径数。\n（默认值：4）\n\n#### `--[no-]sarif-add-file-contents`\n\n```\n \\[仅 SARIF 格式] 包含至少一个结果中引用的所有文件的完整文件内容。\n```\n\n#### `--[no-]sarif-add-snippets`\n\n```\n \\[仅 SARIF 格式] 包含结果中提到的每个位置的代码片段，报告位置前后各包含两行上下文。\n```\n\n#### `--[no-]sarif-add-query-help`\n\n```\n \\[仅 SARIF 格式] \\[已弃用] 包含所有查询的 Markdown 查询帮助。 它从 /path/to/query.md 文件加载 /path/to/query.ql 的查询帮助。 如果未提供此标志，则默认行为仅包含自定义查询（即查询包中并非 \\`codeql/\\`\n\n```\n \\[仅 SARIF 格式] 指定是否在 SARIF 输出中包含查询帮助。 下列其中一项：\n\n `always`：包含所有查询的查询帮助。\n\n `custom_queries_only`\n _（默认）_：仅包含自定义查询的查询帮助，即查询包中不属于 \\`codeql/\\.tool.extensions` 属性中。 此选项在传递给 [codeql bqrs interpret](/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-interpret) 时不起作用。\n```\n\n#### `--[no-]sarif-multicause-markdown`\n\n```\n \\[仅 SARIF 格式] 对于有多个原因的警报，除了以纯字符串形式外，还以 Markdown 格式的项目符号列表形式包含在输出中。\n```\n\n#### `--no-sarif-minify`\n\n```\n \\[仅 SARIF 格式] 生成格式美观的 SARIF 输出。 默认情况下，SARIF 输出会缩小，以减少输出文件的大小。\n```\n\n#### `--sarif-run-property=`\n\n```\n \\[仅 SARIF 格式] 要添加到生成的 SARIF“run”属性包中的键值对。 可以重复。\n```\n\n#### `--no-group-results`\n\n```\n \\[仅 SARIF 格式] 每条消息生成一个结果，而非每个唯一位置生成一个结果。\n```\n\n#### `--csv-location-format=`\n\n在 CSV 输出中生成位置时采用的格式。 即以下值之一：uri、line-column、offset-length。 （默认值：line-column）\n\n#### `--dot-location-url-format=`\n\n一个格式字符串，用于定义在 DOT 输出中生成文件位置 URL 时采用的格式。 可使用以下占位符：{path} {start:line} {start:column} {end:line} {end:column}, {offset}, {length}\n\n#### `--[no-]sublanguage-file-coverage`\n\n```\n \\[仅 GitHub.com 和 GitHub Enterprise Server v3.12.0+] 使用子语言文件覆盖率信息。 这会为共享 C 和 C++、Java 和 Kotlin，以及 JavaScript 和 TypeScript 等 CodeQL 提取程序包的语言计算、显示和导出单独的文件覆盖信息。\n```\n\n自 `v2.15.2` 起可用。\n\n#### `--sarif-category=`\n\n```\n \\[仅 SARIF 格式] \\[建议] 指定要包含在 SARIF 输出中的此分析的类别。 类别可用于区分在同一提交和存储库上（但在不同语言或代码的不同部分）执行的多次分析。\n```\n\n如果以多种不同方式分析同一版本的代码库（例如，针对不同语言）并将结果上传到 GitHub 以在代码扫描中呈现，则每次分析的此值应不同，这会告知代码扫描这些分析是\\_补充\\_而非\\_替代\\_彼此。 （对于代码库的\\_不同\\_版本，同一分析的运行之间的值应保持一致。）\n\n此值将显示为 `.automationDetails.id` 属性（如果尚不存在，则会在结尾追加斜线）。\n\n#### `-j, --threads=`\n\n用于计算路径的线程数。\n\n默认值为 1。 可以传递 0 以在机器上每个内核使用一个线程，或传递 -*N* 以保留 *N* 个内核不使用（但仍至少使用一个线程）。\n\n#### `--no-database-extension-packs`\n\n```\n \\[高级] 数据库创建期间忽略存储在数据库中的扩展包（无论是来自代码扫描配置文件还是分析代码库“extensions”目录中存储的扩展文件）。\n```\n\n#### `--[no-]print-diagnostics-summary`\n\n将分析诊断的摘要输出到标准输出。\n\n#### `--[no-]print-metrics-summary`\n\n将分析指标的摘要输出到标准输出。\n\n#### `--[no-]print-baseline-loc`\n\n将计数的基线代码行输出到标准输出。\n\n### 用于配置 CodeQL 包管理器的选项\n\n#### `--registries-auth-stdin`\n\n通过传递逗号分隔的 \\=\\ 对列表，向 GitHub Enterprise Server 容器注册表进行身份验证。\n\n例如，可以传递 `https://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2`\n向两个 GitHub Enterprise Server 实例进行身份验证。\n\n这会替代 CODEQL\\_REGISTRIES\\_AUTH and GITHUB\\_TOKEN 环境变量。 如果只需向 github.com 容器注册表进行身份验证，则可以改用更简单的 `--github-auth-stdin` 选项进行身份验证。\n\n#### `--github-auth-stdin`\n\n通过标准输入传递 github.com GitHub 应用令牌或个人访问令牌，对 github.com 容器注册表进行身份验证。\n\n要向 GitHub Enterprise Server 容器注册表进行身份验证，请传递 `--registries-auth-stdin` 或使用 CODEQL\\_REGISTRIES\\_AUTH 环境变量。\n\n这会替代 GITHUB\\_TOKEN 环境变量。\n\n### 用于指定解释结果时要使用的扩展的选项\n\n####\n\n```\n `--model-packs=<`\n >...\n```\n\n将用作模型包来自定义要评估的查询的 CodeQL 包名称列表（每个包都有一个可选的版本范围）。\n\n### 查找 QL 包的选项（这可能是解释查询套件所必需的）\n\n#### `--search-path=[:...]`\n\n可在其中找到 QL 包的目录列表。 每个目录可以是一个 QL 包（或在根目录下包含一个 `.codeqlmanifest.json` 文件的多个包），也可以是一个或多个此类目录的直接父目录。\n\n如果路径包含多个目录，则它们的顺序定义了它们之间的优先级：当必须解析的包名称在多个目录树中匹配时，给定的第一个目录树优先。\n\n在查询其中一种语言时，将其指向开源 CodeQL 存储库的签出应该是可行的。\n\n如果已将 CodeQL 存储库签出为未打包的 CodeQL 工具链的同级，则无需提供此选项；将始终在此类同级目录中搜索以其他方式找不到的 QL 包。 （如果此默认值不起作用，强烈建议在每用户配置文件中一次性设置 `--search-path`）。\n\n（注意：在 Windows 上，路径分隔符为 `;`）。\n\n#### `--additional-packs=[:...]`\n\n如果给定了此目录列表，则先在这些目录中的搜索包，然后在 `--search-path` 中的目录搜索包。 它们之间的顺序并不重要；如果在此列表的两个不同位置发现同一个包名称，这是一个错误。\n\n如果你正临时开发一个同时出现在默认路径中的新版本的包，这将非常有用。 另一方面，\\_不建议\\_在配置文件中覆盖此选项；某些内部操作会动态添加此选项，覆盖任何已配置的值。\n\n（注意：在 Windows 上，路径分隔符为 `;`）。\n\n### 常用选项\n\n#### `-h, --help`\n\n显示此帮助文本。\n\n#### `-J=`\n\n```\n \\[高级] 向运行命令的 JVM 提供选项。\n```\n\n（请注意，无法正确处理包含空格的选项。）\n\n#### `-v, --verbose`\n\n以增量方式增加输出的进度消息数。\n\n#### `-q, --quiet`\n\n以增量方式减少输出的进度消息数。\n\n#### `--verbosity=`\n\n```\n \\[高级] 明确将详细级别设置为 errors、warnings、progress、progress+、progress++、progress+++ 之一。 重写 `-v` 和 `-q`。\n```\n\n#### `--logdir=`\n\n```\n \\[高级] 将详细日志写入指定目录中的一个或多个文件，生成的文件名包含时间戳和正在运行的子命令名称。\n```\n\n（要使用可以完全控制的名称编写日志文件，请根据需要提供 `--log-to-stderr` 并重定向 stderr。）\n\n#### `--common-caches=`\n\n```\n \\[高级] 控制磁盘上缓存数据的位置，这些数据将在 CLI 的多次运行之间保留，例如下载的 QL 包和编译的查询计划。 如果未明确设置，则默认为用户主目录中名为 `.codeql` 的目录；如果尚不存在，则会创建该目录。\n```\n\n自 `v2.15.2` 起可用。"}