此内容描述了 CodeQL CLI 的最新版本。有关此版本的更多信息,请参阅 https://github.com/github/codeql-cli-binaries/releases。
要在较早版本中查看此命令可用的选项详细信息,请在终端中使用 --help
选项运行该命令。
摘要
codeql dataset import --dbscheme=<file> [--threads=<num>] <options>... -- <dataset> <trap>...
codeql dataset import --dbscheme=<file> [--threads=<num>] <options>... -- <dataset> <trap>...
描述
【底层实现】将一组 TRAP 文件导入原始数据集。
通过使用 TRAP 文件填充来创建数据集,或将 TRAP 文件中的数据添加到现有数据集。只有在数据集具有正确的 dbscheme *并且*其 ID 池已从初始导入中保留的情况下,才能更新数据集。
选项
主要选项
<dataset>
【必填】要创建或更新的原始 QL 数据集的路径。如果目录尚不存在,则将创建该目录。
<trap>...
要导入的 .trap(.gz) 文件的路径,或将递归扫描以查找 .trap(.gz) 文件的目录。如果没有给出文件,则将创建一个空数据集。
-S, --dbscheme=<file>
【必填】描述要导入的 TRAP 文件的 dbscheme 定义。
-j, --threads=<num>
为导入操作使用这么多线程。
默认为 1。您可以传递 0 以对机器上的每个核心使用一个线程,或 -N 以保留 N 个核心未使用(但仍然至少使用一个线程)。
--[no-]check-undefined-labels
【高级】报告未定义标签的错误。
--[no-]check-unused-labels
【高级】报告未使用标签的错误。
--[no-]check-repeated-labels
【高级】报告重复标签的错误。
--[no-]check-redefined-labels
【高级】报告已重新定义标签的错误。
--[no-]check-use-before-definition
【高级】报告在定义之前使用的标签的错误。
--[no-]fail-on-trap-errors
【高级】如果在 trap 导入期间发生错误,则退出非零值。
--[no-]include-location-in-star
【高级】构造编码其来源的 TRAP 文件位置的实体 ID。对于 TRAP 生成器的调试可能很有用,但在数据集中占用了大量空间。
--[no-]linkage-aware-import
【高级】控制 codeql dataset import 是否是链接感知的(默认)或不是。在数据库创建的这一部分消耗过多内存的项目上,禁用此选项可以帮助它们取得进展,但代价是数据库的完整性。
自 v2.15.3
起可用。
常用选项
-h, --help
显示此帮助文本。
-J=<opt>
【高级】向运行命令的 JVM 提供选项。
(请注意,包含空格的选项将无法正确处理。)
-v, --verbose
逐步增加打印的进度消息数量。
-q, --quiet
逐步减少打印的进度消息数量。
--verbosity=<level>
【高级】将详细程度显式设置为 errors、warnings、progress、progress+、progress++、progress+++ 之一。覆盖 -v
和 -q
。
--logdir=<dir>
[高级] 将详细日志写入给定目录中的一个或多个文件中,生成的名称包含时间戳和正在运行的子命令的名称。
(要写入名称完全受您控制的日志文件,请改用--log-to-stderr
并根据需要重定向 stderr。)
--common-caches=<dir>
[高级] 控制磁盘上缓存数据的存储位置,这些数据将在 CLI 的多次运行之间持久存在,例如下载的 QL 包和编译后的查询计划。如果未显式设置,则默认为用户主目录中名为.codeql
的目录;如果该目录不存在,则会创建它。
自 v2.15.2
版本起可用。