{"meta":{"title":"Bqrs интерпретирует","intro":"[Сантехника] Интерпретация данных в одном BQRS.","product":"Безопасность и качество кода","breadcrumbs":[{"href":"/ru/code-security","title":"Безопасность и качество кода"},{"href":"/ru/code-security/reference","title":"Reference"},{"href":"/ru/code-security/reference/code-scanning","title":"Проверка кода"},{"href":"/ru/code-security/reference/code-scanning/codeql","title":"CodeQL"},{"href":"/ru/code-security/reference/code-scanning/codeql/codeql-cli-manual","title":"Руководство по cli CodeQL"},{"href":"/ru/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-interpret","title":"Bqrs интерпретирует"}],"documentType":"article"},"body":"# Bqrs интерпретирует\n\n[Сантехника] Интерпретация данных в одном BQRS.\n\n> [!NOTE]\n> Это содержимое описывает последний выпуск данных CodeQL CLI. Дополнительные сведения об этом выпуске см. в статье https://github.com/github/codeql-cli-binaries/releases.\n>\n> Чтобы просмотреть сведения о параметрах, доступных для этой команды в предыдущем выпуске, выполните команду с <span style=\"white-space: nowrap;\">`--help`</span> параметром в терминале.\n\n## Synopsis\n\n```shell copy\ncodeql bqrs interpret --format=<format> --output=<output> -t=<String=String> [--threads=<num>] [--source-archive=<sourceArchive>] [--source-location-prefix=<sourceLocationPrefix>] <options>... -- <bqrs-file>\n```\n\n## Description\n\n              \\[Сантехника] Интерпретирует данные в одном BQRS.\n\nКоманда, которая интерпретирует один файл BQRS в соответствии с предоставленными метаданными и создает выходные данные в указанном формате.\n\n## Options\n\n### Основные параметры\n\n#### `<bqrs-file>`\n\n              \\[Обязательный] Файл BQRS для интерпретации.\n\n#### `--format=<format>`\n\n              \\[Обязательный] Формат, в котором нужно записать результаты. Одно из:\n\n              `csv`: форматированные значения, разделенные запятыми, включая столбцы с метаданными правила и оповещения.\n\n              `sarif-latest`: формат обмена статическими результатами анализа (SARIF), формат на основе JSON для описания результатов статического анализа. Этот параметр формата использует последнюю поддерживаемую версию (версии 2.1.0). Этот параметр не подходит для использования в автоматизации, так как он создает разные версии SARIF между различными версиями CodeQL.\n\n              `sarifv2.1.0`: SARIF версии 2.1.0.\n\n              `graphtext`: текстовый формат, представляющий граф. Совместим только с запросами с графом @kind .\n\n              `dgml`: язык разметки графа, формат на основе XML для описания графов. Совместим только с запросами с графом @kind .\n\n              `dot`: язык Graphviz DOT, текстовый формат для описания графов.\nСовместим только с запросами с графом @kind .\n\n#### `-o, --output=<output>`\n\n              \\[Обязательный] Выходной путь для записи результатов. Для форматов графов это должен быть каталог, а результат (или результаты, если эта команда поддерживает интерпретацию нескольких запросов) будут записаны в этом каталоге.\n\n#### `-t=<String=String>`\n\n              \\[Обязательно] Пара значений ключа метаданных запроса. Повторите для каждого фрагмента метаданных. Необходимо указать по крайней мере ключи \"kind\" и \"id\". Ключи не нужно префиксировать с @помощью .\n\n#### `--max-paths=<maxPaths>`\n\nМаксимальное количество путей для каждого оповещения с путями.\n(По умолчанию: 4)\n\n#### `--[no-]sarif-add-file-contents`\n\n              \\[Форматы SARIF] Включите полное содержимое файла для всех файлов, на которые ссылается по крайней мере один результат.\n\n#### `--[no-]sarif-add-snippets`\n\n              \\[Форматы SARIF] Включите фрагменты кода для каждого расположения, указанного в результатах, с двумя строками контекста до и после указанного расположения.\n\n#### `--[no-]sarif-add-query-help`\n\n              \\[Форматы SARIF] Нерекомендуемые \\[] Включите справку по запросу Markdown для всех запросов. Он загружает справку по запросу /path/to/query.ql из файла /path/to/query.md. Если этот флаг не предоставляется по умолчанию, необходимо включить справку только для пользовательских запросов, т. е. тех, которые находятся в пакетах запросов, которые не относятся к коду формы\\`/lang\\<rt;-querys\\&\\`. Этот параметр не действует при передаче в кодql bqrs интерпретации.\n\n#### `--sarif-include-query-help=<mode>`\n\n              \\[Форматы SARIF] Укажите, следует ли включать справку по запросу в выходные данные SARIF. Одно из:\n\n              `always`: включите справку по запросу для всех запросов.\n\n              `custom_queries_only`\n              _(по умолчанию)_: включите справку запроса только для пользовательских запросов, т. е. тех, которые находятся в пакетах запросов, которые не относятся к \\`коде формы/\\<lang\\&rt;-querys\\`.\n\n              `never`: не включать справку по запросу для каких-либо запросов.\n\nЭтот параметр не действует при передаче в кодql bqrs интерпретации.\n\nДоступно с момента `v2.15.2`.\n\n#### `--no-sarif-include-alert-provenance`\n\n              \\[\n              \\[Расширенные форматы SARIF] Не включайте сведения о происхождении оповещений в выходные данные SARIF.\n\nДоступно с момента `v2.18.1`.\n\n#### `--[no-]sarif-group-rules-by-pack`\n\n              \\[Форматы SARIF] Поместите объект правила для каждого запроса в соответствующий пакет QL в свойстве `<run>.tool.extensions` . Этот параметр не действует при передаче в кодql bqrs интерпретации.\n\n#### `--[no-]sarif-multicause-markdown`\n\n              \\[Форматы SARIF] Только для оповещений с несколькими причинами включите их в виде элемента, отформатированного Markdown, в выходные данные в дополнение к обычной строке.\n\n#### `--no-sarif-minify`\n\n              \\[Только форматы SARIF] Создание довольно печатных выходных данных SARIF. По умолчанию выходные данные SARIF минимируются, чтобы уменьшить размер выходного файла.\n\n#### `--sarif-run-property=<String=String>`\n\n              \\[Форматы SARIF] Пара значений ключа, добавляемая в созданный контейнер свойств SARIF \"run\". Может повторяться.\n\n#### `--no-group-results`\n\n              \\[Форматы SARIF] Создает один результат для каждого сообщения, а не один результат на уникальное расположение.\n\n#### `--csv-location-format=<csvLocationFormat>`\n\nФормат, в котором создаются расположения в выходных данных CSV. Один из: URI, строка столбца, длина смещения. (По умолчанию: line-column)\n\n#### `--dot-location-url-format=<dotLocationUrlFormat>`\n\nСтрока формата, определяющая формат, в котором создаются URL-адреса расположения файлов в выходных данных DOT. Следующие держатели мест можно использовать {path} {start:line} {start:column} {end:line} {end:column}, {offset}, {length}\n\n#### `--[no-]sublanguage-file-coverage`\n\n              \\[GitHub.com и GitHub Enterprise Server версии 3.12.0+ используйте сведения о охвате вложенных файлов. Это вычисляет, отображает и экспортирует отдельные сведения о охвате файлов для языков, которые совместно используют средство извлечения CodeQL, такие как C и C++, Java и Kotlin, и JavaScript и TypeScript.\n\nДоступно с момента `v2.15.2`.\n\n#### `--sarif-category=<category>`\n\n              \\[Только форматы SARIF] \\[Рекомендуется] Укажите категорию для этого анализа, включаемую в выходные данные SARIF. Категорию можно использовать для различения нескольких анализов, выполняемых в одном и том же фиксации и репозитории, но на разных языках или в разных частях кода.\n\nЕсли вы анализируете одну и ту же версию базы кода различными способами (например, для разных языков) и отправляете результаты в GitHub для презентации в сканировании кода, это значение должно отличаться между каждым из анализов, что указывает сканирование кода, что дополнение_ к анализу_, а не _заменять_ друг друга. (Значения должны быть согласованы между выполнением одного и того же анализа для _разных_ версий базы кода.)\n\nЭто значение будет отображаться (с косой косой чертой, добавленной, если она еще не присутствует) в качестве `<run>.automationDetails.id` свойства.\n\n#### `-j, --threads=<num>`\n\nКоличество потоков, используемых для вычислительных путей.\n\nЗначение по умолчанию — 1. Вы можете передать 0 для использования одного потока на ядро на компьютере или -_N, чтобы оставить _неиспользуемые_ ядра N_ (за исключением того, что по-прежнему используется хотя бы один поток).\n\n#### `--column-kind=<columnKind>`\n\n              \\[ТОЛЬКО SARIF] Тип столбца, используемый для интерпретации столбцов расположения. Одно из: utf8, utf16, utf32, байт.\n\n#### `--[no-]unicode-new-lines`\n\n              \\[ТОЛЬКО SARIF] Указывает, считаются ли символы юникода lS (разделитель линий, U+2028) и PS (разделитель абзацов, U+2029) в качестве новых строк при интерпретации номеров строк расположения.\n\n### Параметры исходного архива — должны быть предоставлены вместе или не вообще\n\n#### `-s, --source-archive=<sourceArchive>`\n\nКаталог или ZIP-файл, содержащий исходный архив.\n\n#### `-p, --source-location-prefix=<sourceLocationPrefix>`\n\nПуть к файлу в исходной файловой системе, в которой хранится исходный код.\n\n### Распространенные параметры\n\n#### `-h, --help`\n\nОтображение этого текста справки.\n\n#### `-J=<opt>`\n\n              \\[Дополнительно] Укажите параметр JVM, выполняя команду.\n\n(Убедитесь, что параметры, содержащие пробелы, не будут обрабатываться правильно.)\n\n#### `-v, --verbose`\n\nПостепенно увеличьте число отображаемых сообщений о ходе выполнения.\n\n#### `-q, --quiet`\n\nПостепенно уменьшайте количество отображаемых сообщений о ходе выполнения.\n\n#### `--verbosity=<level>`\n\n              \\[Дополнительно] Явным образом задайте уровень детализации на одну из ошибок, предупреждений, хода выполнения, хода выполнения+, хода выполнения++, хода выполнения+++. Переопределяет `-v` и `-q`.\n\n#### `--logdir=<dir>`\n\n              \\[Дополнительно] Запись подробных журналов в один или несколько файлов в указанном каталоге с созданными именами, включающими метки времени и имя выполняющегося подкоманда.\n\n(Чтобы записать файл журнала с именем, над которым у вас есть полный контроль, вместо этого предоставьте `--log-to-stderr` и перенаправите stderr по мере необходимости.)\n\n#### `--common-caches=<dir>`\n\n              \\[Дополнительно] Управляет расположением кэшированных данных на диске, которые будут сохраняться между несколькими запусками интерфейса командной строки, такими как скачанные пакеты QL и скомпилированные планы запросов. Если этот параметр не задан явным образом, по умолчанию используется каталог с именем `.codeql` в домашнем каталоге пользователя; он будет создан, если он еще не существует.\n\nДоступно с момента `v2.15.2`."}