数据库运行查询

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

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

摘要

Shell

codeql database run-queries [--threads=<num>] [--ram=<MB>] <options>... -- <database> <query|dir|suite|pack>...

codeql database run-queries [--threads=<num>] [--ram=<MB>] <options>... -- <database> <query|dir|suite|pack>...

说明

[Plumbing] 一起运行一组查询。

针对 CodeQL 数据库运行一个或多个查询，并将结果保存到数据库目录的结果子目录。

稍后可以通过 codeql database interpret-results 将结果转换为可读格式，或者通过 codeql bqrs decode 或 codeql bqrs interpret 进行查询转换。

如果查询以可解释为源代码警报的形式生成结果，你可能会发现 codeql database analyze 是运行它们的更方便的方法。 codeql database analyze 在一个步骤中将 codeql database run-queries 与 codeql database interpret-results 相结合。具体而言，codeql database analyze 可以生成 SARIF 格式的输出，该输出可与各种警报查看器一起使用。

或者，如果只有一个查询要运行，你可能更偏好 codeql query run，这可以显示人工可读的输出，以便在调试时快速检查结果。

选项

主要选项

`<database>`

[必需] 要查询的 CodeQL 数据库的路径。

`<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 包的根的相对路径。

如果未指定任何查询，CLI 将自动确定要运行的一组合适的查询。具体而言，如果在创建数据库时使用 --codescanning-config 指定了代码扫描配置文件，则将使用来自此路径的查询。否则，将使用所分析语言的默认查询。

`--no-rerun`

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

`--no-database-extension-packs`

[高级] 在数据库创建（无论通过代码扫描配置文件还是通过分析代码库“扩展”目录中存储的扩展文件）期间忽略数据库中存储的扩展包。

`--no-database-threat-models`

[高级] 在通过代码扫描配置文件创建数据库期间，忽略数据库中存储的威胁模型配置。

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

`--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 日志和结构化 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> 生成此文件的更稳定的摘要，并避免直接分析该文件。如果文件存在，将覆盖该文件。