데이터베이스 만들기

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

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

개요

Shell

codeql database create [--language=<lang>[,<lang>...]] [--github-auth-stdin] [--github-url=<url>] [--source-root=<dir>] [--threads=<num>] [--ram=<MB>] [--command=<command>] [--extractor-option=<extractor-option-name=value>] <options>... -- <database>

codeql database create [--language=<lang>[,<lang>...]] [--github-auth-stdin] [--github-url=<url>] [--source-root=<dir>] [--threads=<num>] [--ram=<MB>] [--command=<command>] [--extractor-option=<extractor-option-name=value>] <options>... -- <database>

설명

CodeQL 제품 중 하나를 사용하여 분석할 수 있는 원본 트리에 대한 CodeQL 데이터베이스를 만듭니다.

옵션

기본 옵션

`<database>`

[필수] 만들 CodeQL 데이터베이스의 경로입니다. 이 디렉터리가 만들어지고 아직 존재하지 않아야 합니다(하지만 해당 부모는 반드시 존재해야 합니다).

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

이 디렉터리가 빌드 프로세스에게 방해받을 위치에 있지 않은 것이 중요합니다. 예를 들어 Maven 프로젝트의 target 디렉터리가 적합하지 않을 수 있습니다.

`--[no-]overwrite`

[고급] 데이터베이스가 이미 있는 경우 데이터베이스를 삭제하고 중단하는 대신 이 명령을 계속 진행합니다. 디렉터리가 있지만 데이터베이스처럼 보이지 않는 경우 오류가 발생합니다.

`--[no-]force-overwrite`

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

`--codescanning-config=<file>`

[고급] CodeQL 데이터베이스를 만드는 방법과 이후 단계에서 실행할 쿼리에 대한 옵션을 지정하는 코드 검색 구성 파일을 읽습니다. 이 구성 파일의 형식에 대한 자세한 내용은 코드 검색을 위한 고급 설정 사용자 지정을 참조하세요. 이후 단계에서 이 파일에서 쿼리를 실행하려면 지정된 다른 쿼리 없이 codeql 데이터베이스 분석을 호출합니다.

`--[no-]db-cluster`

단일 데이터베이스를 만드는 대신 다양한 언어에 대한 데이터베이스의 "클러스터"를 만듭니다. 각 데이터베이스는 명령줄에 지정된 디렉터리의 하위 디렉터리입니다.

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

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

codeql 확인 언어를 사용하여 검색 경로에 있는 플러그형 언어 추출기 목록을 가져옵니다.

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

이 옵션을 생략하고 분석 중인 원본 루트가 GitHub 리포지토리의 검사인 경우, CodeQL CLI는 GitHub API를 호출하여 분석할 언어를 자동으로 결정하려고 시도합니다. 이렇게 하려면 환경 변수 GITHUB_토큰 또는 --github-auth-stdin 옵션을 사용하여 표준 입력을 통해 GitHub PAT 토큰을 제공해야 합니다.

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

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

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

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

가져오기 작업에 많은 스레드를 사용하고 호출된 빌드 명령에 힌트로 전달합니다.

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

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

가져오기 작업에 많은 스레드를 사용하고 호출된 빌드 명령에 힌트로 전달합니다.

`-c, --command=<command>`

컴파일된 언어의 경우, 소스 코드에서 컴파일러를 호출하여 분석하도록 하는 명령을 빌드합니다. 이러한 명령은 생성된 코드 및(경우에 따라) 표준 라이브러리를 분석할 수 있는 계측 환경에서 실행됩니다.

빌드 명령이 지정되지 않은 경우, 명령은 선택한 언어 팩의 추론에 따라 원본 트리를 빌드하는 방법을 자동으로 파악하려고 시도합니다.

여러 언어의 일부 조합을 지정하려면 명시적 빌드 명령이 _필요_합니다.

`--no-cleanup`

[고급] 종료 후 모든 데이터베이스 정리를 표시하지 않습니다. 디버깅 용도로 유용합니다.

