데이터베이스 인덱스 파일

Note

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

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

개요

Shell

codeql database index-files --language=<lang> [--threads=<num>] [--ram=<MB>] [--extractor-option=<extractor-option-name=value>] <options>... -- <database>

codeql database index-files --language=<lang> [--threads=<num>] [--ram=<MB>] [--extractor-option=<extractor-option-name=value>] <options>... -- <database>

설명

[연결] 지정된 CodeQL 추출기를 사용하여 독립 실행형 파일을 인덱싱합니다.

이 명령은 지정된 작업 디렉터리에서 파일 집합을 선택하고 지정된 추출기를 적용합니다. 기본적으로 모든 파일이 선택됩니다. 일반적인 호출은 포함된 파일 집합을 제한하는 옵션을 지정합니다.

--include, --exclude 및 --prune 옵션은 모두 다음과 같은 와일드카드 문자를 사용할 수 있는 GLOB 패턴을 사용합니다.

단일 "?"는 슬래시/백슬래시를 제외한 모든 문자와 일치합니다.
단일 "*"는 슬래시/백슬래시를 제외한 모든 문자 수와 일치합니다.
패턴 "**"는 0개 이상의 전체 디렉터리 구성 요소와 일치합니다.

옵션

기본 옵션

`<database>`

[필수] 생성 중인 CodeQL 데이터베이스의 경로입니다. codeql database init를 사용하여 추출할 준비가 되어 있어야 합니다.

`-l, --language=<lang>`

[필수] 일치하는 파일을 인덱싱하는 데 사용해야 하는 추출기입니다.

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

추출기에서 해당 스레드 수를 사용하도록 요청합니다. 이 옵션은 제안으로써 추출기로 전달됩니다. CODEQL_THREADS 환경 변수가 설정되면 환경 변수 값이 이 옵션보다 우선합니다.

0을 전달하여 컴퓨터의 코어당 하나의 스레드를 사용하거나 -_N_을 전달하여 _N_개의 코어를 사용하지 않은 상태로 둘 수 있습니다(하나 이상의 스레드를 계속 사용하는 경우 제외).

`-M, --ram=<MB>`

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

`--working-dir=<dir>`

[고급] 지정된 명령을 실행해야 하는 디렉터리입니다. 이 인수가 제공되지 않으면 명령이 codeql 데이터베이스 만들기에 전달된 --source-root 값(있는 경우)으로 실행됩니다. --source-root 인수가 제공되지 않으면 명령이 현재 작업 디렉터리에서 실행됩니다.

추출기 동작 제어 옵션

