инициализация базы данных

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

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

Краткий обзор

Shell

codeql database init --source-root=<dir> [--language=<lang>[,<lang>...]] [--github-auth-stdin] [--github-url=<url>] [--extractor-option=<extractor-option-name=value>] <options>... -- <database>

Описание

[Сантехника] Создание пустой базы данных CodeQL.

Создайте структурную структуру для базы данных CodeQL, которая еще не содержит необработанный набор данных QL, но готова к выполнению шагов средства извлечения. После выполнения этой команды выполните одну или несколько команд trace-command базы данных codeql , а затем завершите работу базы данных codeql , чтобы подготовить базу данных к запросу.

(Частью этого действия является разрешение расположения соответствующего языкового пакета и сохранение его в метаданных базы данных, чтобы его не нужно было повторять при каждой команде извлечения. Переключение средств извлечения в середине операции извлечения в любом случае недопустимо.)

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

`<database>`

[Обязательный] Путь к создаваемой базе данных CodeQL. Этот каталог будет создан и не должен существовать (но его родительский каталог должен существовать).

--db-cluster Если параметр задан, это будет не сама база данных, а каталог, который будет содержать базы данных для нескольких языков, созданных из одного корня источника.

Важно, чтобы этот каталог не был в расположении, в которое будет мешать процессу сборки. Например, target каталог проекта Maven не будет подходящим выбором.

`-s, --source-root=<dir>`

[Обязательно] Корневой каталог исходного кода. Во многих случаях это будет корень оформления заказа. Файлы в ней считаются основными исходными файлами для этой базы данных. В некоторых форматах выходных данных на файлы будут ссылаться по их относительному пути из этого каталога.

`--[no-]overwrite`

[Дополнительно] Если база данных уже существует, удалите ее и выполните эту команду вместо сбоя. Этот параметр следует использовать с осторожностью, так как он может рекурсивно удалить весь каталог базы данных.

`--codescanning-config=<file>`

