쿼리 실행

이 콘텐츠는 CodeQL CLI의 최신 릴리스에 대해 설명합니다. 이 릴리스에 대한 자세한 내용은 를 참조하세요 https://github.com/github/codeql-cli-binaries/releases.

이전 릴리스에서 이 명령에 사용할 수 있는 옵션에 대한 세부 정보를 보려면 터미널에서 옵션을 사용하여 명령을 --help 실행합니다.

개요

Shell

codeql execute queries [--output=<dir|file.bqrs>] [--threads=<num>] <options>... -- <dataset> <query|dir|suite|pack>...

Description

[배관] 데이터 세트에 대해 하나 이상의 쿼리를 실행합니다.

이 명령은 일반적으로 직접 호출해서는 안 됩니다. 대신 codeql 데이터베이스 run-query 또는 codeql 쿼리 실행을 사용하여 특정 JVM 옵션을 사용하여 codeql 실행 쿼리 를 시작하여 QL 계산기의 성능을 조정합니다.

기본 옵션

`<dataset>`

[필수] 쿼리할 원시 QL 데이터 세트의 경로입니다.

`<querysuite|pack>...`

[필수] 실행할 쿼리입니다. 각 인수는 다음과 같은 형식 scope/name@range:path 입니다.

scope/name 는 CodeQL 팩의 정규화된 이름입니다.
range 는 셈버 범위입니다.
path 는 파일 시스템 경로입니다.

가 scope/name 지정된 경우 및 path 는 range 선택 사항입니다. 누락 range 은 지정된 팩의 최신 버전을 의미합니다. 누락 path 은 지정된 팩의 기본 쿼리 제품군을 의미합니다.

은 path 쿼리 파일, 하나 이상의 쿼리를 포함하는 디렉터리 또는 .qls 쿼리 도구 모음 파일 중 하나 *.ql 일 수 있습니다. 지정된 팩 이름이 없으면 을 path 제공해야 하며 현재 프로세스의 현재 작업 디렉터리를 기준으로 해석됩니다.

리터럴 @ 또는 :를 포함하는 을 지정 path 하려면 인수의 접두사로 를 path:directory/with:and@/chars사용합니다path:.

및 path 가 scope/name 지정된 경우 는 path 절대일 수 없습니다. CodeQL 팩의 루트를 기준으로 고려됩니다.

`-o, --output=<dir|file.bqrs>`

일반적으로 쿼리의 BQRS 출력이 기록되는 기존 디렉터리입니다. 이 디렉터리 내 의 파일 이름은 QL 파일 이름에서 파생됩니다.

또는 정확히 실행할 쿼리가 하나 있는 경우 작성할 실제 BQRS 파일의 이름일 수도 있고, 사람이 읽을 수 있는 결과 표현을 표준 출력에 쓰도록 생략할 수도 있습니다.

`--no-rerun`

출력 위치에 이미 BQRS 결과가 저장된 것처럼 보이는 쿼리의 평가를 생략합니다.

쿼리 계산기를 제어하는 옵션

`--[no-]tuple-counting`

[고급] 쿼리 계산기 로그의 각 평가 단계에 대한 튜플 수를 표시합니다. --evaluator-log 옵션이 제공되면 명령에서 생성된 텍스트 기반 및 구조화된 JSON 로그 모두에 튜플 수가 포함됩니다. 이는 복잡한 QL 코드의 성능 최적화에 유용할 수 있습니다.

`--timeout=<seconds>`

[고급] 쿼리 평가의 시간 제한 길이(초)를 설정합니다.

시간 제한 기능은 복잡한 쿼리가 평가하는 데 "영원히" 걸리는 경우를 catch하기 위한 것입니다. 쿼리 평가에 소요되는 총 시간을 제한하는 효과적인 방법은 아닙니다. 계산의 각 별도 시간 제한 부분이 시간 제한 내에 완료되는 한 평가는 계속되도록 허용됩니다. 현재 이러한 별도로 시간 지정된 부분은 최적화된 쿼리의 "RA 계층"이지만 나중에 변경될 수 있습니다.

시간 제한이 지정되지 않거나 0으로 지정된 경우 시간 제한이 설정되지 않습니다( codeql 테스트 실행을 제외하고 기본 시간 제한은 5분임).

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

이 많은 스레드를 사용하여 쿼리를 평가합니다.

기본값은 1입니다. 0을 전달하여 컴퓨터의 코어당 하나의 스레드를 사용하거나 -N 을 전달하여 N 코어를 사용하지 않은 상태로 둘 수 있습니다(하나 이상의 스레드를 계속 사용).

`--[no-]save-cache`

[고급] 디스크 캐시에 중간 결과를 적극적으로 씁니다. 이렇게 하면 시간이 더 많이 걸리고(훨씬) 더 많은 디스크 공간을 사용하지만 유사한 쿼리의 후속 실행 속도가 빨라질 수 있습니다.

`--[no-]expect-discarded-cache`

