数据库升级

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

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

概要

Shell

codeql database upgrade [--threads=<num>] [--ram=<MB>] <options>... -- <database>

codeql database upgrade [--threads=<num>] [--ram=<MB>] <options>... -- <database>

描述

升级数据库以便当前工具可以使用。

如有必要，此命令会重写 CodeQL 数据库，使其与 QL 包搜索路径中找到的 QL 库兼容。

如果需要升级，则该升级是不可逆的。随后，将无法使用创建数据库时当前使用的库。

选项

主要选项

`<database>`

[必填] 要升级的 CodeQL 数据库的路径。

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

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

如果路径包含目录树，则它们的顺序定义了它们之间的优先级：如果必须解析的包名在多个目录树中匹配，则首先给出的目录树获胜。

指向开源 CodeQL 仓库的检出应该在查询其中一种语言时有效。

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

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

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

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

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

`--target-dbscheme=<file>`

我们要升级到的_目标_ dbscheme。如果未给出此选项，则将构建最大升级路径。

`--target-sha=<sha>`

[高级] --target-dbscheme 的替代方案，提供目标 dbscheme 的内部哈希值而不是 dbscheme 文件。

`--[no-]allow-downgrades`

如果没有升级，则包含任何相关的降级。

控制升级查询评估的选项

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

谁可以使用此功能？

本文档中

概要

描述

选项

主要选项

`<database>`

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

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

`--target-dbscheme=<file>`

`--target-sha=<sha>`

`--[no-]allow-downgrades`

控制升级查询评估的选项

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

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

`--evaluator-log=<file>`

`--evaluator-log-minify`

控制升级过程 RAM 使用量的选项

`-M, --ram=<MB>`

常用选项

`-h, --help`

`-J=<opt>`

`-v, --verbose`

`-q, --quiet`

`--verbosity=<level>`

`--logdir=<dir>`

`--common-caches=<dir>`