执行升级

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

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

摘要

Shell

codeql execute upgrades [--threads=<num>] <options>... -- <dataset> <script>...

codeql execute upgrades [--threads=<num>] <options>... -- <dataset> <script>...

描述

[底层实现] 在现有的原始 QL 数据集上运行升级脚本。

此命令针对数据集运行特定顺序的升级脚本。调用者有责任确保每个升级脚本的“旧”dbscheme与上一个脚本的“新”dbscheme匹配（或者，对于第一个脚本，与数据集的当前dbscheme匹配）。如果不匹配，将报告错误。

选项

主要选项

`<dataset>`

[必填] 要升级的原始 QL 数据集的路径。

`<script>...`

[必填] 要执行的升级脚本的路径。（每个升级脚本都是包含多个文件的目录，这些文件定义升级操作）。必须按应用顺序给出它们。

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

可以在其中找到 QL 包的目录列表。每个目录可以是 QL 包（或包含根目录中.codeqlmanifest.json文件的包捆绑包），也可以是多个此类目录的直接父目录。

如果路径包含多个目录，则它们的顺序定义它们之间的优先级：当必须解析的包名称在一个以上的目录树中匹配时，先给出的目录优先。

当查询其中一种语言时，指向开源 CodeQL 存储库的检出应该可以工作。

如果您已将 CodeQL 存储库检出为解压的 CodeQL 工具链的同级目录，则无需提供此选项；始终将搜索此类同级目录以查找无法以其他方式找到的 QL 包。（如果此默认设置不起作用，强烈建议您一劳永逸地在每个用户的配置文件中设置--search-path）。

（注意：在 Windows 上，路径分隔符为;）。

`--additional-packs=<dir>[:<dir>...]`

如果给出此目录列表，则将在--search-path中的目录之前搜索这些目录中的包。这些目录之间的顺序无关紧要；如果通过此列表在两个不同位置找到包名称，则这是一个错误。

如果您正在临时开发也出现在默认路径中的新版本包，这将非常有用。另一方面， _不建议_在配置文件中覆盖此选项；某些内部操作会动态添加此选项，从而覆盖任何已配置的值。

（注意：在 Windows 上，路径分隔符为;）。

控制升级查询评估的选项

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

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

`--evaluator-log-minify`

[高级] 如果传递了--evaluator-log选项，则传递此选项也将减小生成的 JSON 日志的大小，但代价是使其更难以阅读。

配置 CodeQL 包管理器的选项

`--registries-auth-stdin`

通过传递逗号分隔的 <registry_url>=<token> 对列表来验证 GitHub Enterprise Server 容器注册表。

例如，您可以传递https://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2来验证两个 GitHub Enterprise Server 实例。

这将覆盖 CODEQL_REGISTRIES_AUTH 和 GITHUB_TOKEN 环境变量。如果您只需要验证 github.com 容器注册表，则可以使用更简单的--github-auth-stdin选项进行身份验证。

`--github-auth-stdin`

通过标准输入传递 github.com GitHub Apps 令牌或个人访问令牌来验证 github.com 容器注册表。

要验证 GitHub Enterprise Server 容器注册表，请传递--registries-auth-stdin或使用 CODEQL_REGISTRIES_AUTH 环境变量。

这将覆盖 GITHUB_TOKEN 环境变量。

谁可以使用此功能？

本文内容

摘要

描述

选项