# 数据集升级 \[管道] 升级数据集，使其可供当前工具使用。 > \[!NOTE] > 此内容描述了 CodeQL CLI 的最新版本。 有关此版本的详细信息，请参阅 。 > > 若要查看早期版本中此命令可用选项的详细信息，请在终端中使用 `--help` 选项运行命令。 ## 概要 ```shell copy codeql dataset upgrade [--threads=] [--ram=] ... -- ``` ## Description ``` \[管道] 升级数据集，使其可供当前工具使用。 ``` 这与 [codeql 数据库升级](/zh/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-upgrade)相同，但适用于原始数据集，而不是整个数据库。 ## 选项 ### 主要选项 #### `` ``` \[必选] 要升级的原始 QL 数据集的路径。 ``` #### `--search-path=[:...]` 可在其中找到包含升级方案的 QL 包的目录列表。 每个目录可以是一个 QL 包（或在根目录下包含一个 `.codeqlmanifest.json` 文件的多个包），也可以是一个或多个此类目录的直接父目录。 如果路径包含目录树，则目录树的顺序定义了它们之间的优先级：如果必须解析的包名称在多个目录树中匹配，则给定的第一个目录树优先。 在查询其中一种语言时，将其指向开源 CodeQL 存储库的签出应该是可行的。 （注意：在 Windows 上，路径分隔符为 `;`）。 #### `--additional-packs=[:...]` ``` \[高级] 如果给定此目录列表，会先在这些目录中搜索升级方案，再在 `--search-path` 中的目录搜索。 它们之间的顺序并不重要；如果在此列表的两个不同位置发现同一个包名称，这是一个错误。 ``` 如果你正临时开发一个同时出现在默认路径中的新版本的包，这将非常有用。 另一方面，\_不建议\_在配置文件中覆盖此选项；某些内部操作会动态添加此选项，覆盖任何已配置的值。 （注意：在 Windows 上，路径分隔符为 `;`）。 #### `--target-dbscheme=` 要升级到的\_目标\_ dbscheme。 如果未提供此内容，则将构造最大升级路径 #### `--target-sha=` ``` \[高级] `--target-dbscheme` 替代选项，提供目标 dbscheme 的内部哈希值而非 dbscheme 文件。 ``` #### `--[no-]allow-downgrades` 在不进行升级的情况下包括任何相关的降级 ### 用于控制升级查询评估的选项 #### `--[no-]tuple-counting` ``` \[高级] 在查询计算器日志中显示每个评估步骤的元组计数。 如果提供了 `--evaluator-log` 选项，则元组计数将包含在命令生成的基于文本的 JSON 日志和结构化 JSON 日志中。 （这对复杂 QL 代码的性能优化非常有用）。 ``` #### `--timeout=` ``` \[高级] 设置查询评估的超时时间（以秒为单位）。 ``` 超时功能旨在捕获复杂查询需要“长久时间”来评估的情况。 这不是限制查询评估可花费的总时间的有效方法。 只要计算的每个单独计时部分在超时时间内完成，就允许评估继续进行。 目前，这些单独计时部分是已优化查询的“RA 层”，但将来可能会变化。 如果未指定超时或将其指定为 0，则不会设置超时（[codeql test run](/zh/code-security/reference/code-scanning/codeql/codeql-cli-manual/test-run) 除外，默认超时为 5 分钟）。 #### `-j, --threads=` 使用如此多的线程来评估查询。 默认值为 1。 可以传递 0 以在机器上每个内核使用一个线程，或传递 -*N* 以保留 *N* 个内核不使用（但仍至少使用一个线程）。 #### `--[no-]save-cache` ``` \[已弃用] \[高级] 此标志没有任何作用。 ``` #### `--[no-]expect-discarded-cache` ``` \[高级] 基于查询执行后将丢弃缓存的假设，决定要评估哪些谓词以及要写入磁盘缓存的内容。 ``` #### `--[no-]keep-full-cache` ``` \[高级] 评估完成后不清理磁盘缓存。 ``` 如果以后要执行 [codeql dataset cleanup](/zh/code-security/reference/code-scanning/codeql/codeql-cli-manual/dataset-cleanup) 或 [codeql database cleanup](/zh/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-cleanup)，这样可能会节省时间。 #### `--max-disk-cache=` 设置磁盘缓存可用于中间查询结果的最大空间量。 如果未显式配置此大小，计算器将根据数据集大小和查询复杂性尝试使用“合理的”缓存空间量。 显式设置高于此默认使用量的限制将启用额外的缓存，从而加快以后的查询速度。 #### `--min-disk-free=` ``` \[高级] 设置文件系统的目标可用空间量。 ``` 如果未提供 `--max-disk-cache`，当文件系统上的可用空间低于此值时，计算器便会努力减少磁盘缓存使用量。 #### `--min-disk-free-pct=` ``` \[高级] 设置文件系统的目标可用空间比例。 ``` 如果未提供 `--max-disk-cache`，当文件系统上的可用空间低于此百分比时，计算器便会努力减少磁盘缓存使用量。 #### `--external==` 包含外部谓词 *\* 的行的 CSV 文件。 可以提供多个 `--external` 选项。 #### `--xterm-progress=` ``` \[高级] 控制在 QL 评估期间是否使用 xterm 控制序列显示进度跟踪。 可能的值为： `no`：从不显示高级进度；假设为无交互终端。 `auto` _（默认）_：自动检测命令是否在合适的终端中运行。 `yes`：假设终端能够理解 xterm 控制序列。 该功能仍取决于能否自动检测终端的大小（抱歉，Windows 系统暂未实现此功能），如果指定了 __，该功能也将被禁用`-q`。 `25x80`（或类似）：与 `yes` 类似，并且明确指定终端大小。 （与 `yes` 不同，此功能应可在 Windows 操作系统上正常运行。） `25x80:/dev/pts/17`（或类似）：在_不同于_标准错误输出的终端上显示高级进度。 主要对内部测试有用。 ``` ### 用于控制结构化计算器日志输出的选项 #### `--evaluator-log=` ``` \[高级] 将有关计算器性能的结构化日志输出到指定文件。 此日志文件的格式可能会更改，恕不通知，但是它将是一连串用两个换行符（默认）或一个换行符（通过传递了 `--evaluator-log-minify` 选项）分隔的 JSON 对象。 请使用 `codeql generate log-summary ` 生成此文件的更稳定的摘要，并避免直接分析该文件。 如果文件存在，将覆盖该文件。 ``` #### `--evaluator-log-minify` ``` \[高级] 如果传递了 `--evaluator-log` 选项，同时传递此选项将最小化生成的 JSON 日志大小，但会大幅降低其人类可读性。 ``` ### 用于控制升级过程的 RAM 使用情况的选项 #### `-M, --ram=` 查询计算器将努力将其总内存占用情况保持在此值以下。 （不过，对于大型数据库，基于文件的内存映射可能会突破此阈值，在内存紧张时可交换到磁盘）。 该值应至少为 2048 MB；较小的值将以透明方式向上舍入。 ### 常用选项 #### `-h, --help` 显示此帮助文本。 #### `-J=` ``` \[高级] 向运行命令的 JVM 提供选项。 ``` （请注意，无法正确处理包含空格的选项。） #### `-v, --verbose` 以增量方式增加输出的进度消息数。 #### `-q, --quiet` 以增量方式减少输出的进度消息数。 #### `--verbosity=` ``` \[高级] 明确将详细级别设置为 errors、warnings、progress、progress+、progress++、progress+++ 之一。 重写 `-v` 和 `-q`。 ``` #### `--logdir=` ``` \[高级] 将详细日志写入指定目录中的一个或多个文件，生成的文件名包含时间戳和正在运行的子命令名称。 ``` （要使用可以完全控制的名称编写日志文件，请根据需要提供 `--log-to-stderr` 并重定向 stderr。） #### `--common-caches=` ``` \[高级] 控制磁盘上缓存数据的位置，这些数据将在 CLI 的多次运行之间保留，例如下载的 QL 包和编译的查询计划。 如果未明确设置，则默认为用户主目录中名为 `.codeql` 的目录；如果尚不存在，则会创建该目录。 ``` 自 `v2.15.2` 起可用。