`--no-pre-finalize`

[고급] 활성 CodeQL 추출기에서 지정한 사전 종료 스크립트를 건너뜁니다.

`--[no-]skip-empty`

[고급] 빌드 중에 소스 코드가 표시되지 않아 데이터베이스가 비어 있는 경우, 실패하는 대신 경고를 출력합니다. 빈 데이터베이스는 고정되지 않은 상태로 남아 있습니다.

`--[no-]linkage-aware-import`

[고급] codeql 데이터 세트 가져오기가 연결 인식 (기본값) 인지 여부를 제어합니다. 데이터베이스 만들기의 이 부분이 너무 많은 메모리를 사용하는 프로젝트에서 이 옵션을 사용하지 않도록 설정하면 데이터베이스 완성도를 낮추는 대신 작업을 진행하는 데 도움이 될 수 있습니다.

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

기준 계산 옵션

`--[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`

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

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

이렇게 하면 CODEQL_REGISTRIES_AUTH 및 GITHUB_TOKEN 환경 변수가 재정의됩니다. github.com 컨테이너 레지스트리에만 인증해야 하는 경우 더 간단한 --github-auth-stdin 옵션을 사용하여 인증할 수 있습니다.

하위 수준 데이터 세트 정리 옵션

`--max-disk-cache=<MB>`

중간 쿼리 결과에 대해 디스크 캐시가 사용할 수 있는 최대 공간을 설정합니다.

이 크기가 명시적으로 구성되지 않은 경우 평가기는 데이터 세트의 크기와 쿼리의 복잡성에 따라 "합리적인" 양의 캐시 공간을 사용하려고 합니다. 이 기본 사용량보다 높은 한도를 명시적으로 설정하면 추가 캐싱이 가능해지므로 이후 쿼리의 속도를 높일 수 있습니다.

`--min-disk-free=<MB>`

[고급] 파일 시스템에서 사용 가능한 공간의 목표량을 설정합니다.

--max-disk-cache가 지정되지 않은 경우 파일 시스템의 사용 가능한 공간이 이 값 아래로 떨어지면 평가기는 디스크 캐시 사용량을 줄이려고 노력합니다.

`--min-disk-free-pct=<pct>`

[고급] 파일 시스템에서 사용 가능한 공간의 목표 비율을 설정합니다.

--max-disk-cache가 지정되지 않은 경우 파일 시스템의 사용 가능한 공간이 이 백분율 아래로 떨어지면 평가기는 디스크 캐시 사용량을 줄이려고 노력합니다.

`--cache-cleanup=<mode>`

캐시를 트리밍하는 방법을 적극적으로 선택합니다. 다음을 선택할 수 있습니다.

clear: 새로 추출된 데이터 세트의 상태로 트리밍하여 전체 캐시를 제거합니다.

trim(기본값): 명시적으로 "캐시된" 조건자를 제외한 모든 항목을 트리밍합니다.

fit: 디스크 캐시에 대해 정의된 크기 제한이 관찰되어 필요한 만큼 중간을 삭제해야 합니다.

`--cleanup-upgrade-backups`

데이터베이스 업그레이드로 인해 발생하는 백업 디렉터리를 삭제합니다.

추적 옵션

`--no-tracing`

[고급] 지정된 명령을 추적하지 말고 필요한 모든 필수 데이터를 직접 생성합니다.

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

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

빌드 명령 사용자 지정 옵션

`--working-dir=<dir>`

[고급] 지정된 명령을 실행해야 하는 디렉터리입니다. 이 인수가 제공되지 않으면 명령이 codeql 데이터베이스 만들기에 전달된 --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 데이터베이스 init 또는 codeql database begin-tracing에 전달되면 옵션이 간접 추적 환경에만 적용됩니다. 워크플로에서 codeql 데이터베이스 추적 명령을 호출하는 경우, 원하는 경우의 옵션도 전달해야 합니다.

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

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

이 문서의 내용