跳至主要内容

解决升级问题

[深度挖掘] 确定要对原始数据集运行的升级。

谁可以使用此功能?

CodeQL 可用于以下类型的仓库

本文内容

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

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

概要

Shell
codeql resolve upgrades --dbscheme=<file> <options>...

描述

[深度挖掘] 确定要对原始数据集运行的升级。

确定需要对特定原始 QL 数据集执行哪些升级才能使其达到已配置 QL 库的状态。此计算是普通数据库升级过程中发生的部分内容,并作为单独的管道命令公开,以便 (a) 帮助进行故障排除,以及 (b) 为在需要精确控制的非常规情况下修改路径提供起点。

选项

主要选项

--dbscheme=<file>

[必填] 我们要升级的数据集的当前 dbscheme。

--format=<fmt>

选择输出格式。选项包括

lines (默认):每行打印一个升级脚本。

json:打印升级脚本路径的 JSON 数组。

--just-check

不打印任何输出,但如果需要升级则退出代码为 0,如果不需要升级则退出代码为 1。

来自调用命令的命令行的选项

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

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

常用选项

-h, --help

显示此帮助文本。

-J=<opt>

[高级] 向运行命令的 JVM 提供选项。

(注意,包含空格的选项将无法正确处理。)

-v, --verbose

逐步增加打印的进度消息数量。

-q, --quiet

逐步减少打印的进度消息数量。

--verbosity=<level>

[高级] 将详细程度显式设置为错误、警告、进度、进度+、进度++、进度+++ 之一。覆盖-v-q

--logdir=<dir>

[高级] 将详细日志写入给定目录中的一个或多个文件中,生成的名称包括时间戳和正在运行的子命令的名称。

(要写入名称完全受您控制的日志文件,请改用 --log-to-stderr 并根据需要重定向 stderr。)

--common-caches=<dir>

[高级] 控制磁盘上缓存数据的存储位置,这些数据会在 CLI 的多次运行之间持续存在,例如下载的 QL 包和已编译的查询计划。如果未显式设置,则默认为用户主目录中名为 .codeql 的目录;如果该目录不存在,则会创建它。

v2.15.2 版本起可用。