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