`-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 데이터베이스 init 또는 codeql database begin-tracing에 전달되면 옵션이 간접 추적 환경에만 적용됩니다. 워크플로에서 codeql 데이터베이스 추적 명령을 호출하는 경우, 원하는 경우의 옵션도 전달해야 합니다.

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

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

추출기 옵션 번들 파일을 지정합니다. 추출기 옵션 번들 파일은 추출기 옵션을 설정하는 JSON 파일(확장명 .json) 또는 YAML 파일(확장명 .yaml 또는 .yml)입니다. 파일에는 최상위 맵 키 'extractor'가 있어야 하며, 그 아래에는 추출기 이름이 두 번째 수준 맵 키로 지정되어야 합니다. 지도의 추가 수준은 중첩된 추출기 그룹을 나타내며 문자열 및 배열 옵션은 문자열 및 배열 값이 있는 지도 항목입니다.

추출기 옵션 번들 파일은 지정된 순서대로 읽습니다. 다른 추출기 옵션 번들 파일에서 동일한 추출기 옵션을 지정하는 경우, 동작은 추출기 옵션이 예상하는 형식에 따라 달라집니다. 문자열 옵션은 제공된 마지막 값을 사용합니다. 배열 옵션은 제공된 모든 값을 순서대로 사용합니다. 이 명령줄 옵션을 사용하여 지정된 추출기 옵션은 추출기 옵션을 통해 --extractor-option이(가) 제공되기 전에 처리됩니다.

codeql 데이터베이스 init 또는 codeql database begin-tracing에 전달되면 옵션이 간접 추적 환경에만 적용됩니다. 워크플로에서 codeql 데이터베이스 추적 명령을 호출하는 경우, 원하는 경우의 옵션도 전달해야 합니다.

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

인덱싱된 파일 집합을 제한하는 옵션

`--include-extension=<.ext>`

지정된 확장명을 갖는 검색 디렉터리 트리의 모든 파일을 포함합니다. 일반적으로 확장명 앞에 점을 포함해야 합니다. 예를 들어 --include-extension .xml 전달에는 ".xml" 확장명을 갖는 모든 파일이 포함됩니다. 이 옵션은 부정된 --include 옵션과 호환되지 않습니다.

`--include=<glob>`

검색 디렉터리에서 각 파일 및 디렉터리의 상대 경로를 사용하여 지정된 GLOB와 일치하는 검색 디렉터리 트리의 모든 파일 및 디렉터리를 포함합니다. GLOB가 ! 문자로 시작하는 경우 일치하는 파일 및 디렉터리는 제외됩니다.

--include 옵션은 순서대로 처리되며 이후 옵션이 이전 옵션을 재정의합니다. 예를 들어 --include ** --include !sub/*.ts --include sub/main.*는 sub/main.ts를 포함하고(sub/main.*에 의해 포함되기 때문), sub/index.ts를 제외하며(!sub/*.ts에 의해 제외되기 때문) sub/test.js를 포함합니다(이후에 제외되지 않고 **에 의해 포함되기 때문).

`--also-match=<glob>`

검색 디렉터리에서 각 파일 및 디렉터리의 상대 경로를 사용하여 모든 결과가 지정된 GLOB와 일치하도록 요구합니다. 이 옵션은 --include와 구조 및 해석이 동일하지만 --include와 함께 적용되는 별도의 GLOB 시퀀스를 지정합니다.

`--exclude=<glob>`

검색 디렉터리에서 각 파일 및 디렉터리의 상대 경로를 사용하여 지정된 GLOB와 일치하는 모든 파일 및 디렉터리를 제외합니다. 이 옵션은 모든 include 옵션을 재정의합니다. 이 옵션은 부정된 --include 옵션과 호환되지 않습니다.

`--prune=<glob>`

검색 디렉터리에서 각 파일 및 디렉터리의 상대 경로를 사용하여 지정된 GLOB와 일치하는 모든 파일 및 디렉터리를 제외합니다. 이 옵션은 모든 include 옵션을 재정의합니다. 이 옵션은 부정된 --include 옵션과 호환되지 않습니다.

`--size-limit=<bytes>`

크기가 지정된 제한을 초과하는 모든 파일을 제외합니다. 크기 제한은 바이트 단위 또는 "k" 접미사를 사용하는 KiB(키비바이트), "m" 접미사를 사용하는 MiB(메비바이트), "g" 접미사를 사용하는 GiB(기비바이트) 단위입니다. 이 옵션은 모든 include 옵션을 재정의합니다.

`--total-size-limit=<bytes>`

확인된 모든 파일의 결합된 크기가 지정된 제한을 초과하는 경우 명령이 오류와 함께 종료되도록 합니다. 크기 제한은 바이트 단위 또는 "k" 접미사를 사용하는 KiB(키비바이트), "m" 접미사를 사용하는 MiB(메비바이트), "g" 접미사를 사용하는 GiB(기비바이트) 단위입니다.

`--[no-]follow-symlinks`

대상에 대한 바로 가기 링크를 따릅니다.

`--[no-]find-any`

최대 하나의 일치 항목을 찾습니다(모든 일치 항목이 아님).

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

일반 옵션

`-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부터 사용할 수 있습니다.