Skip to main content
Мы публикуем частые обновления нашей документации, и перевод этой страницы может все еще выполняться. Актуальные сведения см. в документации на английском языке.

пакет базы данных

Создание перемещаемого архива базы данных CodeQL.

GitHub CodeQL лицензируется для каждого пользователя после установки. CodeQL можно использовать только для определенных задач с ограничениями лицензии. Дополнительные сведения см. в разделе Сведения о CodeQL CLI.

Если у вас есть лицензия на GitHub Advanced Security, вы можете использовать CodeQL для автоматического анализа, непрерывной интеграции и непрерывной поставки. Дополнительные сведения см. в разделе Сведения о GitHub Advanced Security.

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

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

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

Shell
codeql database bundle --output=<output> [--mode=<mode>] <options>... -- <database>

Описание

Создание перемещаемого архива базы данных CodeQL.

Команда, которая архивирует полезные части базы данных. Это будет включать только обязательные компоненты, если пользователь специально не запрашивает, чтобы были включены результаты, журналы, TRAP или аналогичные.

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

<database>

[Обязательно] Путь к базе данных CodeQL для пакета.

-o, --output=<output>

[Обязательно] Выходной файл, как правило, с расширением ".zip".

--include-results

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

--include-temp

Включает каталог temp, в котором находятся все созданные пакеты, запросы и наборы.

Доступно начиная с v2.13.3.

--include-uncompressed-source

Включите несжатую версию исходного архивного каталога. Это необходимо для устаревших подключаемых модулей CodeQL (например, CodeQL для Eclipse).

--name=<name>

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

Параметры очистки низкоуровневого набора данных

--max-disk-cache=<MB>

Задайте максимальный объем пространства, который может использовать кэш диска для промежуточных результатов запроса.

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

--min-disk-free=<MB>

[Дополнительно] Задайте целевой объем свободного места в файловой системе.

Если --max-disk-cache параметр не задан, оценщик будет стараться сократить использование кэша диска, если свободное место в файловой системе падает ниже этого значения.

--min-disk-free-pct=<pct>

[Дополнительно] Задайте целевую долю свободного места в файловой системе.

Если --max-disk-cache значение не задано, средство оценки будет стараться ограничить использование кэша диска, если свободное место в файловой системе падает ниже этого процента.

-m, --mode=<mode>

Выберите способ обрезки кэша. Можно выбрать:

brutal: удаляет весь кэш, обрезая его до состояния недавно извлеченного набора данных.

normal(по умолчанию): обрезать все, кроме явно кэшированных предикатов.

light: просто убедитесь, что определенные ограничения размера кэша диска соблюдаются, удаляя столько промежуточных параметров, сколько необходимо.

--cleanup-upgrade-backups

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

Общие параметры

-h, --help

Показать этот текст справки.

-J=<opt>

[Дополнительно] Предоставьте параметр виртуальной машине JVM, выполняющую команду .

(Остерегайтесь, что параметры, содержащие пробелы, будут обрабатываться неправильно.)

-v, --verbose

Постепенно увеличивать количество выводемых сообщений о ходе выполнения.

-q, --quiet

Постепенно уменьшайте количество выводемых сообщений о ходе выполнения.

--verbosity=<level>

[Дополнительно] Явно задайте уровень детализации для одной из ошибок, предупреждений, progress, progress+, progress++, progress+++. Переопределяет -v и -q.

--logdir=<dir>

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

(Чтобы записать файл журнала с именем, над которым у вас есть полный контроль, вместо этого при необходимости предоставьте --log-to-stderr и перенаправьте stderr.)