데이터베이스 인덱스-파일

[내부 처리] 지정된 CodeQL 추출기로 독립 실행형 파일을 인덱싱합니다.

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

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

이 문서의 내용

참고 항목

이 콘텐츠는 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>

Description

          \[내부 처리] 지정된 CodeQL 추출기로 독립 실행형 파일을 인덱싱합니다.

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

--include, --exclude 및 --prune 옵션은 모두 glob 패턴을 사용하며, 이 패턴에서는 다음과 같은 와일드카드 문자를 사용할 수 있습니다:

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

Options

기본 옵션

<database>

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

-l, --language=<lang>

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

-j, --threads=<num>

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

0을 전달하면 컴퓨터의 코어당 1개의 스레드를 사용하고, -_N_을 전달하면 _N_개의 코어를 사용하지 않습니다(단, 최소 1개의 스레드는 사용합니다).

-M, --ram=<MB>

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

--working-dir=<dir>

          \[고급] 지정된 명령을 실행해야 하는 디렉터리입니다. 이 인수를 제공하지 않으면, 존재하는 경우 [codeql database create](/code-security/codeql-cli/codeql-cli-manual/database-create)에 `--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이(가) 추출기 이름으로 시작하는 경우, 지정된 추출기는 option group1.group2.option_name을(를) 선언해야 합니다. 그렇지 않으면 option 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)입니다. 파일에는 최상위 맵 키 '추출기'가 있어야 하며, 그 아래에 두 번째 수준의 맵 키로 추출기 이름이 있어야 합니다. 더 깊은 수준의 맵은 중첩된 추출기 그룹을 나타내고, 문자열/배열 옵션은 문자열/배열 값이 있는 맵 항목입니다.

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

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

각 추출기가 선언한 옵션을 나열하는 방법을 포함하여 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 옵션과 호환되지 않습니다.

--prune=<glob>

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

--size-limit=<bytes>

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

--total-size-limit=<bytes>

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

--[no-]follow-symlinks

모든 바로 가기 링크를 대상까지 따라갑니다.

--[no-]find-any

(모든 일치가 아니라) 최대 1개의 일치만 찾습니다.

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