# 数据集导入

[管道] 将一组 TRAP 文件导入原始数据集。

> [!NOTE]
> 此内容描述了 CodeQL CLI 的最新版本。 有关此版本的详细信息，请参阅 https://github.com/github/codeql-cli-binaries/releases 。
>
> 若要查看早期版本中此命令可用选项的详细信息，请在终端中使用 <span style="white-space: nowrap;">`--help`</span> 选项运行命令。

## 概要

```shell copy
codeql dataset import --dbscheme=<file> [--threads=<num>] <options>... -- <dataset> <trap>...
```

## Description

              \[管道] 将一组 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` 起可用。