# query compile

编译或检查 QL 代码。

> \[!NOTE]
> 此内容描述了 CodeQL CLI 的最新版本。 有关此版本的详细信息，请参阅 <https://github.com/github/codeql-cli-binaries/releases> 。
>
> 若要查看早期版本中此命令可用选项的详细信息，请在终端中使用 <span style="white-space: nowrap;">`--help`</span> 选项运行命令。

## 概要

```shell copy
codeql query compile [--check-only] [--keep-going] [--threads=<num>] [--ram=<MB>] <options>... -- <file>...
```

## Description

编译或检查 QL 代码。

编译一个或多个查询。 通常此命令的主要结果是将查询的编译版本写入\_编译缓存\_，以便稍后执行查询时可以找到。 其他输出选项主要用于调试。

## 选项

### 主要选项

#### `<file>...`

```
          \[必填] 要编译的查询。 每个参数是下列项之一：
```

* 要编译的 .ql 文件。
* 将在其中以递归方式搜索 .ql 文件的目录。
* 定义一组特定查询的 .qls 文件。
* 由已安装的 QL 包之一导出的“已知”.qls 文件的基名称。

#### `-n, --check-only`

只检查 QL 是否有效并输出任何错误；实际上并不优化和存储查询计划。 这比完整编译要快得多。

#### `--[no-]precompile`

```
          \[高级] 将每个编译后的查询保存为与 `.qlx` 源文件相邻的二进制 `.ql` 文件。
```

这仅应在准备分发查询包时使用（在这种情况下，[codeql pack publish](/zh/code-security/reference/code-scanning/codeql/codeql-cli-manual/pack-publish) 会自动使用它）。
`.qlx` 文件存在后，执行查询的后续命令可能会忽略对 QL 源的更改，以支持预编译版本。

一些很少使用的编译选项与之不兼容，会导致运行时错误。

自 `v2.12.0` 起可用。

#### `--[no-]dump-dil`

```
          \[高级] 编译时将优化后的 DIL 中间表示打印到标准输出。
```

选择 JSON 输出后，DIL 将表示为单行字符串数组，并进行一些包装来标识正在编译的查询。

#### `-k, --[no-]keep-going`

即使发现错误，也继续编译。

#### `--[no-]dump-ra`

```
          \[高级] 编译时将优化后的 RA 查询计划打印到标准输出。
```

选择 JSON 输出后，RA 将表示为单行字符串数组，并进行一些包装来标识正在编译的查询。

#### `--format=<fmt>`

选择输出格式，可选`text`*（默认）* 或 `json`。

#### `-j, --threads=<num>`

使用如此多的线程来编译查询。

默认值为 1。 可以传递 0 以在机器上每个内核使用一个线程，或传递 -*N* 以保留 *N* 个内核不使用（但仍至少使用一个线程）。

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

设置应允许编译程序使用的 RAM 总量。

### QL 变体和编译器控制选项

#### `--warnings=<mode>`

如何处理来自 QL 编译器的警告。 下列其中一项：

```
          `hide`：抑制警告。

          `show`
          _（默认）_：打印警告但继续编译。

          `error`：将警告视为错误。
```

#### `--no-debug-info`

在 RA 中没有发出源位置信息以供调试。

#### `--[no-]fast-compilation`

```
          \[已弃用] \[高级] 省略特别缓慢的优化步骤。
```

#### `--no-release-compatibility`

```
          \[高级] 使用最新的编译器功能，但会牺牲可移植性。
```

QL 评估器的部分版本将时不时支持新的 QL 语言功能和计算器优化并会在 QL 编译器中默认启用它们。 这有助于确保你在最新的 CodeQL 版本中开发查询时体验到的性能可以与代码扫描或 CI 集成中可能仍在使用的稍旧版本相匹配。

如果你不关心查询是否与其他 CodeQL 版本（更低版本或更高版本）兼容，有时可以通过使用此标志提前在编译器中启用最新改进来实现少量的额外性能。

