dataset import

概要

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 数据集导入是否为连锁感知模式 (默认)。在数据库创建过程中过多占用内存的项目中，禁用此选项可能帮助它们在牺牲数据库完整性的前提下继续进行。

自 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 起可用。