执行查询

注意

此内容描述了 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 数据集的路径。

`<query|dir|suite|pack>...`

[必需] 要执行的查询。每个参数的形式为 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 包根目录的相对路径。

`-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`

[Advanced] 在查询评估器日志中显示每个评估步骤的元组计数。如果提供了 --evaluator-log 选项，元组计数将同时包含在文本日志和结构化的 JSON 日志中。（这对于优化复杂 QL 代码的性能很有帮助）。

`--timeout=<seconds>`

[Advanced] 设置查询评估的超时时间（单位为秒）。

超时功能旨在捕获复杂查询可能“永远”无法完成的情况。它并不是限制查询评估总耗时的有效手段。只要每个单独计时的计算部分在超时限制内完成，评估就会继续进行。目前这些单独计时的部分是已优化查询的“RA 层”，未来可能会有所变化。

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

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

使用此数量的线程来评估查询。

默认值为 1。可以传入 0 以在机器上每个核心使用一个线程，或者使用 -N 来保留 N 个核心不使用（但仍会使用至少一个线程）。

`--[no-]save-cache`

[Deprecated] [Advanced] 此标志不执行任何操作。

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

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

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

[Advanced] 评估完成后不清理磁盘缓存。如果之后仍要进行 codeql dataset cleanup 或 codeql database cleanup，这可能会节省时间。

`--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>`

[Advanced] 控制在 QL 评估期间是否使用 xterm 控制序列显示进度跟踪。可能的取值如下：

no: 永不显示花哨的进度；假设终端不支持。

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

yes: 假设终端能够理解 xterm 控制序列。此功能仍依赖于能够自动检测终端的尺寸（Windows 暂未实现），并且在提供 -q 时会被禁用。

25x80（或类似形式）：类似 yes，并显式指定终端的尺寸。（与 yes 不同，此方式在 Windows 上可用）。

25x80:/dev/pts/17（或类似形式）：在 不同于 标准错误的终端上显示花哨的进度。主要用于内部测试。

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

`--evaluator-log=<file>`

[Advanced] 将关于评估器性能的结构化日志输出到指定文件。此日志文件的格式可能在未另行通知的情况下更改，但始终是 JSON 对象流，默认使用两个换行符分隔（若传入 --evaluator-log-minify 选项则使用单个换行符）。请使用 codeql generate log-summary <file> 生成更稳定的摘要，避免直接解析该文件。若文件已存在将被覆盖。