데이터베이스 내보내기-진단

개요

codeql database export-diagnostics --format=<format> [--output=<output>] <options>... -- <database>

Description

[실험적] 실패한 분석을 위해 데이터베이스에서 진단 정보를 내보냅니다.

이후 v2.12.6사용할 수 있습니다.

기본 옵션

<database>

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

--db-cluster 옵션을 지정하면 데이터베이스 자체가 아니라 데이터베이스를 포함하는 디렉터리가 되며 이러한 모든 데이터베이스가 함께 처리됩니다.

--format=<format>

[필수] 결과를 작성할 형식입니다. 다음 중 하나:

raw: JSON 개체로 해석되지 않은 원시 진단 메시지 목록입니다.

sarif-latest: 정적 분석 결과를 설명하기 위한 JSON 기반 형식인 SARIF(정적 분석 결과 교환 형식)입니다. 이 형식 옵션은 가장 최근에 지원되는 버전(v2.1.0)을 사용합니다. 이 옵션은 서로 다른 CodeQL 버전 간에 서로 다른 버전의 SARIF를 생성하기 때문에 자동화에 사용하기에 적합하지 않습니다.

sarifv2.1.0: SARIF v2.1.0.

text: 진단 메시지의 글머리 기호 목록입니다.

--[no-]db-cluster

명령줄에 지정된 디렉터리가 데이터베이스 자체가 아니라 생성 중인 하나 이상의 데이터베이스를 포함하는 디렉터리임을 나타냅니다. 이러한 데이터베이스는 함께 처리됩니다.

-o, --output=<output>

진단 정보를 쓸 출력 경로입니다.

--sarif-exit-code=<sarifExitCode>

[SARIF 형식만] 실패한 프로세스의 종료 코드입니다.

--sarif-exit-code-description=<sarifExitCodeDescription>

[SARIF 형식만] 실패한 프로세스가 종료된 이유입니다.

--sarif-category=<category>

[SARIF 형식만] SARIF 출력에 포함할 이 분석의 범주를 지정합니다. 범주를 사용하여 동일한 커밋 및 리포지토리에서 수행되는 여러 분석을 서로 다른 언어 또는 코드의 다른 부분에서 구분할 수 있습니다.

여러 가지 방법으로 동일한 버전의 코드 베이스를 분석하고(예: 다른 언어의 경우) 코드 검사에서 프레젠테이션을 위해 결과를 GitHub에 업로드하는 경우 이 값은 각 분석 간에 달라야 합니다. 이 값은 코드 검사에서 분석이 서로를 대체하지 않고 보완한다는 것을 알려 줍니다. (값은 코드 베이스의 다른 버전에 대해 동일한 분석의 실행 간에 일치해야 합니다.)

이 값은 SARIF v1의 <run>.automationId 속성, SARIF v2의 <run>.automationLogicalId 속성, SARIF v2.1.0의 <run>.automationDetails.id 속성으로 표시됩니다(아직 없는 경우 후행 슬래시가 추가됨).

일반 옵션

-h, --help

이 도움말 텍스트를 표시합니다.

-J=<opt>

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

(공백을 포함하는 옵션이 올바르게 처리되지 않도록 주의하세요.)

-v, --verbose

인쇄된 진행률 메시지 수를 증분 방식으로 늘입니다.

-q, --quiet

인쇄되는 진행률 메시지 수를 증분 방식으로 줄입니다.

--verbosity=<level>

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

--logdir=<dir>

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

(이름을 가진 로그 파일을 작성하려면 모든 권한을 부여 --log-to-stderr 하고 원하는 대로 stderr를 리디렉션합니다.)