execute upgrades

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

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

개요

Shell

codeql execute upgrades [--threads=<num>] <options>... -- <dataset> <script>...

codeql execute upgrades [--threads=<num>] <options>... -- <dataset> <script>...

설명

[연결] 기존 원시 QL 데이터 세트에서 업그레이드 스크립트를 실행합니다.

이 명령은 데이터 세트에 대해 특정한 일련의 업그레이드 스크립트를 실행합니다. 각 업그레이드 스크립트의 "이전" dbscheme이 이전 스크립트의 "새로운" dbscheme(또는 첫 번째 스크립트의 경우 데이터 세트의 현재 dbscheme)과 일치하는 것은 호출자의 책임입니다. 그렇지 않으면 오류가 보고됩니다.

옵션

기본 옵션

`<dataset>`

[필수] 업그레이드할 원시 QL 데이터 세트의 경로입니다.

`<script>...`

[필수] 실행할 스크립트를 업그레이드하는 경로입니다. (각 업그레이드 스크립트는 업그레이드 작업을 정의하는 여러 파일이 포함된 디렉터리입니다.) 적용할 순서대로 지정해야 합니다.

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

QL 팩을 찾을 수 있는 디렉터리 목록입니다. 각 디렉터리는 QL 팩(또는 루트에 .codeqlmanifest.json 파일이 포함된 팩 번들) 또는 그러한 디렉터리 하나 이상의 직계 부모일 수 있습니다.

경로에 둘 이상의 디렉터리가 포함된 경우 디렉터리의 순서가 우선 순위를 정의합니다. 확인해야 하는 팩 이름이 디렉터리 트리 중 둘 이상에서 일치하는 경우 먼저 지정된 디렉터리가 우선합니다.

오픈 소스 CodeQL 리포지토리의 체크 아웃에서 이를 가리키면 해당 리포지토리에 있는 언어 중 하나를 쿼리할 때 작동해야 합니다.

압축을 푼 CodeQL 툴체인의 형제로 CodeQL 리포지토리를 체크 아웃한 경우 이 옵션을 지정할 필요가 없습니다. 이러한 형제 디렉터리는 다른 방법으로는 찾을 수 없는 QL 팩으로 항상 검색됩니다. (이 기본값이 작동하지 않는 경우 사용자별 구성 파일에서 --search-path를 한 번만 설정하는 것이 좋습니다).

(참고: Windows에서는 경로 구분 기호가 ;입니다.)

`--additional-packs=<dir>[:<dir>...]`

이 디렉터리 목록이 지정된 경우 --search-path에 있는 디렉터리보다 먼저 팩이 검색됩니다. 이 사이의 순서는 중요하지 않습니다. 이 목록을 통해 서로 다른 두 위치에서 팩 이름을 찾을 경우 오류가 발생합니다.

이 기능은 기본 경로에도 표시되는 팩의 새 버전을 일시적으로 개발하는 경우에 유용합니다. 반면에 구성 파일에서 이 옵션을 재정의하는 것은 권장되지 않습니다. 일부 내부 작업에서는 구성된 값을 재정의하여 즉시 이 옵션을 추가합니다.

(참고: Windows에서는 경로 구분 기호가 ;입니다.)

업그레이드 쿼리 평가를 제어하는 옵션

`--[no-]tuple-counting`

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

`--timeout=<seconds>`

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

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

시간 제한이 지정되지 않거나 0으로 지정된 경우 시간 제한이 설정되지 않습니다(기본 시간 제한이 5분인 codeql test run 제외).

`-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 컨트롤 시퀀스를 이해할 수 있다고 가정합니다. 이 기능은 터미널의 _크기_를 자동으로 감지할 수 있는지 여부에 따라 달라지며 -q가 지정된 경우 사용되지 않습니다.

25x80 (또는 이와 유사): yes와 같습니다. 또한 터미널의 크기를 명시적으로 지정합니다.

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

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

`--evaluator-log=<file>`

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

`--evaluator-log-minify`

[고급] --evaluator-log 옵션을 전달하는 경우 이 옵션도 전달하면 생성되는 JSON 로그의 크기가 최소화되지만 가독성이 훨씬 떨어집니다.

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 환경 변수가 재정의됩니다.