执行查询

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

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

概要

Shell

codeql execute queries [--output=<dir|file.bqrs>] [--threads=<num>] <options>... -- <dataset> <query|dir|suite|pack>...

codeql execute queries [--output=<dir|file.bqrs>] [--threads=<num>] <options>... -- <dataset> <query|dir|suite|pack>...

描述

[底层实现] 对数据集运行一个或多个查询。

通常不应直接调用此命令。请改用 codeql database run-queries 或 codeql query run，它们将使用特定的 JVM 选项启动 codeql execute queries 以调整 QL 评估器的性能。

选项

主要选项

`<dataset>`

[必填] 要查询的原始 QL 数据集的路径。

`<querysuite|pack>...`

[必填] 要执行的查询。每个参数的格式为 scope/name@range:path，其中

scope/name 是 CodeQL 包的限定名称。
range 是 semver 范围。
path 是文件系统路径。

如果指定了 scope/name，则 range 和 path 是可选的。缺少 range 表示指定包的最新版本。缺少 path 表示指定包的默认查询套件。

path 可以是 *.ql 查询文件、包含一个或多个查询的目录或 .qls 查询套件文件。如果没有指定包名称，则必须提供 path，并且它将被解释为当前进程的当前工作目录的相对路径。

要指定包含字面量 @ 或 : 的 path，请在参数前使用 path: 作为前缀，例如：path:directory/with:and@/chars。

如果指定了 scope/name 和 path，则 path 不能是绝对路径。它被认为是 CodeQL 包根目录的相对路径。

`-o, --output=<dir|file.bqrs>`

通常，这是一个现有目录，查询的 BQRS 输出将写入其中。此目录中的文件名将从 QL 文件名派生。

或者，如果只有一个查询要运行，它可能是要写入的实际 BQRS 文件的名称，或者可以省略以将结果的人类可读表示形式写入标准输出。

`--no-rerun`

省略对输出位置中似乎已存储 BQRS 结果的查询的评估。

控制要使用的模型包的选项

`--model-packs=<`name@range>...

要作为模型包使用的一系列 CodeQL 包名称，每个名称都带有一个可选的版本范围，以自定义即将评估的查询。

控制要使用的威胁模型的选项

`--threat-model=<name>...`

要启用或禁用的威胁模型列表。

该参数是威胁模型的名称，前面可以选择加一个“!”。如果前面没有“!”，则启用命名的威胁模型及其所有后代。如果前面有“!”，则禁用命名的威胁模型及其所有后代。

默认情况下启用“default”威胁模型，但可以通过指定“--threat-model !default”来禁用它。

“all”威胁模型可用于启用或禁用所有威胁模型。

按顺序处理 --threat-model 选项。例如，“--threat-model local --threat-model !environment”启用“local”组中的所有威胁模型，但“environment”威胁模型除外。

此选项仅对支持威胁模型的语言有效。

自 v2.15.3 起可用。

控制查询评估器的选项

`--[no-]tuple-counting`

[高级] 显示查询评估器日志中每个评估步骤的元组计数。如果提供 --evaluator-log 选项，则元组计数将包含在命令生成的基于文本和结构化 JSON 日志中。（这对于优化复杂的 QL 代码的性能很有用）。

`--timeout=<seconds>`

[高级] 以秒为单位设置查询评估的超时长度。

超时功能旨在捕获复杂查询将花费“永远”才能评估的情况。它不是限制查询评估可以花费的总时间的有效方法。只要计算的每个单独计时部分都在超时内完成，就可以允许评估继续进行。当前，这些单独计时的部分是优化查询的“RA 层”，但这在将来可能会改变。

如果未指定超时，或将其指定为 0，则不会设置超时（codeql test run 除外，其默认超时为 5 分钟）。

`-j, --threads=<num>`

使用这么多的线程来评估查询。

默认为 1。您可以传递 0 以对机器上的每个核心使用一个线程，或传递 -N 以保留 N 个核心未使用（但仍然至少使用一个线程）。

`--[no-]save-cache`

[高级] 积极地将中间结果写入磁盘缓存。这需要更多时间并使用（更多）磁盘空间，但可能会加快随后执行类似查询的速度。

`--[no-]expect-discarded-cache`

[高级] 基于查询执行后缓存将被丢弃的假设，决定评估哪些谓词以及将什么写入磁盘缓存。

`--[no-]keep-full-cache`

[高级] 评估完成后不清理磁盘缓存。如果您之后要进行codeql 数据集清理或codeql 数据库清理，这可以节省时间。

`--max-disk-cache=<MB>`

设置中间查询结果的磁盘缓存可以使用空间的最大量。

如果没有显式配置此大小，评估器将尝试使用基于数据集大小和查询复杂性的“合理”缓存空间量。显式设置高于此默认用量的限制将启用额外的缓存，这可以加快后续查询的速度。

`--min-disk-free=<MB>`

[高级] 设置文件系统上目标的可用空间量。

如果没有给出--max-disk-cache，如果文件系统的可用空间低于此值，评估器将努力限制磁盘缓存的使用。

`--min-disk-free-pct=<pct>`

[高级] 设置文件系统上目标的可用空间比例。

如果没有给出--max-disk-cache，如果文件系统的可用空间低于此百分比，评估器将努力限制磁盘缓存的使用。

`--external=<pred>=<file.csv>`

包含外部谓词<pred>行的 CSV 文件。可以提供多个--external选项。

`--xterm-progress=<mode>`

[高级] 控制是否使用 xterm 控制序列在 QL 评估期间显示进度跟踪。可能的值为

no：从不显示详细进度；假设终端不支持。

auto (默认)：自动检测命令是否在合适的终端中运行。

yes：假设终端可以理解 xterm 控制序列。此功能仍然依赖于能够自动检测终端的大小，如果给出-q，则也将被禁用。

25x80（或类似）：与yes类似，并且还显式给出终端的大小。

25x80:/dev/pts/17（或类似）：在与 stderr 不同的终端上显示详细进度。主要用于内部测试。

控制输出结构化评估器日志的选项

`--evaluator-log=<file>`

[高级] 将关于评估器性能的结构化日志输出到给定的文件。此日志文件的格式可能会随时更改，恕不另行通知，但将是 JSON 对象流，由两个换行符（默认）或一个换行符（如果传递--evaluator-log-minify选项）分隔。请使用codeql generate log-summary <file>生成此文件的更稳定的摘要，并避免直接解析文件。如果文件已存在，则将被覆盖。