database init

참고 항목

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

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

개요

Shell

codeql database init --source-root=<dir> [--language=<lang>[,<lang>...]] [--github-auth-stdin] [--github-url=<url>] [--extractor-option=<extractor-option-name=value>] <options>... -- <database>

codeql database init --source-root=<dir> [--language=<lang>[,<lang>...]] [--github-auth-stdin] [--github-url=<url>] [--extractor-option=<extractor-option-name=value>] <options>... -- <database>

Description

          \[내부 처리] 빈 CodeQL 데이터베이스를 만듭니다.

아직 원시 QL 데이터 세트가 없는 상태에서 추출기 실행이 가능한 상태의 CodeQL 데이터베이스에 대한 기본 구조를 만듭니다. 이 명령이 완료되면 하나 이상의 codeql database trace-command 명령을 실행한 후 codeql database finalize를 실행하여 데이터베이스 쿼리를 준비합니다.

(이 작업의 일부는 적절한 언어 팩의 위치를 확인하여 데이터베이스 메타데이터에 저장함으로써 각 추출 명령 실행 시 해당 작업을 다시 수행하지 않도록 하는 것입니다 추출 작업 중간에 다른 추출기로 전환하는 것은 허용되지 않습니다.)

Options

기본 옵션

`<database>`

          \[필수] CodeQL 데이터베이스를 만들 경로입니다. 이 디렉터리가 만들어질 예정이므로 이미 존재해서는 _안 됩니다_(단 해당 부모는 존재해야 함).

--db-cluster 옵션이 지정된 경우 해당 경로는 데이터베이스 자체가 아니라 동일한 소스 루트에서 빌드된 여러 언어용 데이터베이스를 포함하는 디렉터리가 됩니다.

이 디렉터리는 빌드 프로세스에서 영향을 받지 않는 위치에 있어야 합니다. 예를 들어, Maven 프로젝트의 target 디렉터리는 적합한 위치가 아닙니다.

`-s, --source-root=<dir>`

          \[필수] 루트 소스 코드 디렉터리입니다. 많은 경우, 체크 아웃 루트가 됩니다. 이 디렉터리 내의 파일은 해당 데이터베이스의 기본 소스 파일로 간주됩니다. 일부 출력 형식에서는 파일이 이 디렉터리의 상대 경로로 참조됩니다.

`--[no-]overwrite`

          \[고급] 데이터베이스가 이미 존재하면 실패로 처리하지 않고 데이터베이스 삭제 후 이 명령을 수행합니다. 디렉터리가 존재하지만 데이터베이스처럼 보이지 않으면 오류가 발생합니다.

`--[no-]force-overwrite`

          \[고급] 데이터베이스가 이미 존재하는 경우, 데이터베이스처럼 보이지 않더라도 실패로 처리하지 않고 데이터베이스 삭제 후 이 명령을 수행합니다. 이 옵션은 데이터베이스 디렉터리 전체를 재귀적으로 삭제할 수 있으므로 사용 시 주의가 필요합니다.

`--codescanning-config=<file>`

          \[고급] CodeQL 데이터베이스를 만드는 방법과 후속 단계에서 실행할 쿼리에 대한 옵션을 지정하는 코드 검사 구성 파일을 읽습니다. 이 구성 파일의 형식에 대한 자세한 내용은 [AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning)을 참조하세요. 후속 단계에서 이 파일의 쿼리를 실행하려면 다른 쿼리를 지정하지 않은 상태에서 [codeql database analyze](/code-security/codeql-cli/codeql-cli-manual/database-analyze)를 호출합니다.

`--[no-]db-cluster`

하나의 데이터베이스를 만드는 것이 아닌 여러 언어에 대한 데이터베이스의 "클러스터"를 만듭니다. 각 데이터베이스는 명령줄에 지정된 디렉터리의 하위 디렉터리입니다.

`-l, --language=<lang>[,<lang>...]`

새 데이터베이스를 분석하는 데 사용될 언어입니다.

codeql resolve languages를 사용하여 검색 경로에서 발견된 플러그형 언어 추출기 목록을 가져옵니다.

--db-cluster 옵션이 지정되면 이 옵션을 여러 번 지정하거나 쉼표로 구분된 언어 목록을 값으로 사용할 수 있습니다.

이 옵션이 생략되고 분석 중인 소스 루트가 GitHub 리포지토리의 체크 아웃인 경우, CodeQL CLI는 GitHub API를 호출하여 분석 언어를 자동으로 결정하려고 합니다. 이를 수행하려면 GitHub PAT 토큰이 반드시 제공되어야 합니다. GITHUB_TOKEN 환경 변수에 설정하거나 --github-auth-stdin 옵션을 통해 표준 입력으로 제공할 수 있습니다.

`--build-mode=<mode>`

데이터베이스를 만드는 데 사용할 빌드 모드입니다.

분석 중인 언어에 기반하여 빌드 모드를 선택하세요.

          `none`: 데이터베이스는 소스 루트를 빌드하지 않아도 만들어집니다.

C#, Java, JavaScript/TypeScript, Python, Ruby에서 사용할 수 있습니다.

          `autobuild`: 데이터베이스는 소스 루트를 자동으로 빌드함으로써 만들어집니다. C/C++, C#, Go, Java/Kotlin, Swift에서 사용할 수 있습니다.

          `manual`: 데이터베이스는 수동으로 지정한 빌드 명령을 사용하여 소스 루트를 빌드함으로써 만들어집니다. C/C++, C#, Go, Java/Kotlin, Swift에서 사용할 수 있습니다.

--command를 사용하여 데이터베이스를 만드는 경우, 추가로 '--build-mode manual'을 지정하지 않아도 됩니다.

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

