В этом материале описывается последний выпуск Интерфейса командной строки CodeQL. Дополнительные сведения об этом выпуске см. в разделе https://github.com/github/codeql-cli-binaries/releases.
Чтобы просмотреть сведения о параметрах, доступных для этой команды в более раннем выпуске, выполните команду с параметром в терминале --help
.
Краткий обзор
codeql dataset check <options>... -- <dataset>
Описание
[Сантехника] Проверьте определенный набор данных на наличие внутренней согласованности.
Эта команда чаще всего полезна разработчикам средств извлечения CodeQL, так как она проверяет данные, созданные методом извлечения. Это также может быть полезно, если запросы к базе данных дают несогласованные результаты, чтобы исключить проблемы в базовых данных в качестве причины.
Основные параметры
<dataset>
[Обязательно] Путь к необработанному набору данных QL для проверка.
--failing-exitcode=<code>
[Дополнительно] Задайте код выхода для создания при возникновении каких-либо сбоев. Обычно 1, но средства, которые анализирует выходные данные, могут оказаться полезными, чтобы задать для него значение 0.
--format=<fmt>
Выберите формат вывода. Возможные варианты.
text
(по умолчанию): удобочитаемая текстовая отрисовка.
json
: потоковый массив объектов JSON.
jsonz
: поток объектов JSON, завершаемых с нуля.
--[no-]precise-locations
[Дополнительно] Затрачиваем дополнительные усилия на вычисление точных расположений на наличие несоответствий. Это займет больше времени, но может упростить отладку поведения средства извлечения.
--max-resolve-depth=<n>
[Дополнительно] Максимальная глубина, до которой должны быть разрешены идентификаторы, чтобы объяснить несоответствия. (По умолчанию: 3)
--max-errors-per-checker=<n>
Максимальное количество ошибок несоответствия каждого типа, о которых следует сообщать явным образом. (значение по умолчанию: 5)
Общие параметры
-h, --help
Показать этот текст справки.
-J=<opt>
[Дополнительно] Предоставьте параметр виртуальной машине JVM, выполняющую команду .
(Остерегайтесь, что параметры, содержащие пробелы, будут обрабатываться неправильно.)
-v, --verbose
Постепенно увеличивайте количество выводемых сообщений о ходе выполнения.
-q, --quiet
Постепенно уменьшайте количество выводемых сообщений о ходе выполнения.
--verbosity=<level>
[Дополнительно] Явно задайте уровень детализации для одной из ошибок, предупреждений, progress, progress+, progress++, progress+++. Переопределяет -v
и -q
.
--logdir=<dir>
[Дополнительно] Запись подробных журналов в один или несколько файлов в указанном каталоге с созданными именами, включающими метки времени и имя выполняющейся подкоманды.
(Чтобы записать файл журнала с именем, над которым у вас есть полный контроль, вместо этого при необходимости предоставьте --log-to-stderr
и перенаправьте stderr.)