В этом материале описывается последний выпуск Интерфейса командной строки CodeQL. Дополнительные сведения об этом выпуске см. в разделе https://github.com/github/codeql-cli-binaries/releases.
Чтобы просмотреть сведения о параметрах, доступных для этой команды в более раннем выпуске, выполните команду с параметром в терминале --help .
Краткий обзор
codeql bqrs decode [--output=<file>] [--result-set=<name>] [--sort-key=<col>[,<col>...]] <options>... -- <file>Описание
Преобразование результирующих данных из BQRS в другие формы.
Декодированные выходные данные будут записаны в стандартные выходные --output данные, если не указан параметр .
Основные параметры
<file>
[Обязательный] файл BQRS для декодирования.
-o, --output=<file>
Файл, в который записываются нужные выходные данные.
-r, --result-set=<name>
Выберите определенный результирующий набор из файла BQRS для декодирования. Доступные наборы результатов можно перечислить с помощью codeql bqrs info.
Если результирующий набор не выбран, все результирующие наборы будут декодированы при условии, что выбранный формат вывода и параметры обработки поддерживают это. В противном случае возникает ошибка.
-k, --sort-key=<col>[,<col>...]
Сортируйте выбранный результирующий набор по указанным столбцам.
--sort-direction=<direction>[,<direction>...]
Сортируйте выбранный результирующий набор, используя указанные направления сортировки.
Если маршруты сортировки не указаны, для всех столбцов будет использоваться порядок по возрастанию.
Параметры формата вывода
--format=<fmt>
Выберите формат вывода. Можно выбрать:
text(по умолчанию): удобочитаемая таблица обычного текста.
csv: значения, разделенные запятыми.
json: потоковая передача JSON.
bqrs: BQRS. Его необходимо использовать с --output. Наиболее полезно вместе с --sort-key.
--no-titles
Пропуск заголовков столбцов для text форматов и csv
--entities=<fmt>[,<fmt>...]
[Дополнительно] Управление отображением результирующих столбцов типа сущности. Разделенный запятыми список следующих вариантов:
url: URL-адрес, ссылающийся на исходное расположение, если запрос был скомпилирован для создания таких URL-адресов для типов сущностей.
string: строка, вычисленная методом toString() в QL, если запрос был скомпилирован для создания таких строк для столбца.
id: внутренний идентификатор сущности, который может быть неинформативным.
all: отображаются столбцы со всеми сведениями, которые предоставляет файл BQRS.
Отображаются все выбранные параметры, если это возможно.
Параметры разбиения на страницы (для использования интерактивными интерфейсами)
--rows=<num>
[Дополнительно] Выводит это количество строк из выбранного набора результатов, начиная с верхней части или в расположении, заданном параметром --start-at.
--start-at=<offset>
[Дополнительно] Начните печать строки, определенной с определенным смещением байтов в BQRS-файле. Смещение должно быть получено из сведений codeql bqrs или из указателя "next", найденного в выходных данных JSON из предыдущего вызова с --rows набором. Другие смещения, скорее всего, будут создавать невразумные выходные данные и (или) явные ошибки.
Всегда должен использоваться вместе с --rowsи несовместим с --sort-key.
Общие параметры
-h, --help
Показать этот текст справки.
-J=<opt>
[Дополнительно] Предоставьте параметр виртуальной машине JVM, выполняющую команду .
(Остерегайтесь, что параметры, содержащие пробелы, будут обрабатываться неправильно.)
-v, --verbose
Постепенно увеличивайте количество выводемых сообщений о ходе выполнения.
-q, --quiet
Постепенно уменьшайте количество выводемых сообщений о ходе выполнения.
--verbosity=<level>
[Дополнительно] Явно задайте уровень детализации для одной из ошибок, предупреждений, progress, progress+, progress++, progress+++. Переопределяет -v и -q.
--logdir=<dir>
[Дополнительно] Запись подробных журналов в один или несколько файлов в указанном каталоге с созданными именами, включающими метки времени и имя выполняющейся подкоманды.
(Чтобы записать файл журнала с именем, над которым у вас есть полный контроль, вместо этого при необходимости предоставьте --log-to-stderr и перенаправьте stderr.)