{"meta":{"title":"результаты интерпретации базы данных","intro":"[Сантехника] Интерпретируйте результаты вычисляемого запроса в значимые форматы, такие как SARIF или CSV.","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/database-interpret-results","title":"результаты интерпретации базы данных"}],"documentType":"article"},"body":"# результаты интерпретации базы данных\n\n\\[Сантехника] Интерпретируйте результаты вычисляемого запроса в значимые форматы, такие как SARIF или CSV.\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 database interpret-results --format=<format> --output=<output> [--threads=<num>] <options>... -- <database> <file|dir|suite>...\n```\n\n## Description\n\n```\n          \\[Сантехника] Интерпретируйте вычисляемый запрос в значимые форматы, такие как SARIF или CSV.\n```\n\nРезультаты должны быть вычислены и сохранены[ в каталоге базы данных CodeQL с помощью ](/ru/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-run-queries)запросов запуска базы данных codeql. (Обычно эти действия необходимо выполнить вместе с помощью [анализа](/ru/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-analyze) базы данных codeql.\n\n## Options\n\n### Основные параметры\n\n#### `<database>`\n\n```\n          \\[Обязательный] Путь к базе данных CodeQL, запрашиваемой.\n```\n\n#### `<file|dir|suite>...`\n\nПовторите спецификацию, в которой были выполнены запросы.\n\nЕсли опущено, интерфейс командной строки определит подходящий набор запросов, используя ту же логику, что и [run-запросы](/ru/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-run-queries) базы данных codeql.\n\n(В будущей версии ее следует опустить и интерпретировать все результаты, найденные в базе данных. Это славное будущее еще не. К сожалению.)\n\n#### `--format=<format>`\n\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```\n\nСовместим только с запросами с графом @kind .\n\n#### `-o, --output=<output>`\n\n```\n          \\[Обязательный] Выходной путь для записи результатов. Для форматов графов это должен быть каталог, а результат (или результаты, если эта команда поддерживает интерпретацию нескольких запросов) будут записаны в этом каталоге.\n```\n\n#### `--max-paths=<maxPaths>`\n\nМаксимальное количество путей для каждого оповещения с путями.\n(По умолчанию: 4)\n\n#### `--[no-]sarif-add-file-contents`\n\n```\n          \\[Форматы SARIF] Включите полное содержимое файла для всех файлов, на которые ссылается по крайней мере один результат.\n```\n\n#### `--[no-]sarif-add-snippets`\n\n```\n          \\[Форматы SARIF] Включите фрагменты кода для каждого расположения, указанного в результатах, с двумя строками контекста до и после указанного расположения.\n```\n\n#### `--[no-]sarif-add-query-help`\n\n```\n          \\[Форматы SARIF] Нерекомендуемые \\[] Включите справку по запросу Markdown для всех запросов. Он загружает справку по запросу /path/to/query.ql из файла /path/to/query.md. Если этот флаг не предоставляется по умолчанию, необходимо включить справку только для пользовательских запросов, т. е. тех, которые находятся в пакетах запросов, которые не относятся к коду формы\\`/lang\\<rt;-querys\\&\\`. Этот параметр не действует при передаче в [кодql bqrs интерпретации](/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-interpret).\n```\n\n#### `--sarif-include-query-help=<mode>`\n\n```\n          \\[Форматы SARIF] Укажите, следует ли включать справку по запросу в выходные данные SARIF. Одно из:\n\n          `always`: включите справку по запросу для всех запросов.\n\n          `custom_queries_only`\n          _(по умолчанию)_: включите справку запроса только для пользовательских запросов, т. е. тех, которые находятся в пакетах запросов, которые не относятся к \\`коде формы/\\<lang\\&rt;-querys\\`.\n\n          `never`: не включать справку по запросу для каких-либо запросов.\n```\n\nЭтот параметр не действует при передаче в [кодql bqrs интерпретации](/ru/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-interpret).\n\nДоступно с момента `v2.15.2`.\n\n#### `--no-sarif-include-alert-provenance`\n\n```\n          \\[\n          \\[Расширенные форматы SARIF] Не включайте сведения о происхождении оповещений в выходные данные SARIF.\n```\n\nДоступно с момента `v2.18.1`.\n\n#### `--[no-]sarif-group-rules-by-pack`\n\n```\n          \\[Форматы SARIF] Поместите объект правила для каждого запроса в соответствующий пакет QL в свойстве `<run>.tool.extensions` . Этот параметр не действует при передаче в [кодql bqrs интерпретации](/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-interpret).\n```\n\n#### `--[no-]sarif-multicause-markdown`\n\n```\n          \\[Форматы SARIF] Только для оповещений с несколькими причинами включите их в виде элемента, отформатированного Markdown, в выходные данные в дополнение к обычной строке.\n```\n\n#### `--no-sarif-minify`\n\n```\n          \\[Только форматы SARIF] Создание довольно печатных выходных данных SARIF. По умолчанию выходные данные SARIF минимируются, чтобы уменьшить размер выходного файла.\n```\n\n#### `--sarif-run-property=<String=String>`\n\n```\n          \\[Форматы SARIF] Пара значений ключа, добавляемая в созданный контейнер свойств SARIF \"run\". Может повторяться.\n```\n\n#### `--no-group-results`\n\n```\n          \\[Форматы SARIF] Создает один результат для каждого сообщения, а не один результат на уникальное расположение.\n```\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```\n          \\[GitHub.com и GitHub Enterprise Server версии 3.12.0+ используйте сведения о охвате вложенных файлов. Это вычисляет, отображает и экспортирует отдельные сведения о охвате файлов для языков, которые совместно используют средство извлечения CodeQL, такие как C и C++, Java и Kotlin, и JavaScript и TypeScript.\n```\n\nДоступно с момента `v2.15.2`.\n\n#### `--sarif-category=<category>`\n\n```\n          \\[Только форматы SARIF] \\[Рекомендуется] Укажите категорию для этого анализа, включаемую в выходные данные SARIF. Категорию можно использовать для различения нескольких анализов, выполняемых в одном и том же фиксации и репозитории, но на разных языках или в разных частях кода.\n```\n\nЕсли вы анализируете одну и ту же версию базы кода различными способами (например, для разных языков) и отправляете результаты в GitHub для презентации в сканировании кода, это значение должно отличаться между каждым из анализов, что указывает сканирование кода, что дополнение\\_ к анализу\\_, а не *заменять* друг друга. (Значения должны быть согласованы между выполнением одного и того же анализа для *разных* версий базы кода.)\n\nЭто значение будет отображаться (с косой косой чертой, добавленной, если она еще не присутствует) в качестве `<run>.automationDetails.id` свойства.\n\n#### `-j, --threads=<num>`\n\nКоличество потоков, используемых для вычислительных путей.\n\nЗначение по умолчанию — 1. Вы можете передать 0 для использования одного потока на ядро на компьютере или -*N, чтобы оставить *неиспользуемые* ядра N* (за исключением того, что по-прежнему используется хотя бы один поток).\n\n#### `--no-database-extension-packs`\n\n```\n          \\[Дополнительно] Опустить пакеты расширений, хранящиеся в базе данных во время создания базы данных, из файла конфигурации сканирования кода или из файлов расширений, хранящихся в каталоге расширений проанализированной базы кода.\n```\n\n#### `--[no-]print-diagnostics-summary`\n\nНапечатать сводку по проанализированным диагностика стандартным выходным данным.\n\n#### `--[no-]print-metrics-summary`\n\nВывод сводки по проанализированным метрикам в стандартные выходные данные.\n\n#### `--[no-]print-baseline-loc`\n\nПечать базовых строк кода, которые учитываются в стандартных выходных данных.\n\n### Параметры настройки диспетчера пакетов CodeQL\n\n#### `--registries-auth-stdin`\n\nПроверка подлинности в реестрах контейнеров GitHub Enterprise Server путем передачи \\<registry\\_url>=\\<token> разделенного запятыми списка пар.\n\nНапример, можно передать `https://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2`\nдля проверки подлинности на двух экземплярах GitHub Enterprise Server.\n\nПри этом переопределяются переменные среды маркера токена CODEQL\\_И\\_AUTH и GITHUB\\_. Если вам нужно выполнить проверку подлинности только в реестре контейнеров github.com, можно вместо этого выполнить проверку подлинности с помощью более `--github-auth-stdin` простого параметра.\n\n#### `--github-auth-stdin`\n\nПроверка подлинности в реестре контейнеров github.com путем передачи маркера github.com GitHub Apps или личного маркера доступа через стандартные входные данные.\n\nЧтобы пройти проверку подлинности в реестрах контейнеров GitHub Enterprise Server, передайте `--registries-auth-stdin` или используйте переменную среды AUTH CODEQL\\_REGISTRIES\\_.\n\nЭто переопределяет переменную среды токена GITHUB\\_.\n\n### Параметры для указания расширений, используемых при интерпретации результатов\n\n####\n\n```\n          `--model-packs=<`\n          <name@range>>...\n```\n\nСписок имен пакетов CodeQL, каждый из которых содержит необязательный диапазон версий, который будет использоваться в качестве пакетов моделей для настройки запросов, которые будут оцениваться.\n\n### Параметры поиска пакетов QL (которые могут потребоваться для интерпретации наборов запросов)\n\n#### `--search-path=<dir>[:<dir>...]`\n\nСписок каталогов, в которых можно найти пакеты QL. Каждый каталог может быть пакетом QL (или пакетом пакетов, содержащих `.codeqlmanifest.json` файл в корневом каталоге) или непосредственным родительским элементом одного или нескольких таких каталогов.\n\nЕсли путь содержит несколько каталогов, их порядок определяет приоритет между ними: когда имя пакета, которое должно быть разрешено, совпадает с несколькими деревьями каталогов, то один из первых побед.\n\nУказывая это на получение репозитория CodeQL с открытым исходным кодом, должно работать при запросе одного из языков, которые живут там.\n\nЕсли вы проверили репозиторий CodeQL как одноуровневую цепочку инструментов CodeQL, вам не нужно предоставлять этот параметр; Такие каталоги с братом всегда будут искать пакеты QL, которые не удается найти в противном случае. (Если это значение по умолчанию не работает, настоятельно рекомендуется настроить `--search-path` один раз и для всех в файле конфигурации для каждого пользователя).\n\n(Примечание. В Windows разделитель путей имеет значение `;`).\n\n#### `--additional-packs=<dir>[:<dir>...]`\n\nЕсли указан этот список каталогов, они будут искать пакеты до тех, в которых они есть `--search-path`. Порядок между ними не имеет значения; Это ошибка, если имя пакета найдено в двух разных местах в этом списке.\n\nЭто полезно, если вы временно разрабатываете новую версию пакета, который также отображается в пути по умолчанию. С другой стороны, *не рекомендуется* переопределить этот параметр в файле конфигурации. Некоторые внутренние действия будут добавлять этот параметр на лету, переопределяя любое настроенное значение.\n\n(Примечание. В Windows разделитель путей имеет значение `;`).\n\n### Распространенные параметры\n\n#### `-h, --help`\n\nОтображение этого текста справки.\n\n#### `-J=<opt>`\n\n```\n          \\[Дополнительно] Укажите параметр JVM, выполняя команду.\n```\n\n(Убедитесь, что параметры, содержащие пробелы, не будут обрабатываться правильно.)\n\n#### `-v, --verbose`\n\nПостепенно увеличьте число отображаемых сообщений о ходе выполнения.\n\n#### `-q, --quiet`\n\nПостепенно уменьшайте количество отображаемых сообщений о ходе выполнения.\n\n#### `--verbosity=<level>`\n\n```\n          \\[Дополнительно] Явным образом задайте уровень детализации на одну из ошибок, предупреждений, хода выполнения, хода выполнения+, хода выполнения++, хода выполнения+++. Переопределяет `-v` и `-q`.\n```\n\n#### `--logdir=<dir>`\n\n```\n          \\[Дополнительно] Запись подробных журналов в один или несколько файлов в указанном каталоге с созданными именами, включающими метки времени и имя выполняющегося подкоманда.\n```\n\n(Чтобы записать файл журнала с именем, над которым у вас есть полный контроль, вместо этого предоставьте `--log-to-stderr` и перенаправите stderr по мере необходимости.)\n\n#### `--common-caches=<dir>`\n\n```\n          \\[Дополнительно] Управляет расположением кэшированных данных на диске, которые будут сохраняться между несколькими запусками интерфейса командной строки, такими как скачанные пакеты QL и скомпилированные планы запросов. Если этот параметр не задан явным образом, по умолчанию используется каталог с именем `.codeql` в домашнем каталоге пользователя; он будет создан, если он еще не существует.\n```\n\nДоступно с момента `v2.15.2`."}