如果版本中最近没有要启用的改进，此选项以无提示方式不执行任何操作。 因此，可以安全地在全局 CodeQL 配置文件中一劳永逸地设置它。

自 `v2.11.1` 起可用。

#### `--[no-]local-checking`

仅对所使用的部分 QL 源执行初始检查。

#### `--no-metadata-verification`

为保证有效性，请勿在 QLDoc 注释中检查嵌入的查询元数据。

#### `--compilation-cache-size=<MB>`

```
          \[高级] 覆盖编译缓存目录的默认最大大小。
```

#### `--fail-on-ambiguous-relation-name`

```
          \[高级] 如果编译期间生成模糊的关系名称，则编译失败。
```

### 用于设置编译环境的选项

#### `--search-path=<dir>[:<dir>...]`

可在其中找到 QL 包的目录列表。 每个目录可以是一个 QL 包（或在根目录下包含一个 `.codeqlmanifest.json` 文件的多个包），也可以是一个或多个此类目录的直接父目录。

如果路径包含多个目录，则它们的顺序定义了它们之间的优先级：当必须解析的包名称在多个目录树中匹配时，给定的第一个目录树优先。

在查询其中一种语言时，将其指向开源 CodeQL 存储库的签出应该是可行的。

如果已将 CodeQL 存储库签出为未打包的 CodeQL 工具链的同级，则无需提供此选项；将始终在此类同级目录中搜索以其他方式找不到的 QL 包。 （如果此默认值不起作用，强烈建议在每用户配置文件中一次性设置 `--search-path`）。

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

#### `--additional-packs=<dir>[:<dir>...]`

如果给定了此目录列表，则先在这些目录中的搜索包，然后在 `--search-path` 中的目录搜索包。 它们之间的顺序并不重要；如果在此列表的两个不同位置发现同一个包名称，这是一个错误。

如果你正临时开发一个同时出现在默认路径中的新版本的包，这将非常有用。 另一方面，\_不建议\_在配置文件中覆盖此选项；某些内部操作会动态添加此选项，覆盖任何已配置的值。

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

#### `--library-path=<dir>[:<dir>...]`

```
          \[高级] 可选目录列表，这些目录将添加到 QL 库的原始导入搜索路径。 只有在使用未打包为 QL 包的 QL 库时，才应使用此选项。
```

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

#### `--dbscheme=<file>`

```
          \[高级] 明确定义查询应针对哪个 dbscheme 进行编译。 这只能由非常确定自己在做什么的调用方提供。
```

#### `--compilation-cache=<dir>`

```
          \[高级] 指定额外目录用作编译缓存。
```

#### `--no-default-compilation-cache`

```
          \[高级] 不使用标准位置的编译缓存，例如包含查询的 QL 包或 CodeQL 工具链目录中的缓存。
```

### 用于配置 CodeQL 包管理器的选项

#### `--registries-auth-stdin`

通过传递逗号分隔的 \<registry\_url>=\<token> 对列表，向 GitHub Enterprise Server 容器注册表进行身份验证。

例如，可以传递 `https://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2`
向两个 GitHub Enterprise Server 实例进行身份验证。

这会替代 CODEQL\_REGISTRIES\_AUTH and GITHUB\_TOKEN 环境变量。 如果只需向 github.com 容器注册表进行身份验证，则可以改用更简单的 `--github-auth-stdin` 选项进行身份验证。

#### `--github-auth-stdin`

通过标准输入传递 github.com GitHub 应用令牌或个人访问令牌，对 github.com 容器注册表进行身份验证。

要向 GitHub Enterprise Server 容器注册表进行身份验证，请传递 `--registries-auth-stdin` 或使用 CODEQL\_REGISTRIES\_AUTH 环境变量。

这会替代 GITHUB\_TOKEN 环境变量。

### 常用选项

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