# 数据库分析 分析数据库，在源代码的上下文中生成有意义的结果。 > \[!NOTE] > 此内容描述了 CodeQL CLI 的最新版本。 有关此版本的详细信息，请参阅 。 > > 若要查看早期版本中此命令可用选项的详细信息，请在终端中使用 `--help` 选项运行命令。 ## 概要 ```shell copy codeql database analyze --format= --output= [--threads=] [--ram=] ... -- ... ``` ## Description 分析数据库，在源代码的上下文中生成有意义的结果。 针对 CodeQL 数据库运行查询套件（或一些单独的查询），以 SARIF 或其他解释格式生成警报或路径样式的结果。 此命令结合了 [codeql database run-queries](/zh/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-run-queries) 和 [codeql database interpret-results](/zh/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-interpret-results) 命令的效果。 如果要运行结果\_不\_符合解释为源代码警报要求的查询，请改用 [codeql database run-queries](/zh/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-run-queries) 或 [codeql query run](/zh/code-security/reference/code-scanning/codeql/codeql-cli-manual/query-run)，然后使用 [codeql bqrs decode](/zh/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-decode) 将原始结果转换为可读表示形式。 ## 选项 ### 主要选项 #### `` ``` \[必选] 要查询的 CodeQL 数据库的路径。 ``` #### `...` 要执行的查询。 每个参数均采用 `scope/name@range:path` 形式，其中： * ``` `scope/name` 是 CodeQL 包的限定名称。 ``` * ``` `range` 是语义化版本范围。 ``` * ``` `path` 是文件系统路径。 ``` 如果指定了 `scope/name`，则 `range` 和 `path` 是可选的。 如果缺少 `range`，则使用指定包的最新版本。 如果缺少 `path`，则使用指定包的默认查询套件。 ``` `path` 可以是 `*.ql` 查询文件、包含一个或多个查询的目录或 `.qls` 查询套件文件。 如果未指定包名，则必须提供 `path`，并将其解释为相对于当前进程的当前工作目录。 ``` 要指定包含文字 `path` 或 `@` 的 `:`，请使用 `path:` 作为参数的前缀，如下所示：`path:directory/with:and@/chars`。 如果指定 `scope/name` 和 `path`，则 `path` 不能为绝对路径。 此路径应为 CodeQL 包的根的相对路径。 如果未指定任何查询，CLI 将自动确定要运行的一组合适的查询。 具体而言，如果在创建数据库时使用 `--codescanning-config` 指定了代码扫描配置文件，则将使用来自此路径的查询。 否则，将使用所分析语言的默认查询。 #### `--format=` ``` \[必选] 写入结果的格式。 下列其中一项： `csv`：带格式的逗号分隔值，包括包含规则和警报元数据的列。 `sarif-latest`：静态分析结果交换格式 (SARIF)，一种基于 JSON 的静态分析结果描述格式。 此格式选项使用最新的受支持版本 (v2.1.0)。 此选项不适合用于自动化，因为它在不同 CodeQL 版本之间生成不同版本的 SARIF。 `sarifv2.1.0`：SARIF v2.1.0。 `graphtext`：表示图形的文本格式。 仅与具有 @kind 图形的查询兼容。 `dgml`：有向图标记语言，一种基于 XML 的图形描述格式。 仅与具有 @kind 图形的查询兼容。 `dot`：Graphviz DOT 语言，一种基于文本的图形描述格式。 ``` 仅与具有 @kind 图形的查询兼容。 #### `-o, --output=` ``` \[必选] 写入结果的输出路径。 对于图形格式，这应该是一个目录，结果（如果此命令支持解释多个查询，则为多个结果）将写入该目录中。 ``` #### `--[no-]rerun` 评估数据库中已存储 BQRS 结果的偶数查询。 #### `--no-print-diagnostics-summary` 请勿将分析诊断的摘要打印为标准输出。 #### `--no-print-metrics-summary` 请勿将分析指标的摘要打印为标准输出。 #### `--max-paths=` 要为每个具有路径的警报生成的最大路径数。 （默认值：4） #### `--[no-]sarif-add-file-contents` ``` \[仅 SARIF 格式] 包含至少一个结果中引用的所有文件的完整文件内容。 ``` #### `--[no-]sarif-add-snippets` ``` \[仅 SARIF 格式] 包含结果中提到的每个位置的代码片段，报告位置前后各包含两行上下文。 ``` #### `--[no-]sarif-add-query-help` ``` \[仅 SARIF 格式] \[已弃用] 包含所有查询的 Markdown 查询帮助。 它从 /path/to/query.md 文件加载 /path/to/query.ql 的查询帮助。 如果未提供此标志，则默认行为仅包含自定义查询（即查询包中并非 \`codeql/\` ``` \[仅 SARIF 格式] 指定是否在 SARIF 输出中包含查询帮助。 下列其中一项： `always`：包含所有查询的查询帮助。 `custom_queries_only` _（默认）_：仅包含自定义查询的查询帮助，即查询包中不属于 \`codeql/\.tool.extensions` 属性中。 此选项在传递给 [codeql bqrs interpret](/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-interpret) 时不起作用。 ``` #### `--[no-]sarif-multicause-markdown` ``` \[仅 SARIF 格式] 对于有多个原因的警报，除了以纯字符串形式外，还以 Markdown 格式的项目符号列表形式包含在输出中。 ``` #### `--no-sarif-minify` ``` \[仅 SARIF 格式] 生成格式美观的 SARIF 输出。 默认情况下，SARIF 输出会缩小，以减少输出文件的大小。 ``` #### `--sarif-run-property=` ``` \[仅 SARIF 格式] 要添加到生成的 SARIF“run”属性包中的键值对。 可以重复。 ``` #### `--no-group-results` ``` \[仅 SARIF 格式] 每条消息生成一个结果，而非每个唯一位置生成一个结果。 ``` #### `--csv-location-format=` 在 CSV 输出中生成位置时采用的格式。 即以下值之一：uri、line-column、offset-length。 （默认值：line-column） #### `--dot-location-url-format=` 一个格式字符串，用于定义在 DOT 输出中生成文件位置 URL 时采用的格式。 可使用以下占位符：{path} {start:line} {start:column} {end:line} {end:column}, {offset}, {length} #### `--[no-]sublanguage-file-coverage` ``` \[仅 GitHub.com 和 GitHub Enterprise Server v3.12.0+] 使用子语言文件覆盖率信息。 这会为共享 C 和 C++、Java 和 Kotlin，以及 JavaScript 和 TypeScript 等 CodeQL 提取程序包的语言计算、显示和导出单独的文件覆盖信息。 ``` 自 `v2.15.2` 起可用。 #### `--sarif-category=` ``` \[仅 SARIF 格式] \[建议] 指定要包含在 SARIF 输出中的此分析的类别。 类别可用于区分在同一提交和存储库上（但在不同语言或代码的不同部分）执行的多次分析。 ``` 如果以多种不同方式分析同一版本的代码库（例如，针对不同语言）并将结果上传到 GitHub 以在代码扫描中呈现，则每次分析的此值应不同，这会告知代码扫描这些分析是\_补充\_而非\_替代\_彼此。 （对于代码库的\_不同\_版本，同一分析的运行之间的值应保持一致。） 此值将显示为 `.automationDetails.id` 属性（如果尚不存在，则会在结尾追加斜线）。 #### `--no-database-extension-packs` ``` \[高级] 数据库创建期间忽略存储在数据库中的扩展包（无论是来自代码扫描配置文件还是分析代码库“extensions”目录中存储的扩展文件）。 ``` #### `--no-database-threat-models` ``` \[高级] 忽略数据库创建期间从代码扫描配置文件中存储的威胁模型配置。 ``` #### `--[no-]download` 在分析之前下载任何缺失的查询。 ### 用于控制要使用的模型包的选项 #### ``` `--model-packs=<` >... ``` 将用作模型包来自定义要评估的查询的 CodeQL 包名称列表（每个包都有一个可选的版本范围）。 ### 控制要使用的威胁模型的选项 #### `--threat-model=...` 要启用或禁用的威胁模型列表。 该参数是威胁模型的名称，前面可选择性地加上“!”。 如果“!”不存在，则启用指定的威胁模型及其所有后代。 如果“!”存在，则禁用指定的威胁模型及其所有后代。 默认启用“default”威胁模型，但可以通过指定“--threat-model !default”来禁用。 “all”威胁模型可用于启用或禁用所有威胁模型。 \--threat-model 选项按顺序进行处理。 例如，“--threat-model local --threat-model !environment”启用“local”组中除“environment”威胁模型之外的所有威胁模型。 此选项仅对支持威胁模型的语言有效。 自 `v2.15.3` 起可用。 ### 用于控制查询计算器的选项 #### `--[no-]tuple-counting` ``` \[高级] 在查询计算器日志中显示每个评估步骤的元组计数。 如果提供了 `--evaluator-log` 选项，则元组计数将包含在命令生成的基于文本的 JSON 日志和结构化 JSON 日志中。 （这对复杂 QL 代码的性能优化非常有用）。 ``` #### `--timeout=` ``` \[高级] 设置查询评估的超时时间（以秒为单位）。 ``` 超时功能旨在捕获复杂查询需要“长久时间”来评估的情况。 这不是限制查询评估可花费的总时间的有效方法。 只要计算的每个单独计时部分在超时时间内完成，就允许评估继续进行。 目前，这些单独计时部分是已优化查询的“RA 层”，但将来可能会变化。 如果未指定超时或将其指定为 0，则不会设置超时（[codeql test run](/zh/code-security/reference/code-scanning/codeql/codeql-cli-manual/test-run) 除外，默认超时为 5 分钟）。 #### `-j, --threads=` 使用如此多的线程来评估查询。 默认值为 1。 可以传递 0 以在机器上每个内核使用一个线程，或传递 -*N* 以保留 *N* 个内核不使用（但仍至少使用一个线程）。 #### `--[no-]save-cache` ``` \[已弃用] \[高级] 此标志没有任何作用。 ``` #### `--[no-]expect-discarded-cache` ``` \[高级] 基于查询执行后将丢弃缓存的假设，决定要评估哪些谓词以及要写入磁盘缓存的内容。 ``` #### `--[no-]keep-full-cache` ``` \[高级] 评估完成后不清理磁盘缓存。 ``` 如果以后要执行 [codeql dataset cleanup](/zh/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-cleanup) 或 [codeql database cleanup](/zh/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-cleanup)，这样可能会节省时间。 #### `--max-disk-cache=` 设置磁盘缓存可用于中间查询结果的最大空间量。 如果未显式配置此大小，计算器将根据数据集大小和查询复杂性尝试使用“合理的”缓存空间量。 显式设置高于此默认使用量的限制将启用额外的缓存，从而加快以后的查询速度。 #### `--min-disk-free=` ``` \[高级] 设置文件系统的目标可用空间量。 ``` 如果未提供 `--max-disk-cache`，当文件系统上的可用空间低于此值时，计算器便会努力减少磁盘缓存使用量。 #### `--min-disk-free-pct=` ``` \[高级] 设置文件系统的目标可用空间比例。 ``` 如果未提供 `--max-disk-cache`，当文件系统上的可用空间低于此百分比时，计算器便会努力减少磁盘缓存使用量。 #### `--external==` 包含外部谓词 *\* 的行的 CSV 文件。 可以提供多个 `--external` 选项。 #### `--xterm-progress=` ``` \[高级] 控制在 QL 评估期间是否使用 xterm 控制序列显示进度跟踪。 可能的值为： `no`：从不显示高级进度；假设为无交互终端。 `auto` _（默认）_：自动检测命令是否在合适的终端中运行。 `yes`：假设终端能够理解 xterm 控制序列。 该功能仍取决于能否自动检测终端的大小（抱歉，Windows 系统暂未实现此功能），如果指定了 __，该功能也将被禁用`-q`。 `25x80`（或类似）：与 `yes` 类似，并且明确指定终端大小。 （与 `yes` 不同，此功能应可在 Windows 操作系统上正常运行。） `25x80:/dev/pts/17`（或类似）：在_不同于_标准错误输出的终端上显示高级进度。 主要对内部测试有用。 ``` ### 用于控制结构化计算器日志输出的选项 #### `--evaluator-log=` ``` \[高级] 将有关计算器性能的结构化日志输出到指定文件。 此日志文件的格式可能会更改，恕不通知，但是它将是一连串用两个换行符（默认）或一个换行符（通过传递了 `--evaluator-log-minify` 选项）分隔的 JSON 对象。 请使用 `codeql generate log-summary ` 生成此文件的更稳定的摘要，并避免直接分析该文件。 如果文件存在，将覆盖该文件。 ``` #### `--evaluator-log-minify` ``` \[高级] 如果传递了 `--evaluator-log` 选项，同时传递此选项将最小化生成的 JSON 日志大小，但会大幅降低其人类可读性。 ``` ### 用于控制 RAM 使用情况的选项 #### `-M, --ram=` 查询计算器将努力将其总内存占用情况保持在此值以下。 （不过，对于大型数据库，基于文件的内存映射可能会突破此阈值，在内存紧张时可交换到磁盘）。 该值应至少为 2048 MB；较小的值将以透明方式向上舍入。 ### 用于控制 QL 编译的选项 #### `--warnings=` 如何处理来自 QL 编译器的警告。 下列其中一项： ``` `hide`：抑制警告。 `show` _（默认）_：打印警告但继续编译。 `error`：将警告视为错误。 ``` #### `--no-debug-info` 在 RA 中没有发出源位置信息以供调试。 #### `--[no-]fast-compilation` ``` \[已弃用] \[高级] 省略特别缓慢的优化步骤。 ``` #### `--no-release-compatibility` ``` \[高级] 使用最新的编译器功能，但会牺牲可移植性。 ``` QL 评估器的部分版本将时不时支持新的 QL 语言功能和计算器优化并会在 QL 编译器中默认启用它们。 这有助于确保你在最新的 CodeQL 版本中开发查询时体验到的性能可以与代码扫描或 CI 集成中可能仍在使用的稍旧版本相匹配。 如果你不关心查询是否与其他 CodeQL 版本（更低版本或更高版本）兼容，有时可以通过使用此标志提前在编译器中启用最新改进来实现少量的额外性能。 如果版本中最近没有要启用的改进，此选项以无提示方式不执行任何操作。 因此，可以安全地在全局 CodeQL 配置文件中一劳永逸地设置它。 自 `v2.11.1` 起可用。 #### `--[no-]local-checking` 仅对所使用的部分 QL 源执行初始检查。 #### `--no-metadata-verification` 为保证有效性，请勿在 QLDoc 注释中检查嵌入的查询元数据。 #### `--compilation-cache-size=` ``` \[高级] 覆盖编译缓存目录的默认最大大小。 ``` #### `--fail-on-ambiguous-relation-name` ``` \[高级] 如果编译期间生成模糊的关系名称，则编译失败。 ``` ### 用于设置编译环境的选项 #### `--search-path=[:...]` 可在其中找到 QL 包的目录列表。 每个目录可以是一个 QL 包（或在根目录下包含一个 `.codeqlmanifest.json` 文件的多个包），也可以是一个或多个此类目录的直接父目录。 如果路径包含多个目录，则它们的顺序定义了它们之间的优先级：当必须解析的包名称在多个目录树中匹配时，给定的第一个目录树优先。 在查询其中一种语言时，将其指向开源 CodeQL 存储库的签出应该是可行的。 如果已将 CodeQL 存储库签出为未打包的 CodeQL 工具链的同级，则无需提供此选项；将始终在此类同级目录中搜索以其他方式找不到的 QL 包。 （如果此默认值不起作用，强烈建议在每用户配置文件中一次性设置 `--search-path`）。 （注意：在 Windows 上，路径分隔符为 `;`）。 #### `--additional-packs=[:...]` 如果给定了此目录列表，则先在这些目录中的搜索包，然后在 `--search-path` 中的目录搜索包。 它们之间的顺序并不重要；如果在此列表的两个不同位置发现同一个包名称，这是一个错误。 如果你正临时开发一个同时出现在默认路径中的新版本的包，这将非常有用。 另一方面，\_不建议\_在配置文件中覆盖此选项；某些内部操作会动态添加此选项，覆盖任何已配置的值。 （注意：在 Windows 上，路径分隔符为 `;`）。 #### `--library-path=[:...]` ``` \[高级] 可选目录列表，这些目录将添加到 QL 库的原始导入搜索路径。 只有在使用未打包为 QL 包的 QL 库时，才应使用此选项。 ``` （注意：在 Windows 上，路径分隔符为 `;`）。 #### `--dbscheme=` ``` \[高级] 明确定义查询应针对哪个 dbscheme 进行编译。 这只能由非常确定自己在做什么的调用方提供。 ``` #### `--compilation-cache=` ``` \[高级] 指定额外目录用作编译缓存。 ``` #### `--no-default-compilation-cache` ``` \[高级] 不使用标准位置的编译缓存，例如包含查询的 QL 包或 CodeQL 工具链目录中的缓存。 ``` ### 用于配置 CodeQL 包管理器的选项 #### `--registries-auth-stdin` 通过传递逗号分隔的 \=\ 对列表，向 GitHub Enterprise Server 容器注册表进行身份验证。 例如，可以传递 `https://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2` 向两个 GitHub Enterprise Server 实例进行身份验证。 这会替代 CODEQL\_REGISTRIES\_AUTH and GITHUB\_TOKEN 环境变量。 如果只需向 github.com 容器注册表进行身份验证，则可以改用更简单的 `--github-auth-stdin` 选项进行身份验证。 #### `--github-auth-stdin` 通过标准输入传递 github.com GitHub 应用令牌或个人访问令牌，对 github.com 容器注册表进行身份验证。 要向 GitHub Enterprise Server 容器注册表进行身份验证，请传递 `--registries-auth-stdin` 或使用 CODEQL\_REGISTRIES\_AUTH 环境变量。 这会替代 GITHUB\_TOKEN 环境变量。 ### 常用选项 #### `-h, --help` 显示此帮助文本。 #### `-J=` ``` \[高级] 向运行命令的 JVM 提供选项。 ``` （请注意，无法正确处理包含空格的选项。） #### `-v, --verbose` 以增量方式增加输出的进度消息数。 #### `-q, --quiet` 以增量方式减少输出的进度消息数。 #### `--verbosity=` ``` \[高级] 明确将详细级别设置为 errors、warnings、progress、progress+、progress++、progress+++ 之一。 重写 `-v` 和 `-q`。 ``` #### `--logdir=` ``` \[高级] 将详细日志写入指定目录中的一个或多个文件，生成的文件名包含时间戳和正在运行的子命令名称。 ``` （要使用可以完全控制的名称编写日志文件，请根据需要提供 `--log-to-stderr` 并重定向 stderr。） #### `--common-caches=` ``` \[高级] 控制磁盘上缓存数据的位置，这些数据将在 CLI 的多次运行之间保留，例如下载的 QL 包和编译的查询计划。 如果未明确设置，则默认为用户主目录中名为 `.codeql` 的目录；如果尚不存在，则会创建该目录。 ``` 自 `v2.15.2` 起可用。