Note
Это содержимое описывает последний выпуск данных CodeQL CLI. Дополнительные сведения об этом выпуске см. в статье https://github.com/github/codeql-cli-binaries/releases.
Чтобы просмотреть сведения о параметрах, доступных для этой команды в предыдущем выпуске, выполните команду с --help параметром в терминале.
Краткие сведения
codeql query run (--database=<database> | --dataset=<dataset>) [--output=<file.bqrs>] [--threads=<num>] [--ram=<MB>] <options>... -- <file.ql>
codeql query run (--database=<database> | --dataset=<dataset>) [--output=<file.bqrs>] [--threads=<num>] [--ram=<MB>] <options>... -- <file.ql>
Description
Выполните один запрос.
Эта команда выполняет один запрос к базе данных CodeQL или необработанным набору данных QL.
По умолчанию результат запроса будет отображаться в терминале в понятной отрисовке. Если вы хотите выполнить дальнейшую обработку результатов, настоятельно рекомендуется использовать --output параметр для записи результатов в файл в промежуточном двоичном формате, который затем можно распаковывать в различные более машинные представления с помощью декодации codeql bqrs.
Если запрос создает результаты в форме, которая может быть интерпретирована как оповещения исходного кода, можно найти , что база данных codeql анализирует более удобный способ его выполнения. В частности, анализ базы данных codeql может производить выходные данные в формате SARIF, который можно использовать с различными средствами просмотра оповещений.
Сведения о параллельном выполнении нескольких запросов см. в разделе run-queries базы данных codeql.
Параметры
Основные параметры
<file.ql>
[Обязательный] источник QL для выполнения запроса.
-o, --output=<file.bqrs>
Файл, в который будет записан результат запроса, будет записан в формате BQRS.
Параметры выбора запроса
Необходимо задать именно один из этих вариантов.
-d, --database=<database>
Путь к базе данных CodeQL для запроса.
--dataset=<dataset>
[Дополнительно] Путь к необработанному набору данных QL для запроса.
Параметры управления вычислителем запросов
--[no-]tuple-counting
[Дополнительно] Отображение счетчиков кортежей для каждого шага оценки в журналах оценщика запросов. Если этот --evaluator-log параметр указан, количество кортежей будет включено как в текстовые, так и структурированные журналы JSON, созданные командой. (Это может быть полезно для оптимизации производительности сложного кода QL.