跳至主要内容

数据库捆绑

创建可迁移的 CodeQL 数据库归档。

谁可以使用此功能?

CodeQL 可用于以下仓库类型

本文内容

注意

此内容描述了 CodeQL CLI 的最新发布版本。有关此版本的更多信息,请参阅 https://github.com/github/codeql-cli-binaries/releases

要查看早期版本中此命令可用的选项详情,请在终端中使用 --help 选项运行该命令。

概要

Shell
codeql database bundle --output=<output> <options>... -- <database>

描述

创建可迁移的 CodeQL 数据库归档。

一个将数据库中有用部分压缩为 zip 的命令。默认仅包含必需的组件,除非用户特别要求包含结果、日志、TRAP 或类似内容。

选项

主要选项

<database>

[必需] 要捆绑的 CodeQL 数据库路径。

-o, --output=<output>

[必需] 输出文件,通常使用 ".zip" 扩展名。

--[no-]include-diagnostics

在捆绑包中包含诊断信息。

v2.16.0 起可用。

--[no-]include-results

在捆绑包中包含任何预先计算的查询结果。

--[no-]include-logs

在捆绑包中包含 logs 目录。

v2.17.6 起可用。

--[no-]include-temp

包括 "temp" 目录,其中存放生成的包、查询和套件。

v2.13.3 起可用。

--[no-]include-uncompressed-source

包含源归档目录的未压缩版本。这对于旧版 CodeQL 插件(如 CodeQL for Eclipse)是必需的。

--include=<include>

[高级] 相对于数据库目录的其他路径,需包含在捆绑包中。

v2.24.0 起可用。

--name=<name>

捆绑包中顶层目录的名称。如果未指定,则默认为数据库目录的名称。

低层次数据集清理选项

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

删除因数据库升级产生的所有备份目录。

常用选项

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

© . This site is unofficial and not affiliated with GitHub, Inc.