[고급] 쿼리가 실행된 후 캐시가 삭제된다는 가정하에 평가할 조건자와 디스크 캐시에 쓸 대상을 결정합니다.

`--[no-]keep-full-cache`

[고급] 평가가 완료된 후 디스크 캐시를 클린 않습니다. 나중에 codeql 데이터 세트 정리 또는 codeql 데이터베이스 정리 를 수행하려는 경우 시간이 절약됩니다.

`--max-disk-cache=<MB>`

중간 쿼리 결과를 위해 디스크 캐시에서 사용할 수 있는 최대 공간을 설정합니다.

이 크기가 명시적으로 구성되지 않은 경우 계산기는 데이터 세트의 크기와 쿼리의 복잡성에 따라 "적절한" 양의 캐시 공간을 사용하려고 시도합니다. 이 기본 사용량보다 높은 제한을 명시적으로 설정하면 추가 캐싱을 사용하도록 설정되므로 이후 쿼리의 속도를 높일 수 있습니다.

`--min-disk-free=<MB>`

[고급] 파일 시스템에서 사용 가능한 공간의 대상 크기를 설정합니다.

가 지정되지 않은 경우 --max-disk-cache 파일 시스템의 사용 가능한 공간이 이 값 아래로 떨어지면 계산기는 디스크 캐시 사용량을 줄이기 위해 열심히 노력합니다.

`--min-disk-free-pct=<pct>`

[고급] 파일 시스템에서 사용 가능한 공간의 대상 부분을 설정합니다.

가 지정되지 않은 경우 --max-disk-cache 파일 시스템의 사용 가능한 공간이 이 백분율 아래로 떨어지면 평가기는 디스크 캐시 사용량을 줄이기 위해 열심히 노력합니다.

`--external=<pred>=<file.csv>`

외부 조건자 에 대한 행을 포함하는 CSV 파일입니다 \. 여러 --external 옵션을 제공할 수 있습니다.

`--xterm-progress=<mode>`

[고급] xterm 컨트롤 시퀀스를 사용하여 QL 평가 중에 진행률 추적을 표시할지 여부를 제어합니다. 가능한 값은 다음과 같습니다.

no: 멋진 진행 상황을 생성하지 마십시오. 은(는) 어리둥절한 터미널을 가정합니다.

auto(기본값) : 명령이 적절한 터미널에서 실행 중인지 여부를 자동으로 검색합니다.

yes: 터미널이 xterm 컨트롤 시퀀스를 이해할 수 있다고 가정합니다. 이 기능은 여전히 터미널 의 크기를 자동으로 검색할 수 있는 것에 따라 달라지며, 가 지정된 경우에도 -q 사용하지 않도록 설정됩니다.

25x80 (또는 이와 유사): 와 마찬가지로 yes터미널의 크기도 명시적으로 지정합니다.

25x80:/dev/pts/17 (또는 이와 유사): stderr와 다른 터미널에서 멋진 진행률을 표시합니다. 대부분 내부 테스트에 유용합니다.

구조적 계산기 로그의 출력을 제어하는 옵션

`--evaluator-log=<file>`

[고급] 지정된 파일에 계산기 성능에 대한 구조화된 로그를 출력합니다. 이 로그 파일의 형식은 예고 없이 변경될 수 있지만 옵션이 전달된 경우 두 개의 줄 바꿈 문자(기본적으로) 또는 하나로 구분된 JSON 개체의 --evaluator-log-minify 스트림이 됩니다. 를 사용하여 codeql generate log-summary <file> 이 파일에 대한 보다 안정적인 요약을 생성하고 파일을 직접 구문 분석하지 마세요. 파일이 이미 있는 경우 덮어씁니다.

`--evaluator-log-minify`

[고급] 옵션이 전달되면 이 옵션을 전달하면 --evaluator-log 생성된 JSON 로그의 크기가 최소화되므로 사람이 읽을 수 있는 상태가 훨씬 줄어듭니다.

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>`

[고급] 컴파일 캐시 디렉터리의 기본 최대 크기를 재정의합니다.

컴파일 환경을 설정하는 옵션

`--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>=\ 전달하여 GitHub Enterprise Server 컨테이너 레지스트리에 인증합니다.

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

이렇게 하면 CODEQL_REGISTRIES_AUTH 및 GITHUB_토큰 환경 변수가 재정의됩니다. github.com Container Registry에만 인증해야 하는 경우 더 --github-auth-stdin 간단한 옵션을 사용하여 인증할 수 있습니다.

`--github-auth-stdin`

표준 입력을 통해 github.com GitHub 앱 토큰 또는 개인용 액세스 토큰을 전달하여 github.com Container Registry에 인증합니다.

GitHub Enterprise Server Container Registries에 인증하려면 CODEQL_REGISTRIES_AUTH 환경 변수를 전달 --registries-auth-stdin 하거나 사용합니다.

그러면 GITHUB_TOKEN 환경 변수가 재정의됩니다.

쿼리 실행

이 문서의 내용