查询运行

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

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

概要

Shell

codeql query run (--database=<database> | --dataset=<dataset>) [--output=<file.bqrs>] [--threads=<num>] [--ram=<MB>] <options>... -- <file.ql>

codeql query run (--database=<database> | --dataset=<dataset>) [--output=<file.bqrs>] [--threads=<num>] [--ram=<MB>] <options>... -- <file.ql>

描述

运行单个查询。

此命令对 CodeQL 数据库或原始 QL 数据集运行单个查询。

默认情况下，查询结果将以用户友好的方式在终端上显示。如果您想进一步处理结果，我们强烈建议您使用 --output 选项将结果写入中间二进制格式的文件，然后可以使用 codeql bqrs decode 将其解包成各种更适合机器的表示形式。

如果您的查询以可以解释为源代码警报的形式生成结果，您可能会发现 codeql database analyze 是一种更方便的运行方式。特别是，codeql database analyze 可以生成 SARIF 格式的输出，该格式可以与各种警报查看器一起使用。

要并行运行多个查询，请参阅 codeql database run-queries。

选项

主要选项

`<file.ql>`

[必填] 要执行的查询的 QL 源代码。

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

一个文件，查询的输出将以 BQRS 格式写入。

选择查询内容的选项

必须提供以下选项中的一个。

`-d, --database=<database>`

要查询的 CodeQL 数据库的路径。

`--dataset=<dataset>`

[高级] 要查询的原始 QL 数据集的路径。

控制查询评估器的选项

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

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

no：从不产生高级进度；假设是一个哑终端。

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

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

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

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

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

`--evaluator-log=<file>`

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