`--[no-]allow-missing-source-root`

          \[고급] 지정된 소스 루트가 없는 경우에도 진행합니다.

`--[no-]begin-tracing`

          \[고급] 명시적 빌드 명령을 사용할 수 없는 경우 기존 빌드 워크플로에 통합할 수 있도록 "간접 빌드 추적" 설정을 위한 몇 가지 스크립트를 만듭니다. 이 기능의 사용 시점 및 방법에 대한 자세한 내용은 [AUTOTITLE](/code-security/codeql-cli/getting-started-with-the-codeql-cli/preparing-your-code-for-codeql-analysis)에 게시된 설명서를 참조하세요.

기준 계산 옵션

`--[no-]calculate-baseline`

          \[고급] 분석 중인 코드에 대한 기준 정보를 계산하고 이를 데이터베이스에 추가합니다. 기본적으로 소스 루트가 파일 시스템의 루트가 아니면 활성화됩니다. 이 플래그는 동작을 비활성화하거나 파일 시스템의 루트에서도 강제로 활성화되도록 하는 데 사용할 수 있습니다.

`--[no-]sublanguage-file-coverage`

          \[GitHub.com 및 GitHub Enterprise Server v3.12.0 이상만 해당] 하위 언어 파일 적용 범위 정보를 사용합니다. 이는 C 및 C++, Java 및 Kotlin, JavaScript 및 TypeScript 등의 CodeQL 추출기를 공유하는 언어에 대한 별도의 파일 적용 범위 정보를 계산하고, 표시하며, 내보냅니다.

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

추출기 선택 옵션

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

추출기 팩이 위치할 수 있는 디렉터리 목록입니다. 디렉터리는 추출기 팩 자체이거나 추출기가 바로 하위 디렉터리로 포함되는 디렉터리일 수도 있습니다.

경로에 여러 개의 디렉터리 트리가 포함된 경우 나열된 순서대로 우선 순위가 결정됩니다. 즉, 대상 언어가 둘 이상의 디렉터리 트리에서 발견되면 먼저 위치한 트리가 우선합니다.

CodeQL 도구 체인에 기본적으로 제공되는 추출기는 항상 찾을 수 있지만 별도로 제공되는 추출기를 사용하려면 이 옵션을 제공해야 합니다. 또는 사용자별 구성 파일에서 --search-path를 설정하는 것이 권장됩니다.

(참고: Windows에서는 경로 구분 기호로 ;을 사용합니다.)

언어 자동 검색을 위해 GitHub API 호출 방법을 구성하는 옵션

`-a, --github-auth-stdin`

표준 입력을 통해 GitHub 앱 토큰 또는 개인용 액세스 토큰을 허용합니다.

이는 GITHUB_TOKEN 환경 변수를 재정의합니다.

`-g, --github-url=<url>`

사용할 GitHub 인스턴스의 URL입니다. 생략된 경우 CLI는 체크 아웃 경로에서 자동 검색을 시도하며, 불가능하면 https://github.com/이 기본적으로 사용됩니다.

패키지 관리자를 구성하는 옵션

`--registries-auth-stdin`

GitHub Enterprise Server 컨테이너 레지스트리에 인증하기 위해 <registry_url>=<token> 쌍을 쉼표로 구분한 목록을 전달합니다.

예를 들어, https://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2을 전달하여 두 개의 GitHub Enterprise Server 인스턴스에 인증할 수 있습니다.

이는 CODEQL_REGISTRIES_AUTH 및 GITHUB_TOKEN 환경 변수를 재정의합니다. github.com 컨테이너 레지스트리 인증만 필요한 경우 --github-auth-stdin 옵션을 사용하여 간편하게 인증할 수 있습니다.

Windows 추적을 구성하는 옵션

`--trace-process-name=<process-name>`

          \[Windows만 해당] 추적을 초기화하는 경우 이름이 이 인수와 일치하는 CodeQL CLI의 부모 프로세스에 추적기를 삽입합니다. 이름이 동일한 부모 프로세스가 여러 개 있는 경우 프로세스 트리에서 가장 낮은 위치의 프로세스가 선택됩니다. 이 옵션은 `--trace-process-level`을 재정의합니다. 그러므로 두 옵션이 모두 전달되면 이 옵션만 사용됩니다.

`--trace-process-level=<process-level>`

          \[Windows만 해당] 추적을 초기화하는 경우 현재 프로세스보다 상위인 부모 프로세스에 추적기를 삽입합니다. 0은 CodeQL CLI를 호출하는 프로세스를 의미합니다. 인수가 전달되지 않으면 CLI의 기본 동작은 호출 프로세스의 부모에 삽입하는 것입니다. 단, GitHub Actions 및 Azure Pipelines는 상황에 따라 적용됩니다.

간접 빌드 추적을 구성하는 옵션

`--no-tracing`

          \[고급] 지정된 명령을 추적하면 안 됩니다. 대신 필요한 모든 데이터를 직접 생성하도록 의존해야 합니다.

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

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

추출기 동작을 제어하는 옵션: 간접 추적 환경에만 적용됨

`-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 파일(extension .json) 또는 YAML 파일(extension .yaml 또는 .yml)로, 추출기 옵션을 설정합니다. 파일에는 최상위 맵 키 '추출기'가 있어야 하며, 그 아래에는 추출기 이름이 두 번째 수준의 맵 키로 있어야 합니다. 추가적인 수준의 맵은 중첩된 추출기 그룹을 의미하며, 문자열 및 배열 옵션은 문자열 및 배열 값이 있는 맵 항목입니다.

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

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

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

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

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

`--logdir=<dir>`

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

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

`--common-caches=<dir>`

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

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

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

이 문서의 내용