쿼리 컴파일

참고 항목

이 콘텐츠는 CodeQL CLI의 최신 릴리스에 대해 설명합니다. 이 요소에 대한 자세한 내용은 http://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>...

Description

QL 코드를 컴파일하거나 검사합니다.

하나 이상의 쿼리를 컴파일합니다. 이 명령의 주요 결과는 일반적으로 쿼리의 컴파일된 버전이 _컴파일 캐시_에 저장되는 것이며, 이후 쿼리를 실행할 때 해당 캐시에서 찾아 사용됩니다. 그 외 출력 옵션은 대부분 디버깅용입니다.

Options

기본 옵션

`<file>...`

          \[필수] 컴파일할 쿼리입니다. 각 인수는 다음 중 하나입니다.

컴파일할 .ql 파일입니다.
재귀적으로 .ql 파일을 검색할 디렉터리입니다.
쿼리의 특정 집합을 정의하는 .qls 파일입니다.
설치된 QL 팩 중 하나에 의해 내보낸 ‘잘 알려진’ .qls 파일의 기본 이름입니다.

`-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 릴리스에서 쿼리를 개발할 때 경험하는 성능이, Code Scanning이나 CI 통합에 아직 사용 중일 수 있는 약간 이전 릴리스에서도 동일하게 발휘되도록 보장할 수 있습니다.

쿼리가 다른(이전 또는 이후) 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`

GitHub Enterprise Server 컨테이너 레지스트리 인증을 위해 쉼표로 구분된 <registry_url>=<token> 쌍 목록을 전달합니다.

예를 들어, http://containers.GHEHOSTNAME1/v2/=TOKEN1,http://containers.GHEHOSTNAME2/v2/=TOKEN2을 전달하여 두 개의 GitHub Enterprise Server 인스턴스에 인증할 수 있습니다.

이는 CODEQL_REGISTRIES_AUTH 및 GITHUB_TOKEN 환경 변수를 재정의합니다. GitHub 컨테이너 레지스트리에 인증만 필요한 경우 --github-auth-stdin 옵션을 사용하여 간편하게 인증할 수 있습니다.

`--github-auth-stdin`

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

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

이는 GITHUB_TOKEN 환경 변수를 재정의합니다.

          \[고급] 명령을 실행하는 JVM에 옵션을 전달합니다.

(공백이 포함된 옵션은 올바르게 처리되지 않을 수 있습니다.)

          \[고급] 상세 수준을 명시적으로 설정합니다. 선택 가능한 값: errors, warnings, progress, progress+, progress++, progress+++. 
          `-v` 및 `-q`를 재정의합니다.

`--logdir=<dir>`

          \[고급] 지정된 디렉토리에 자세한 로그를 하나 이상 기록합니다. 로그 파일 이름에는 타임스탬프와 실행 중인 하위 명령 이름이 포함됩니다.

(로그 파일 이름을 완전히 제어하고 싶다면, 대신 --log-to-stderr을 사용하고 원하는 대로 stderr를 리디렉션하세요.)

`--common-caches=<dir>`

          \[고급] CLI의 여러 실행 간에 유지되는 디스크상의 캐시 데이터 위치를 제어합니다. 여기에는 다운로드된 QL 팩과 컴파일된 쿼리 계획이 포함됩니다. 명시적으로 설정하지 않은 경우, 사용자 홈 디렉터리에 있는 `.codeql`이라는 이름의 디렉터리를 기본값으로 사용하며, 해당 디렉터리가 존재하지 않으면 새로 생성됩니다.

v2.15.2부터 사용할 수 있습니다.

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

이 문서의 내용