Note
Это содержимое описывает последний выпуск данных CodeQL CLI. Дополнительные сведения об этом выпуске см. в статье https://github.com/github/codeql-cli-binaries/releases.
Чтобы просмотреть сведения о параметрах, доступных для этой команды в предыдущем выпуске, выполните команду с --help параметром в терминале.
Краткие сведения
codeql dataset check <options>... -- <dataset>
codeql dataset check <options>... -- <dataset>
Description
[Сантехника] Проверьте определенный набор данных для внутренней согласованности.
Эта команда чаще всего полезна разработчикам средств извлечения 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>
[Дополнительно] Явным образом задайте уровень детализации на одну из ошибок, предупреждений, хода выполнения, хода выполнения+, хода выполнения++, хода выполнения+++. Переопределяет -v и -q.
--logdir=<dir>
[Дополнительно] Запись подробных журналов в один или несколько файлов в указанном каталоге с созданными именами, включающими метки времени и имя выполняющегося подкоманда.
(Чтобы записать файл журнала с именем, над которым у вас есть полный контроль, вместо этого предоставьте --log-to-stderr и перенаправите stderr по мере необходимости.)
--common-caches=<dir>
[Дополнительно] Управляет расположением кэшированных данных на диске, которые будут сохраняться между несколькими запусками интерфейса командной строки, такими как скачанные пакеты QL и скомпилированные планы запросов. Если этот параметр не задан явным образом, по умолчанию используется каталог с именем .codeql в домашнем каталоге пользователя; он будет создан, если он еще не существует.
Доступно с момента v2.15.2.