데이터베이스 추적 명령

[플러밍] 추적된 빌드의 일부로 단일 명령을 실행합니다.

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

CodeQL은(는) 다음 리포지토리 유형에 사용할 수 있습니다.

이 문서의 내용

참고 항목

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

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

개요

Shell
codeql database trace-command [--threads=<num>] [--ram=<MB>] [--extractor-option=<extractor-option-name=value>] <options>... -- <database> <command>...

Description

          \[[플러밍] 추적된 빌드의 일부로 단일 명령을 실행합니다.

이렇게 하면 추적기에서 지정된 단일 명령줄을 실행하므로 일부 추출을 수행할 수 있으나, 결과로 나타난 CodeQL 데이터베이스를 최종화하지는 않습니다.

Options

기본 옵션

<database>

          \[[필수] 구축 중인 CodeQL 데이터베이스의 경로입니다. [codeql database init](/code-security/codeql-cli/codeql-cli-manual/database-init)를 사용하여 추출 준비가 되어 있어야 합니다.

--db-cluster 옵션이 제공되면 이는 데이터베이스 자체가 아니라,_ 데이터베이스를 포함한 _디렉터리이며, 해당 데이터베이스는 모두 함께 처리됩니다.

<command>...

실행할 명령. 이것은 프로세스를 생성하는 데에 사용되는 하나 이상의 인수로 구성될 수 있습니다. 그러한 인수와 사용자의 인수 간 혼동을 막기 위해 명령 인수를 나열하기 전에 '--' 인수를 전달할 것을 권장합니다.

이 명령은 상태 코드 0으로 종료됩니다. 다른 모든 종료 코드는 오류로 간주됩니다.

--index-traceless-dbs가 지정된 경우 명령이 생략될 수 있습니다.

-j, --threads=<num>

추출기에 이와 같은 수의 스레드를 사용하도록 요청하세요. 이 옵션은 제안으로 추출기에 전달됩니다. CODEQL_THREADS 환경 변수가 설정된 경우, 이 옵션보다 환경 변수값이 우선합니다.

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

-M, --ram=<MB>

추출기에 이 정도의 메모리를 사용하도록 요청합니다. 이 옵션은 제안으로 추출기에 전달됩니다. CODEQL_RAM 환경 변수가 설정된 경우, 이 옵션보다 환경 변수값이 우선합니다.

--[no-]db-cluster

명령줄에 지정된 디렉터리가 데이터베이스 자체가 아니라 구축 중인 하나 이상의 데이터베이스를 포함하는 디렉터리임을 의미합니다. 이러한 데이터베이스는 함께 처리됩니다.

--no-tracing

          \[[고급] 지정된 명령을 추적하는 대신 이것을 이용해 필요한 모든 데이터를 직접 생성합니다.

--extra-tracing-config=<tracing-config.lua>

          \[[고급] 추적기 구성 파일 경로입니다. 빌드 추적기 동작 수정에 사용될 수 있습니다. 빌드 명령의 일부로 실행되는 컴파일러 프로세스를 선택하고 다른 도구의 실행을 트리거하는 데 사용될 수 있습니다. 추출기는 대부분의 상황에서 작동 가능한 기본 추적기 구성 파일을 제공합니다.

--[no-]index-traceless-dbs

지정된 명령 외에도 빌드 프로세스 추적을 이용하지 않는 추출기에 대해 기본 스크립트를 실행합니다. --db-cluster를 이용해 여러 언어에 대한 데이터베이스를 생성 중인 경우 이 옵션은 정확히 단 한 번의 codeql database trace-command 호출에만 지정되어야 합니다.

--[no-]use-build-mode

데이터베이스의 빌드 모드를 기준으로 무엇을 실행할지 결정합니다. 이 옵션은 --index-traceless-dbs와 동시에 사용할 수 없습니다.

--working-dir=<dir>

          \[[고급] 지정된 명령을 실행해야 하는 디렉터리입니다. 이 인수가 제공되지 않으면, [codeql database create](/code-security/codeql-cli/codeql-cli-manual/database-create)로 전달된 `--source-root` 경로에서 실행됩니다. `--source-root` 인수가 제공되지 않는 경우, 명령은 현재 작업 디렉터리에서 실행됩니다.

--no-run-unnecessary-builds

          \[[고급] 구축 중인 데이터베이스가 빌드 프로세스 추적을 필요로 하는 추출기를 사용하는 경우에만 지정된 빌드 명령을 실행합니다.

이 옵션이 제공되지 않으면, CodeQL에 해당 명령이 필요하지 않더라도 다른 이유로 부수적인 효과가 필요할 것이라고 전제하여 명령이 실행됩니다.

추출기 동작을 제어하기 위한 옵션

-O, --extractor-option=<extractor-option-name=value>

CodeQL 추출기에 대한 옵션을 설정합니다. extractor-option-name는 extractor_name.group1.group2.option_name 또는 group1.group2.option_name 형식을 따라야 합니다. extractor_option_name가 추출기 이름으로 시작하는 경우, 지정된 추출기는 group1.group2.option_name 옵션을 선언해야 합니다. 그렇지 않으면, group1.group2.option_name 옵션을 선언하는 모든 추출기에 옵션이 설정될 것입니다. value는 줄바꿈이 포함되지 않은 어떠한 문자열이든 될 수 있습니다.

이 명령줄 옵션을 반복적으로 사용하면 여러 개의 추출기 옵션을 설정할 수 있습니다. 사용자가 추출기 옵션에 여러 개의 값을 제공하면 추출기 옵션에서 예상하는 유형에 따라 동작이 달라집니다. 문자열 옵션은 마지막에 제공되는 값을 이용합니다. 배열 옵션에서는 제공되는 모든 값을 순서대로 사용합니다. 이 명령줄 옵션을 사용하여 지정되는 추출기 옵션은 --extractor-options-file을 통해 전달된 추출기 옵션이 적용된 이후에 처리됩니다.

codeql database init 또는 codeql database begin-tracing로 전달되는 경우 옵션은 간접 추적 환경에만 적용됩니다. 워크플로에서 codeql database trace-command를 호출하면, 필요에 따라 원하는 옵션도 전달되어야 합니다.

CodeQL 추출기 옵션과 각 추출기에서 선언한 옵션을 나열하는 방법에 대한 자세한 내용은 https://codeql.github.com/docs/codeql-cli/extractor-options를 참조하세요.

--extractor-options-file=<extractor-options-bundle-file>

추출기 옵션 번들 파일을 지정합니다. 추출기 옵션 번들 파일은 JSON 파일(확장자 .json) 또는 YAML 파일(확장자 .yaml 또는 .yml)로, 추출기 옵션을 설정합니다. 파일에는 최상위 맵 키 '추출기'가 있어야 하며, 그 아래에는 추출기 이름을 2계층 맵 키로 가져야 합니다. 맵의 추가 계층은 중첩된 추출기 그룹을 나타내고, 문자열 및 배열 옵션은 문자열 및 배열 값이 있는 맵 엔트리입니다.

추출기 옵션 번들 파일은 지정된 순서대로 읽힙니다. 다수의 추출기 옵션 번들 파일이 하나의 추출기 옵션을 지정하면, 추출기 옵션이 예상하는 형식에 따라 동작이 달라집니다. 문자열 옵션은 마지막에 제공되는 값을 이용합니다. 배열 옵션에서는 제공되는 모든 값을 순서대로 사용합니다. 이 명령줄 옵션을 사용하여 지정된 추출기 옵션은 --extractor-option을 통해 제공되는 추출기 옵션보다 먼저 처리됩니다.

codeql database init 또는 codeql database begin-tracing로 전달되는 경우 옵션은 간접 추적 환경에만 적용됩니다. 워크플로에서 codeql database trace-command를 호출하면, 필요에 따라 원하는 옵션도 전달되어야 합니다.

CodeQL 추출기 옵션과 각 추출기에서 선언한 옵션을 나열하는 방법에 대한 자세한 내용은 https://codeql.github.com/docs/codeql-cli/extractor-options를 참조하세요.

일반 옵션

-h, --help

이 도움말 텍스트를 표시합니다.

-J=<opt>

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

(옵션에 공백이 포함되면 올바로 처리되지 않을 수 있으므로 유의해야 합니다.)

-v, --verbose

출력되는 진행률 메시지 수를 점차 늘립니다.

-q, --quiet

출력되는 진행률 메시지 수를 점차 줄입니다.

--verbosity=<level>

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

--logdir=<dir>

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

(로그 파일명을 직접 작성하기 위해서는 대신 --log-to-stderr을 사용하고 원하는 곳으로 stderr를 리디렉션합니다.)

--common-caches=<dir>

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

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