解析 RAM

注意

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

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

概要

Shell

codeql resolve ram [--ram=<MB>] <options>...

codeql resolve ram [--ram=<MB>] <options>...

描述

[深层管道] 准备 RAM 选项。

此深层管道命令会准备合适的命令行选项，以启动执行 QL 查询评估器的子命令。它具备相应的启发式方法，能够判断是否将部分已配置的内存保留在 Java 堆之外。

特别是，在基于期望的总计 RAM 量启动查询服务器之前，应使用此命令找出合适的 -J-Xmx 和 --off-heap-ram 选项。

选项

主要选项

`--format=<fmt>`

选择输出格式。可选项包括

lines (默认)：每行打印一个命令行参数。

json：将其以 JSON 数组形式打印。

来自调用命令行的选项

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

查询评估器会努力将其总体内存占用控制在此值以下。（然而，对于大型数据库，文件映射内存可能会突破此阈值，在内存压力大的情况下这些映射可能会被换出到磁盘。）

该值应至少为 2048 MB；小于此值的会被透明地向上取整。

`--dataset=<directory>`

[高级] 为查询给定数据集适当地调优 RAM 设置，考虑随数据库规模而增长的 RAM 使用组件。如果未提供此参数，将假设使用通用默认大小。

常用选项

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

谁可以使用此功能？

本文内容

概要

描述

选项