[Дополнительно. Чтение файла конфигурации сканирования кода с указанием параметров создания баз данных CodeQL и запросов для выполнения на последующих шагах. Дополнительные сведения о формате этого файла конфигурации см. в статье Настройка сканирования кода. Чтобы выполнить запросы из этого файла на более позднем этапе, вызовите анализ базы данных codeql без указания других запросов.

`--[no-]db-cluster`

Вместо создания отдельной базы данных создайте "кластер" баз данных для разных языков, каждый из которых является подкаталогом каталога, заданного в командной строке.

`-l, --language=<lang>[,<lang>...]`

Язык, который будет использоваться для анализа новой базы данных.

Используйте языки разрешения codeql , чтобы получить список подключаемых средств извлечения языков, найденных в пути поиска.

--db-cluster Если задан параметр, он может отображаться несколько раз, или значение может быть разделенным запятыми списком языков.

Если этот параметр опущен, а анализируемый корень источника является извлечением репозитория GitHub, cli CodeQL выполнит вызов API GitHub, чтобы попытаться автоматически определить, какие языки следует анализировать. Обратите внимание, что для этого маркер GitHub PAT должен быть предоставлен либо в переменной среды GITHUB_TOKEN, либо через стандартные входные данные с помощью --github-auth-stdin параметра .

`--[no-]calculate-baseline`

[Дополнительно] Вычислите базовые сведения об анализируемом коде и добавьте его в базу данных. По умолчанию этот параметр включен, если только корень источника не является корнем файловой системы. Этот флаг можно использовать для отключения или принудительного включения поведения даже в корневой папке файловой системы.

`--[no-]allow-missing-source-root`

[Дополнительно] Продолжить, даже если указанный корень источника не существует.

`--[no-]begin-tracing`

[Дополнительно] Создайте некоторые скрипты, которые можно использовать для настройки "непрямой трассировки сборки", что позволяет интегрировать существующие рабочие процессы сборки, если явная команда сборки недоступна. Сведения о том, когда и как использовать эту функцию, см. в документации по Создание базы данных CodeQL.

Параметры выбора средства извлечения

`--search-path=<dir>[:<dir>...]`

Список каталогов, в которых можно найти пакеты средств извлечения. Каталоги могут быть либо самими пакетами средств извлечения, либо каталогами, содержащими средства извлечения в качестве непосредственных подкаталогов.

Если путь содержит несколько деревьев каталогов, их порядок определяет приоритет между ними: если целевой язык совпадает в нескольких деревьях каталогов, то первое из них выигрывает.

Средства извлечения, в комплекте с самой цепочкой инструментов CodeQL, всегда будут найдены, но если необходимо использовать отдельно распределенные средства извлечения, необходимо предоставить этот параметр (или, что еще лучше, настроить --search-path в файле конфигурации для каждого пользователя).

(Примечание. В Windows разделитель пути — ).;

Параметры для настройки вызова API GitHub для автоматического определения языков.

`-a, --github-auth-stdin`

Примите маркер GitHub Apps или личный маркер доступа через стандартные входные данные.

Это переопределяет переменную среды GITHUB_TOKEN.

`-g, --github-url=<url>`

URL-адрес используемого экземпляра GitHub. Если этот параметр опущен, cli попытается автоматически определить этот параметр из пути оформления заказа. Если это невозможно, по умолчанию используется значение https://github.com/

Параметры для настройки диспетчера пакетов.

`--registries-auth-stdin`

Выполните проверку подлинности в реестрах контейнеров GitHub Enterprise Server, передав список пар, \<registry_url>=\ разделенный запятыми.

Например, можно передать https://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2 для проверки подлинности в двух экземплярах GitHub Enterprise Server.

Это переопределяет переменные среды AUTH CODEQL_REGISTRIES_и токена GITHUB_. Если вам нужно пройти проверку подлинности только в реестре контейнеров github.com, можно использовать более --github-auth-stdin простой вариант.

Параметры настройки трассировки Windows

`--trace-process-name=<process-name>`

[Только Windows] При инициализации трассировки внедряйте трассировку в родительский процесс Интерфейса командной строки CodeQL, имя которого соответствует этому аргументу. Если это имя имеет несколько родительских процессов, будет выбран один из самых низких в дереве процессов. Этот параметр переопределяет --trace-process-level, поэтому, если оба варианта передаются, будет использоваться только этот параметр.

`--trace-process-level=<process-level>`

[Только Windows] При инициализации трассировки вставьте трассировку этого количества родительских элементов выше текущего процесса с 0, соответствующим процессу, который вызывает CodeQL CLI. Поведение интерфейса командной строки по умолчанию, если аргументы не передаются, заключается в внедрении в родительский объект вызывающего процесса.

Параметры для настройки непрямой трассировки сборки

`--no-tracing`

[Дополнительно. Не отслеживайте указанную команду, а полагайтесь на нее для получения всех необходимых данных напрямую.

`--extra-tracing-config=<tracing-config.lua>`

[Дополнительно] Путь к файлу конфигурации трассировки. Его можно использовать для изменения поведения трассировки сборки. Его можно использовать для выбора процессов компилятора, которые выполняются в рамках команды сборки, и запуска выполнения других средств. Средства извлечения предоставляют файлы конфигурации трассировки по умолчанию, которые должны работать в большинстве ситуаций.

Параметры для управления поведением средства извлечения: применяются только к непрямой среде трассировки

`-O, --extractor-option=<extractor-option-name=value>`

Задайте параметры для средств извлечения CodeQL. extractor-option-name значение должно иметь имя средства извлечения_формы.group1.group2.option_name или group1.group2.option_name. Если extractor_option_name начинается с имени средства извлечения, указанный метод извлечения должен объявить имя параметра group1.group2.option_. В противном случае для любого средства извлечения, объявляющего имя параметра group1.group2.option_, будет задан параметр . value может быть любой строкой, которая не содержит новую строку.

Этот параметр командной строки можно использовать несколько раз, чтобы задать несколько параметров средства извлечения. При указании нескольких значений для одного и того же параметра средства извлечения поведение зависит от типа, ожидаемого параметром средства извлечения. Строковые параметры будут использовать последнее указанное значение. Параметры массива будут использовать все указанные значения по порядку. Параметры средства извлечения, указанные с помощью этого параметра командной строки, обрабатываются после параметров средства извлечения, заданных с помощью --extractor-options-file.

При передаче в инициализацию базы данных codeql или codeql database begin-tracingпараметры будут применяться только к среде косвенной трассировки. Если рабочий процесс также вызывает команду trace-command базы данных codeql , при необходимости необходимо передать в нее параметры.

См https://codeql.github.com/docs/codeql-cli/extractor-options . дополнительные сведения о параметрах средства извлечения CodeQL, в том числе о том, как вывести список параметров, объявленных каждым из средств извлечения.

`--extractor-options-file=<extractor-options-bundle-file>`

Укажите файлы пакетов параметров извлечения. Файл пакета параметров извлечения — это JSON-файл (расширение .json) или ФАЙЛ YAML (расширение .yaml или .yml), который задает параметры средства извлечения. Файл должен содержать ключ карты верхнего уровня extractor и имена средств извлечения в виде ключей карты второго уровня. Дополнительные уровни карт представляют вложенные группы средств извлечения, а параметры строк и массивов — это записи карты со значениями строк и массивов.

Файлы пакета параметров извлечения считываются в указанном порядке. Если в разных файлах пакета параметров средства извлечения указан один и тот же параметр извлечения, поведение зависит от типа, который ожидает параметр средства извлечения. Строковые параметры будут использовать последнее указанное значение. Параметры массива будут использовать все указанные значения по порядку. Параметры средства извлечения, указанные с помощью этого параметра командной строки, обрабатываются перед параметрами средства извлечения, заданными с помощью --extractor-option.