Skip to main content

此版本的 GitHub Enterprise Server 已于以下日期停止服务 2023-09-12. 即使针对重大安全问题,也不会发布补丁。 为了获得更好的性能、更高的安全性和新功能,请升级到最新版本的 GitHub Enterprise。 如需升级帮助,请联系 GitHub Enterprise 支持

数据库捆绑包

创建 CodeQL 数据库的可重定位存档。

GitHub CodeQL 在安装后按用户授权。 根据许可证限制,只能将 CodeQL 用于某些任务。 有关详细信息,请参阅“关于 CodeQL CLI”。

如果你有 GitHub Advanced Security 许可证,则可以使用 CodeQL 进行自动分析、持续集成和持续交付。 有关详细信息,请参阅“关于 GitHub 高级安全性”。

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

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

摘要

Shell
codeql database bundle --output=<output> [--mode=<mode>] <options>... -- <database>

说明

创建 CodeQL 数据库的可重定位存档。

压缩数据库有用部分的命令。 这将仅包含必需组件,除非用户明确要求应包含结果、日志、TRAP 或类似内容。

主要选项

<database>

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

-o, --output=<output>

[强制] 输出文件,通常扩展名为“.zip”。

--include-results

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

--include-temp

包括“temp”目录,任何生成的包、查询和套件都位于其中。

v2.13.3 起可用。

--include-uncompressed-source

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

--name=<name>

捆绑包中顶级目录的名称。 如果未给出,则默认为数据库目录的名称。

低级别数据集清理选项

--max-disk-cache=<MB>

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

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

--min-disk-free=<MB>

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

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

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

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

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

-m, --mode=<mode>

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

brutal:删除整个缓存,裁剪为新提取的数据集的状态

normal(默认):裁剪除显式“缓存”谓词之外的所有内容。

light:只需确保遵守为磁盘缓存定义的大小限制,并根据需要删除尽可能多的中间文件。

--cleanup-upgrade-backups

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

常用选项

-h, --help

显示此帮助文本。

-J=<opt>

[高级] 为运行命令的 JVM 提供选项。

(请注意,无法正确处理包含空格的选项。)

-v, --verbose

以增量方式增加输出的进度消息数。

-q, --quiet

以增量方式减少输出的进度消息数。

--verbosity=<level>

[高级] 将详细级别显式设置为“错误”、“警告”、“进度”、“进度+”、“进度++”、“进度+++”之一。 重写 -v-q

--logdir=<dir>

[高级] 将详细日志写入给定目录中的一个或多个文件,其中生成的名称包括时间戳和正在运行的子命令的名称。

(若要使用可以完全控制的名称编写日志文件,请根据需要提供 --log-to-stderr 并重定向 stderr。)