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

데이터 재사용 코드ql-cli.man-pages-version-note %}

개요

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>

Description

          \[내부 처리] 지정된 CodeQL 추출기를 사용하여 독립 파일을 인덱싱합니다.

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

          `--include`, `--exclude` 및 `--prune` 옵션은 모두 글롭 패턴을 사용하며, 다음 와일드카드 문자를 활용할 수 있습니다.

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

Options

기본 옵션

`<database>`

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

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

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

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

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

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

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

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

`--working-dir=<dir>`

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

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](/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-init) 또는 `codeql database begin-tracing`에 전달되는 경우 옵션은 간접 추적 환경에만 적용됩니다. 워크플로에서 [codeql database trace-command](/code-security/reference/code-scanning/codeql/codeql-cli-manual/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'가 있어야 하며, 그 아래에 추출기 이름이 2단계 맵 키로 있어야 합니다. 추가 맵 레벨은 중첩된 추출기 그룹을 나타내며, 문자열 및 배열 옵션은 문자열 값과 배열 값을 가지는 맵 항목으로 표현됩니다.

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

          [codeql database init](/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-init) 또는 `codeql database begin-tracing`에 전달되는 경우 옵션은 간접 추적 환경에만 적용됩니다. 워크플로에서 [codeql database trace-command](/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-trace-command)를 호출하면 해당 명령에 원하는 옵션도 전달해야 합니다.

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

인덱싱할 파일 집합을 제한하는 옵션입니다.

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

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

`--include=<glob>`

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

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

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

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

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

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

`--logdir=<dir>`

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

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

`--common-caches=<dir>`

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

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

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

이 기사에서

개요

Description

Options

기본 옵션

`<database>`

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

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

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

`--working-dir=<dir>`

추출기 동작을 제어하는 옵션입니다.

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

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

인덱싱할 파일 집합을 제한하는 옵션입니다.

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

`--include=<glob>`

`--also-match=<glob>`

`--exclude=<glob>`

`--prune=<glob>`

`--size-limit=<bytes>`

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

`--[no-]follow-symlinks`

`--[no-]find-any`

일반 옵션

`-h, --help`

`-J=<opt>`

`-v, --verbose`

`-q, --quiet`

`--verbosity=<level>`

`--logdir=<dir>`

`--common-caches=<dir>`