query-server2 실행

참고 항목

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

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

개요

Shell

codeql execute query-server2 [--threads=<num>] <options>...

codeql execute query-server2 [--threads=<num>] <options>...

Description

          \[내부 처리] IDE의 쿼리를 실행하도록 지원합니다.

IDE용 QL 언어 확장 작성자에게만 이 명령이 해당됩니다. 이는 IDE 플러그 인에 의해 백그라운드에서 시작되며, 표준 입력과 출력 스트림의 특수 프로토콜을 통해 통신합니다.

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

Options

기본 옵션

`--[no-]tuple-counting`

          \[고급] 쿼리 평가기 로그에 각 평가 단계별 튜플 수를 표시합니다. `--evaluator-log` 옵션이 제공되면 튜플 수는 명령으로 생성된 텍스트 기반 로그와 구조화된 JSON 로그 모두에 포함됩니다. (복잡한 QL 코드의 성능 최적화에 도움이 될 수 있습니다.)

`--timeout=<seconds>`

          \[고급] 쿼리 평가에 대한 시간 제한(초)을 설정합니다.

시간 제한 기능은 복잡한 쿼리의 평가가 "영구적으로" 실행되는 경우를 방지하기 위해 개발되었습니다. 쿼리 평가에 소요되는 총 시간을 제한하기 위한 목적으로는 효과적이지 않습니다. 별도로 시간이 측정된 각 계산 부분이 시간 제한 내에 완료되면 평가가 진행될 수 있습니다. 현재 별도로 시간이 측정된 부분은 최적화된 쿼리의 "RA 계층"이지만 차후에 변경될 수 있습니다.

시간 제한이 지정되지 않거나 0으로 지정된 경우 시간 제한이 설정되지 않습니다. 단, codeql test run의 경우 기본 시간 제한은 5분입니다.

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

해당 스레드 수를 사용하여 쿼리를 평가합니다.

기본값은 1입니다. 0을 전달하여 머신의 코어당 한 개의 스레드를 사용할 수 있고, -_N_을 전달하여 _N_개의 코어를 사용하지 않은 상태로 둘 수 있습니다. 단, 최소 한 개의 스레드는 계속 사용됩니다.

`--[no-]save-cache`

          \[사용되지 않음] \[고급] 이 플래그는 아무 작업도 수행하지 않습니다.

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

          \[고급] 쿼리가 실행된 후 캐시가 삭제될 것을 전제로 하여, 평가할 조건자와 디스크 캐시에 작성할 내용을 결정합니다.

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

          \[고급] 평가 완료 후 디스크 캐시를 정리하지 않아야 합니다.

차후에 codeql dataset cleanup 또는 codeql database cleanup을 수행할 경우 이를 통해 시간이 절약됩니다.

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

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

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

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

          \[고급] 파일 시스템에 확보할 목표 여유 공간의 양을 설정합니다.

--max-disk-cache이(가) 지정되지 않으면 파일 시스템의 사용 가능한 공간이 이 값 이하로 떨어질 때 평가기에서 디스크 캐시 사용량을 줄이려고 합니다.

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

          \[고급] 파일 시스템에 확보할 목표 여유 공간의 비율을 설정합니다.

--max-disk-cache이(가) 지정되지 않으면 파일 시스템의 사용 가능한 공간이 이 비율 이하로 떨어질 때 평가기에서 디스크 캐시 사용량을 줄이려고 합니다.

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

외부 조건자 <pred> 의 행이 포함된 CSV 파일입니다. 여러 개의 --external 옵션이 제공될 수 있습니다.

`--xterm-progress=<mode>`

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

          `no`: 복잡한 진행률을 생성하지 않아야 합니다. 바보 터미널이라고 가정합니다.

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

          `yes`: 터미널이 xterm 제어 시퀀스를 인식할 수 있다고 가정합니다. 이 기능은 계속해서 터미널 _크기_의 자동 검색 여부에 따라 달라집니다(Windows에서는 구현되지 않음). 또한 `-q`이(가) 지정되면 이 기능은 비활성화됩니다.

          `25x80` (또는 이와 유사): `yes`과(와) 같으며 터미널 크기를 명시적으로 지정합니다. (`yes`과(와) 다르게 이 기능은 Windows에서 작동합니다.)

          `25x80:/dev/pts/17` (또는 이와 유사): stderr가 아닌 _다른_ 터미널에서 복잡한 진행률을 표시합니다. 내부 테스트에 주로 사용됩니다.

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

이는 codeql 쿼리 컴파일(q.v.)과 비슷한 옵션처럼 작동합니다.

해당 값이 쿼리별로 제공되므로 --additional-packs 또는 --library-path 옵션은 없습니다.

(참고: Windows에서는 경로 구분 기호로 ;을(를) 사용합니다.)

구조화된 평가기 로그의 출력을 제어하는 옵션

`--evaluator-log=<file>`

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

`--evaluator-log-minify`

          \[고급] `--evaluator-log` 옵션이 전달되면 생성되는 JSON 로그의 크기가 최소화되지만 가독성이 크게 저하됩니다.

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

(옵션에 공백이 포함되면 제대로 처리되지 않을 수 있는 점에 유의해야 합니다.)

          \[고급] 세부 정보 표시 수준을 명시적으로 오류, 경고, 진행률, 진행률+, 진행률++, 진행률+++ 중 하나로 설정합니다. 
          `-v` 및 `-q`를 재정의합니다.

`--logdir=<dir>`

          \[고급] 지정한 디렉터리에 상세 로그를 하나 이상의 파일로 작성하며, 생성된 이름에는 타임스탬프와 실행 중인 하위 명령 이름을 포함합니다.

(로그 파일 이름을 직접 작성하려면 대신 --log-to-stderr을(를) 지정하고 stderr를 원하는 위치로 리디렉션합니다.)

`--common-caches=<dir>`

          \[고급] 다운로드한 QL 팩 및 컴파일된 쿼리 계획 등 CLI를 여러 번 실행해도 지속되는 디스크의 캐시된 데이터의 위치를 제어합니다. 명시적으로 설정하지 않으면, 기본적으로 사용자의 홈 디렉터리에 이름이 지정된 `.codeql` 디렉터리로 설정됩니다. 디렉터리가 아직 없는 경우에는 만들어집니다.

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

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

이 문서의 내용

개요