数据库完成

概要

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

[Advanced] 正在构建的其他 CodeQL 数据库的路径。这些数据库本身不会被完成，但其数据会被包含在正在创建的已完成数据库中。这是一个高级选项，在所有情况下可能未产生预期效果。更多信息，请参阅 codeql database import 的文档。

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

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

--no-cleanup

[Advanced] 抑制在完成后进行的所有数据库清理。对调试很有用。

--no-pre-finalize

[Advanced] 跳过由活动的 CodeQL 提取器指定的任何预完成脚本。

--[no-]skip-empty

[Advanced] 如果数据库因构建期间未看到源代码而为空，则输出警告而不是失败。空数据库将保持未完成状态。

控制 TRAP 导入操作的选项

-S, --dbscheme=<file>

[Advanced] 覆盖对 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 是否具备链接感知（默认）或不具备。在数据库创建的此部分消耗过多内存的项目中，禁用此选项可能有助于继续进行，但会以数据库完整性为代价。

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