database finalize

摘要

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

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

说明

[Plumbing] 创建数据库的最终步骤。

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

选项

主要选项

<database>

[必需] 正在构建的 CodeQL 数据库的路径。 必须准备好此选项，以便使用 codeql 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：只需确保遵守为磁盘缓存定义的大小限制，并根据需要删除尽可能多的中间文件。

--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

[高级] 构造实体 ID，这些 ID 对它们在 TRAP 文件中的源位置进行编码。 可能对调试 TRAP 生成器非常有用，但会在数据集中占用大量空间。

--[no-]linkage-aware-import

[高级] 控制 codeql 数据集导入是否具有链接感知（默认值）__。 对于在数据库创建这一部分占用过多内存的项目，禁用此选项可能有助于其运行，但会牺牲数据库的完整性。

自 v2.15.3 起可用。

常用选项

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