query compile

Note

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

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

摘要

Shell

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

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

说明

编译或检查 QL 代码。

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

选项

主要选项

`<file>...`

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

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

`-n, --check-only`

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

`--[no-]precompile`

[高级] 将每个已编译的查询保存为 .ql 源旁边的二进制 .qlx 文件。

这仅应在准备分发查询包时使用（在这种情况下，codeql 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 环境变量。

query compile

谁可以使用此功能？

本文内容