Note
Это содержимое описывает последний выпуск данных CodeQL CLI. Дополнительные сведения об этом выпуске см. в статье https://github.com/github/codeql-cli-binaries/releases.
Чтобы просмотреть сведения о параметрах, доступных для этой команды в предыдущем выпуске, выполните команду с --help параметром в терминале.
Краткие сведения
codeql database bundle --output=<output> <options>... -- <database>
codeql database bundle --output=<output> <options>... -- <database>
Description
Создайте перемещаемый архив базы данных CodeQL.
Команда, которая запаковывает полезные части базы данных. Это будет включать только обязательные компоненты, если пользователь не запрашивает результаты, журналы, ЛОВУШКА или аналогичные компоненты.
Параметры
Основные параметры
<database>
[Обязательный] Путь к базе данных CodeQL для упаковки.
-o, --output=<output>
[Обязательный] Выходной файл, как правило, с расширением ".zip".
--[no-]include-diagnostics
Включите диагностика в пакет.
Доступно с момента v2.16.0.
--[no-]include-results
Включите все предварительно подготовленные результаты запроса в пакет.
--[no-]include-logs
Включите каталог журналов в пакет.
Доступно с момента v2.17.6.
--[no-]include-temp
Включает каталог temp, где находятся все созданные пакеты, запросы и наборы.
Доступно с момента v2.13.3.
--[no-]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 это не задано, средство оценки попытается ограничить использование кэша дисков, если свободное место в файловой системе снижается ниже этого процента.
--cache-cleanup=<mode>
Выберите, как агрессивно обрезать кэш. В число вариантов входят следующие варианты:
clear: удалите весь кэш, обрезая состояние недавно извлеченного набора данных.
trim(по умолчанию): обрезать все, кроме явно кэшированных предикатов.
fit: просто убедитесь, что определенные ограничения размера кэша дисков наблюдаются, удаляя столько промежуточных, сколько необходимо.
--cleanup-upgrade-backups
Удалите все каталоги резервных копий из-за обновлений базы данных.
Распространенные параметры
-h, --help
Отображение этого текста справки.
-J=<opt>
[Дополнительно] Укажите параметр JVM, выполняя команду.
(Убедитесь, что параметры, содержащие пробелы, не будут обрабатываться правильно.)
-v, --verbose
Постепенно увеличьте число отображаемых сообщений о ходе выполнения.
-q, --quiet
Постепенно уменьшайте количество отображаемых сообщений о ходе выполнения.
--verbosity=<level>
[Дополнительно] Явным образом задайте уровень детализации на одну из ошибок, предупреждений, хода выполнения, хода выполнения+, хода выполнения++, хода выполнения+++. Переопределяет -v и -q.
--logdir=<dir>
[Дополнительно] Запись подробных журналов в один или несколько файлов в указанном каталоге с созданными именами, включающими метки времени и имя выполняющегося подкоманда.
(Чтобы записать файл журнала с именем, над которым у вас есть полный контроль, вместо этого предоставьте --log-to-stderr и перенаправите stderr по мере необходимости.)
--common-caches=<dir>
[Дополнительно] Управляет расположением кэшированных данных на диске, которые будут сохраняться между несколькими запусками интерфейса командной строки, такими как скачанные пакеты QL и скомпилированные планы запросов. Если этот параметр не задан явным образом, по умолчанию используется каталог с именем .codeql в домашнем каталоге пользователя; он будет создан, если он еще не существует.
Доступно с момента v2.15.2.