сведения о bqrs

Note

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

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

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

Shell

codeql bqrs info <options>... -- <file>

codeql bqrs info <options>... -- <file>

Эта команда отображает обзор данных, содержащихся в сжатом двоичном BQRS-файле, который является результатом выполнения запроса. В нем показаны имена и размеры каждого результирующий набор (таблица) в файле BQRS, а также типы столбцов каждого результирующий набор.

Он также может дополнительно предварительно компетировать смещения для использования параметров разбиения на страницы декодирования codeql bqrs. Это в основном полезно для подключаемых модулей интегрированной среды разработки.

Параметры

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

`<file>`

[Обязательный] файл BQRS для отображения сведений о ней.

`--format=<fmt>`

Выберите выходной формат либо (по умолчанию),_ либо text _json.

Поддержка разбиения на страницы в декодировании bqrs codeql

`--paginate-rows=<num>`

[Advanced] При указании вместе --format=jsonс ним вычислите таблицу смещения байтов, которые позже могут быть предоставлены --start-at параметру декодации bqrs codeql, для запуска потоковой передачи результатов на позициях 0,<num>__ 2*<num> и т. д.

`--paginate-result-set=<name>`

[Расширенный] Только процесс --paginate-rows для результирующих наборов с таким именем. (Если имя не соответствует результирующему набору, --paginate-rows то это no-op.

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

`-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.

Кто может использовать эту функцию?

В этой статье