执行查询服务器2

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

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

概要

Shell

codeql execute query-server2 [--threads=<num>] <options>...

codeql execute query-server2 [--threads=<num>] <options>...

描述

[内部实现] 支持从 IDE 运行查询。

此命令仅与 IDE 的 QL 语言扩展作者相关。它由 IDE 插件在后台启动，并通过其标准输入和输出流上的特殊协议与之通信。

自 v2.10.11 起可用。

选项

主要选项

`--[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 不同的终端上显示精细的进度。主要用于内部测试。

`--search-path=<dir>[:<dir>...]`

这与 codeql query compile 的类似选项相同（见上文）。

没有--additional-packs或--library-path选项，因为相应的参数值是根据每个查询提供的。

(注意：在Windows系统中，路径分隔符是;)。

谁可以使用此功能？

本文内容

概要

描述

选项

主要选项

`--[no-]tuple-counting`

`--timeout=<seconds>`

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

`--[no-]save-cache`

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

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

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

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

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

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

`--xterm-progress=<mode>`

`--search-path=<dir>[:<dir>...]`

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

`--evaluator-log=<file>`

`--evaluator-log-minify`

常用选项

`-h, --help`

`-J=<opt>`

`-v, --verbose`

`-q, --quiet`

`--verbosity=<level>`

`--logdir=<dir>`

`--common-caches=<dir>`