диагностика надстроек базы данных

Note

Это содержимое описывает последний выпуск данных CodeQL CLI. Дополнительные сведения об этом выпуске см. в статье https://github.com/github/codeql-cli-binaries/releases.

Чтобы просмотреть сведения о параметрах, доступных для этой команды в предыдущем выпуске, выполните команду с --help параметром в терминале.

Краткие сведения

Shell

codeql database add-diagnostic --source-id=<id> --source-name=<name> <options>... -- <database>

codeql database add-diagnostic --source-id=<id> --source-name=<name> <options>... -- <database>

Description

[Экспериментальный] Добавьте часть диагностических сведений в базу данных.

Доступно с момента v2.12.6.

Параметры

Основные параметры

`<database>`

[Обязательный] Путь к базе данных CodeQL для упаковки.

`--markdown-message=<markdownMessage>`

Сообщение для диагностики в формате Markdown с вкусом GitHub.

`--plaintext-message=<plaintextMessage>`

Сообщение для диагностики в виде обычного текста. Этот параметр следует использовать только при заполнении сообщения Markdown с сообщением --markdown-message не является практическим.

`--severity=<severity>`

Серьезность диагностики. Может быть "error", "warning" или "note".

`--help-link=<helpLinks>`

Справочные ссылки, относящиеся к диагностике.

`--attributes-json=<attributesJson>`

Структурированные метаданные, относящиеся к диагностике.

Параметры, указывающие, где можно отобразить диагностическое сообщение

`--ready-for-status-page`

Укажите, что диагностика подходит для отображения на странице состояния.

`--ready-for-cli-summary-table`

Укажите, что диагностика подходит для отображения в таблице сводки диагностика, напечатанной такими database analyzeкомандами.

Параметры, описывающие источник диагностики

`--source-id=<id>`

[Обязательный] Идентификатор источника этой диагностики.

`--source-name=<name>`

[Обязательный] Описание источника этой диагностики, доступное для чтения человеком.

`--extractor-name=<extractorName>`

Имя средства извлечения CodeQL, если эта диагностика была создана методом извлечения CodeQL.

Параметры, описывающие расположение диагностики

`--file-path=<file>`

Путь к файлу, к которому применяется диагностика, относительно корневого каталога источника.

`--start-line=<startLine>`

Номер строки на основе 1 (включительно), где начинается расположение диагностики.

`--start-column=<startColumn>`

Номер столбца на основе 1 (включительно), где начинается расположение диагностики.

`--end-line=<endLine>`

Номер строки на основе 1 (включительно), где заканчивается расположение диагностики.

`--end-column=<endColumn>`

Номер столбца на основе 1 (включительно), где заканчивается расположение диагностики.

Распространенные параметры

`-J=<opt>`

[Дополнительно] Укажите параметр JVM, выполняя команду.

(Убедитесь, что параметры, содержащие пробелы, не будут обрабатываться правильно.)

`-v, --verbose`

Постепенно увеличьте число отображаемых сообщений о ходе выполнения.

`-q, --quiet`

Постепенно уменьшайте количество отображаемых сообщений о ходе выполнения.

`--verbosity=<level>`

[Дополнительно] Явным образом задайте уровень детализации на одну из ошибок, предупреждений, хода выполнения, хода выполнения+, хода выполнения++, хода выполнения+++. Переопределяет -v и -q.

`--logdir=<dir>`

[Дополнительно] Запись подробных журналов в один или несколько файлов в указанном каталоге с созданными именами, включающими метки времени и имя выполняющегося подкоманда.

(Чтобы записать файл журнала с именем, над которым у вас есть полный контроль, вместо этого предоставьте --log-to-stderr и перенаправите stderr по мере необходимости.)

[Дополнительно] Управляет расположением кэшированных данных на диске, которые будут сохраняться между несколькими запусками интерфейса командной строки, такими как скачанные пакеты QL и скомпилированные планы запросов. Если этот параметр не задан явным образом, по умолчанию используется каталог с именем .codeql в домашнем каталоге пользователя; он будет создан, если он еще не существует.

Доступно с момента v2.15.2.