В этом материале описывается последний выпуск Интерфейса командной строки CodeQL. Дополнительные сведения об этом выпуске см. в разделе https://github.com/github/codeql-cli-binaries/releases.
Чтобы просмотреть сведения о параметрах, доступных для этой команды в более раннем выпуске, выполните команду с параметром в терминале --help .
Краткий обзор
codeql database upgrade [--threads=<num>] [--ram=<MB>] <options>... -- <database>Описание
Обновите базу данных, чтобы она была пригодна для использования текущими инструментами.
При этом база данных CodeQL перезаписывается для совместимости с библиотеками QL, которые находятся в пути поиска пакета QL, если это необходимо.
Если требуется обновление, оно необратимо. Впоследствии база данных будет непригодна для использования с библиотеками, которые были актуальны при ее создании.
Основные параметры
<database>
[Обязательный] Путь к обновляемой базе данных CodeQL.
--search-path=<dir>[:<dir>...]
Список каталогов, в которых можно найти пакеты QL, содержащие рецепты обновления. Каждый каталог может быть либо пакетом QL (или пакетом пакетов, содержащим файл в корневом .codeqlmanifest.json каталоге), либо непосредственным родительским элементом одного или нескольких таких каталогов.
Если путь содержит деревья каталогов, их порядок определяет приоритет между ними: если имя пакета, которое необходимо разрешить, совпадает с несколькими деревьями каталогов, то первое из них выигрывает.
Указание на это при извлечении репозитория CodeQL с открытым кодом должно работать при запросе одного из языков, которые там живут.
(Примечание. В Windows разделитель пути — ).;
--additional-packs=<dir>[:<dir>...]
[Дополнительно] Если указан этот список каталогов, в них будет выполняться поиск обновлений до обновлений в --search-path. Порядок между ними не имеет значения; Это ошибка, если имя пакета найдено в двух разных местах в этом списке.
Это полезно, если вы временно разрабатываете новую версию пакета, которая также отображается в пути по умолчанию. С другой стороны , не рекомендуется переопределять этот параметр в файле конфигурации; некоторые внутренние действия добавляют этот параметр на лету, переопределяя любое настроенное значение.
(Примечание. В Windows разделитель пути — ).;
--target-dbscheme=<file>
Целевая dbscheme, до которой требуется выполнить обновление. Если это не задано, будет создан максимальный путь обновления.
--target-sha=<sha>
[Дополнительно] Альтернатива --target-dbscheme , которая предоставляет внутренний хэш целевого dbscheme вместо файла dbscheme.
--[no-]allow-downgrades
Включите соответствующие переходы на более раннюю версию, если обновления отсутствуют.
Параметры для управления оценкой запросов на обновление
--[no-]tuple-counting
[Дополнительно] Отображение счетчиков кортежей для каждого этапа оценки в журналах средства оценки запросов. --evaluator-log Если этот параметр указан, счетчики кортежей будут включены в текстовые и структурированные журналы JSON, созданные командой . (Это может быть полезно для оптимизации производительности сложного кода QL.)
--timeout=<seconds>
[Дополнительно] Установите время ожидания для оценки запроса в секундах.
Функция времени ожидания предназначена для перехвата случаев, когда для оценки сложного запроса потребуется "навсегда". Это не эффективный способ ограничить общее время, которое может занять вычисление запроса. Оценка будет продолжаться до тех пор, пока каждая отдельная часть вычисления по времени завершается в течение времени ожидания. В настоящее время эти отдельные временные части являются уровнями RA оптимизированного запроса, но в будущем они могут измениться.
Если время ожидания не указано или равно 0, время ожидания не устанавливается (за исключением тестового запуска codeql, где время ожидания по умолчанию составляет 5 минут).
-j, --threads=<num>
Используйте это количество потоков для оценки запросов.
По умолчанию равен 1. Можно передать 0, чтобы использовать один поток на каждом ядре на компьютере, или -N , чтобы оставить N ядер неиспользуемых (за исключением использования хотя бы одного потока).
--[no-]save-cache
[Дополнительно] Агрессивно записывайте промежуточные результаты в кэш диска. Это занимает больше времени и использует (гораздо) больше места на диске, но может ускорить последующее выполнение аналогичных запросов.
--[no-]expect-discarded-cache
[Дополнительные возможности. Принимать решения о том, какие предикаты следует оценивать и что записывать в кэш диска, исходя из предположения, что кэш будет удален после выполнения запросов.
--[no-]keep-full-cache
[Дополнительно. Не очищайте кэш диска после завершения оценки. Это может сэкономить время, если вы собираетесь выполнить очистку набора данных codeql или очистку базы данных codeql .
--max-disk-cache=<MB>
Задайте максимальный объем пространства, который может использовать кэш диска для промежуточных результатов запроса.
Если этот размер не настроен явным образом, средство оценки попытается использовать "разумный" объем кэша в зависимости от размера набора данных и сложности запросов. Явное задание более высокого предела, чем это использование по умолчанию, включит дополнительное кэширование, что может ускорить последующие запросы.
--min-disk-free=<MB>
[Дополнительно] Задайте целевой объем свободного места в файловой системе.
Если --max-disk-cache значение не задано, средство оценки попытается ограничить использование кэша диска, если свободное пространство в файловой системе окажется ниже этого значения.
--min-disk-free-pct=<pct>
[Дополнительно] Задайте целевую долю свободного места в файловой системе.
Если --max-disk-cache значение не задано, средство оценки попытается ограничить использование кэша диска, если свободное пространство в файловой системе будет меньше этого процента.
--external=<pred>=<file.csv>
CSV-файл, содержащий строки для внешнего предиката \--external вариантов.
--xterm-progress=<mode>
[Дополнительно] Определяет, следует ли отображать отслеживание хода выполнения во время оценки QL с помощью последовательностей элементов управления xterm. Возможны следующие значения:
no: никогда не производить фантазии прогресса; Предположим, глупый терминал.
auto(по умолчанию): автоматически определяет, выполняется ли команда в соответствующем терминале.
yes: предположим, что терминал может понимать последовательности элементов управления xterm. Функция по-прежнему зависит от возможности автоматического определение размера терминала и также будет отключена, если -q она задана.
25x80 (или аналогично): например yes, а также явно укажите размер терминала.
25x80:/dev/pts/17 (или аналогичный): отображение хода выполнения на терминале, отличном от stderr. В основном используется для внутреннего тестирования.
Параметры управления выходными данными структурированных журналов средства оценки
--evaluator-log=<file>
[Дополнительно] Вывод структурированных журналов о производительности средства оценки в указанный файл. Формат этого файла журнала может быть изменен без уведомления, но будет потоком объектов JSON, разделенных двумя символами новой строки (по умолчанию) или одним, если --evaluator-log-minify параметр передан. Используйте для codeql generate log-summary <file> создания более стабильной сводки по этому файлу и избегайте непосредственного анализа файла. Файл будет перезаписан, если он уже существует.
--evaluator-log-minify
[Дополнительно] Если --evaluator-log параметр передан, передача этого параметра позволит свести к минимуму размер создаваемого журнала JSON за счет того, что он будет гораздо менее удобочитаемым.
Параметры управления использованием ОЗУ в процессе обновления
-M, --ram=<MB>
Задайте общий объем ОЗУ, который должен быть разрешен для использования оценщиком запросов.
Общие параметры
-h, --help
Показать этот текст справки.
-J=<opt>
[Дополнительно] Предоставьте параметр виртуальной машине Java, запустив команду .
(Остерегайтесь, что параметры, содержащие пробелы, будут обрабатываться неправильно.)
-v, --verbose
Добавочное увеличение числа выводемых сообщений о ходе выполнения.
-q, --quiet
Постепенно уменьшайте количество выводемых сообщений о ходе выполнения.
--verbosity=<level>
[Дополнительно] Явно задайте уровень детализации для одной из ошибок, предупреждений, хода выполнения, хода выполнения+, хода выполнения++, хода выполнения+++. Переопределяет -v и -q.
--logdir=<dir>
[Дополнительно] Запись подробных журналов в один или несколько файлов в заданном каталоге с созданными именами, включая метки времени и имя выполняющейся подкоманды.
(Чтобы записать файл журнала с именем, над которым у вас есть полный контроль, вместо этого при необходимости предоставьте --log-to-stderr и перенаправьте stderr.)