dataset upgrade

Note

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

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

摘要

Shell

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

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

说明

[Plumbing] 升级数据集，使其可供当前工具使用。

这与 codeql 数据库升级相同，但适用于原始数据集，而不是整个数据库。

选项

主要选项

`<dataset>`

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

`--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 日志和结构化 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 的终端上显示绚丽的进度。主要对内部测试有用。

dataset upgrade

谁可以使用此功能？

本文内容

摘要

说明

选项

主要选项

`<dataset>`

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