쿼리 컴파일

이 콘텐츠는 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 파일의 basename입니다.

`-n, --check-only`

QL이 유효하고 오류를 인쇄하는지를 검사만 하고 실제로 쿼리 계획을 최적화 및 저장하지는 않습니다. 전체 컴파일보다 훨씬 빠를 수 있습니다.

`--[no-]precompile`

[고급] 컴파일된 각 쿼리를 .ql 원본 옆에 있는 이진 .qlx 파일로 저장합니다.

이는 배포를 위해 쿼리 팩을 준비하는 동안에만 지원됩니다(이 경우 codeql 팩 게시에서 자동으로 사용됨). .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 및 GITHUB_TOKEN 환경 변수가 재정의됩니다. github.com 컨테이너 레지스트리에만 인증해야 하는 경우 더 간단한 --github-auth-stdin 옵션을 사용하여 인증할 수 있습니다.

`--github-auth-stdin`

표준 입력을 통해 github.com에 GitHub Apps 토큰 또는 개인용 액세스 토큰을 전달하여 github.com 컨테이너 레지스트리에 인증합니다.

GitHub Enterprise Server 컨테이너 레지스트리에 인증하려면 --registries-auth-stdin을 전달하거나 CODEQL_REGISTRIES_AUTH 환경 변수를 사용합니다.

이렇게 하면 GITHUB_TOKEN 환경 변수가 재정의됩니다.

쿼리 컴파일

누가 이 기능을 사용할 수 있나요?

이 문서의 내용