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

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

개요

Shell

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

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

Description

          \[실험적] 실패한 분석에 대하여 데이터베이스에서 진단 정보를 내보냅니다.

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

Options

기본 옵션

`<database>`

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

          `--db-cluster` 옵션이 지정되면 이는 데이터베이스 자체가 아니라, 데이터베이스들을 _포함하는_ 디렉터리이며, 해당 데이터베이스들은 모두 함께 처리될 것입니다.

`--format=<format>`

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

          `raw`: JSON 객체들로서, 원시의 해석되지 않은 진단 메시지들의 목록입니다.

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

          `sarifv2.1.0`: SARIF v2.1.0입니다.

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

`--[no-]db-cluster`

명령줄에 지정된 디렉터리는 데이터베이스 자체가 아니라, 구성 중인 하나 이상의 데이터베이스를 포함하는 디렉터리를 의미합니다. 이러한 데이터베이스들은 함께 처리됩니다.

`--sarif-exit-code=<sarifExitCode>`

          \[SARIF 형식 전용] 오류가 발생한 프로세스의 종료 코드입니다.

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

          \[SARIF 형식 전용] 오류가 발생한 프로세스가 종료된 이유입니다.

`--sarif-category=<category>`

          \[SARIF 형식 전용] \[권장] SARIF 출력에 포함시키기 위하여 이 분석의 범주를 지정합니다. 범주는 동일한 커밋과 리포지토리에서 수행되지만, 수행되는 언어나 코드 부분이 서로 다른 여러 분석을 구분하는 데 사용됩니다.

코드베이스의 동일한 버전을 여러 가지 방법으로 분석하는 경우(예: 다른 언어로 분석), 코드 검사에서 결과를 프레젠테이션을 위해 GitHub에 업로드할 때, 이 값은 각 분석마다 달라야 합니다. 이 값은 코드 검사에서 각 분석이 서로를 _대체_하지 않고 _보완_한다는 것을 의미합니다. (값은 코드 베이스의 서로 다른 버전들에 대해 동일한 분석을 수행하는 동안 일관적이어야 합니다.)

이 값은 <run>.automationDetails.id 속성으로 표시됩니다(후행 슬래시가 아직 없다면 추가됩니다.).

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

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

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

`--logdir=<dir>`

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

(로그 파일 이름을 직접 작성하려면 대신 --log-to-stderr를 사용하고 stderr를 원하는 위치로 리디렉션하세요.)

`--common-caches=<dir>`

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

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

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

이 기사에서

개요

Description

Options

기본 옵션

`<database>`

`--format=<format>`

`--[no-]db-cluster`

`-o, --output=<output>`

`--sarif-exit-code=<sarifExitCode>`

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

`--sarif-category=<category>`

일반 옵션

`-h, --help`

`-J=<opt>`

`-v, --verbose`

`-q, --quiet`

`--verbosity=<level>`

`--logdir=<dir>`

`--common-caches=<dir>`