数据库完成

注意

此内容描述了 CodeQL CLI 的最新版本。有关此版本的详细信息，请参阅 http://github.com/github/codeql-cli-binaries/releases 。

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

概要

Shell

codeql database finalize [--dbscheme=<file>] [--threads=<num>] [--ram=<MB>] <options>... -- <database>

codeql database finalize [--dbscheme=<file>] [--threads=<num>] [--ram=<MB>] <options>... -- <database>

Description

          \[管道] 创建数据库的最终步骤。

最终确定此类数据库：先使用 codeql database init 创建，随后使用 codeql database trace-command 通过分析数据设定其种子。需要先完成前述操作，然后才能查询新数据库。

选项

主要选项

`<database>`

          \[必选] 正在构建的 CodeQL 数据库的路径。 必须准备好此选项，以便使用 [codeql database init](/code-security/codeql-cli/codeql-cli-manual/database-init) 进行提取。

如果提供了 --db-cluster 选项，此目录本身并非数据库，而是_包含_数据库的目录，所有这些数据库将一起处理。

`--[no-]db-cluster`

指示命令行中给定的目录本身并非数据库，而是_包含_一个或多个正在构建的数据库的目录。这些数据库将一起处理。

`--additional-dbs=<database>[:<database>...]`

          \[高级] 其他正在构建的 CodeQL 数据库的路径。

这些内容不会是最终确定的数据库本身，但是会将其中的数据包含在正在创建的最终确定的数据库中。这是一个高级选项，可能并非在所有情况下都达到所需效果。有关详细信息，请参阅关于 codeql database import 的文档。

如果提供了 --db-cluster 选项，则预计这些内容将是数据库群集，而不是单个 CodeQL 数据库。

（注意：在 Windows 上，路径分隔符为 ;）。

`--no-cleanup`

          \[高级] 完成后抑制所有数据库清理操作。 对调试很有用。

`--no-pre-finalize`

          \[高级] 跳过活动 CodeQL 提取程序指定的任何预完成脚本。

`--[no-]skip-empty`

          \[高级] 如果数据库为空（因为构建期间未检测到源代码），则输出警告而非失败。 空数据库将保持未完成状态。

用于控制 TRAP 导入操作的选项

`-S, --dbscheme=<file>`

          \[高级] 覆盖 TRAP 文件应遵循的自动检测到的 dbscheme 定义。 通常，这是从数据库的提取程序中获取的。

`-j, --threads=<num>`

使用如此多的线程进行导入操作。

默认值为 1。可以传递 0 以在机器上每个内核使用一个线程，或传递 -N 以保留 N 个内核不使用（但仍至少使用一个线程）。

`-M, --ram=<MB>`

使用如此多的内存进行导入操作。

低级别数据集清理选项

`--max-disk-cache=<MB>`

设置磁盘缓存可用于中间查询结果的最大空间量。

如果未显式配置此大小，计算器将根据数据集大小和查询复杂性尝试使用“合理的”缓存空间量。显式设置高于此默认使用量的限制将启用额外的缓存，从而加快以后的查询速度。

`--min-disk-free=<MB>`

          \[高级] 设置文件系统的目标可用空间量。

如果未提供 --max-disk-cache，当文件系统上的可用空间低于此值时，计算器便会努力减少磁盘缓存使用量。

`--min-disk-free-pct=<pct>`

          \[高级] 设置文件系统的目标可用空间比例。

如果未提供 --max-disk-cache，当文件系统上的可用空间低于此百分比时，计算器便会努力减少磁盘缓存使用量。

`--cache-cleanup=<mode>`

选择剪裁缓存的主动程度。选项包括：

          `clear`：删除整个缓存，缩减到刚提取数据集的状态

          `trim`              _（默认）_：修剪除明确“缓存”的谓词之外的所有内容。

          `fit`：只需确保遵守磁盘缓存的已定义大小限制，删除必要数量的中间文件。

          `overlay`：修剪到仅对覆盖层评估有用的数据。

`--cleanup-upgrade-backups`

删除因数据库升级而生成的任何备份目录。

用于检查导入的 TRAP 的选项

`--[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](/code-security/codeql-cli/codeql-cli-manual/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 起可用。

谁可以使用此功能？

本文内容

概要