此内容描述了 CodeQL CLI 的最新版本。 有关此版本的详细信息,请参阅 https://github.com/github/codeql-cli-binaries/releases 。
若要查看早期版本中此命令可用选项的详细信息,请在终端中使用 --help
选项运行命令。
摘要
codeql resolve upgrades --dbscheme=<file> <options>...
codeql resolve upgrades --dbscheme=<file> <options>...
说明
[Deep plumbing] 确定要针对原始数据集运行的升级。
确定需要对特定的原始 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
起可用。