In diesem Inhalt wird die neueste Version von CodeQL CLI beschrieben. Weitere Informationen zu diesem Thema findest du unter https://github.com/github/codeql-cli-binaries/releases.
Um Details zu den Optionen anzuzeigen, die für diesen Befehl in früheren Releases verfügbar sind, führe den Befehl mit der Option --help im Terminal aus.
Übersicht
codeql database finalize [--dbscheme=<file>] [--threads=<num>] [--ram=<MB>] <options>... -- <database>
codeql database finalize [--dbscheme=<file>] [--threads=<num>] [--ram=<MB>] <options>... -- <database>
Beschreibung
[Infrastruktur] Letzte Schritte bei der Datenbankerstellung.
Finalisiere eine Datenbank, die mithilfe von codeql database init erstellt und für die anschließend mithilfe von codeql database trace-command ein Seeding mit Analysedaten ausgeführt wurde. Dies ist erforderlich, damit die neue Datenbank abgefragt werden kann.
Optionen
Primäre Optionen
<database>
[Obligatorisch] Pfad zur CodeQL-Datenbank, die sich im Aufbau befindet. Dieser muss für die Extraktion mit codeql database init vorbereitet sein.
Wenn die Option --db-cluster angegeben ist, handelt es sich nicht um eine Datenbank als solches, sondern um ein Verzeichnis, das Datenbanken enthält. Es werden dann alle diese Datenbanken zusammen verarbeitet.
--[no-]db-cluster
Gibt an, dass es sich bei dem in der Befehlszeile angegebenen Verzeichnis nicht um eine Datenbank als solches handelt, sondern um ein Verzeichnis, das eine oder mehrere Datenbanken enthält, die sich im Aufbau befinden. Diese Datenbanken werden zusammen verarbeitet.
--additional-dbs=<database>[:<database>...]
[Erweitert] Pfad zu zusätzlichen CodeQL-Datenbanken, die sich im Aufbau befinden. Diese werden nicht selbst abgeschlossen, aber ihre Daten werden in die finalisierte Datenbank eingeschlossen, die erstellt wird. Dies ist eine erweiterte Option, die möglicherweise nicht in allen Fällen den gewünschten Effekt hat. Weitere Informationen findest du in der Dokumentation zu „codeql database import“.
Wenn die Option --db-cluster angegeben ist, wird erwartet, dass es sich um Datenbankcluster und nicht um einzelne CodeQL-Datenbanken handelt.
(Hinweis: Unter Windows wird ; als Pfadtrennzeichen verwendet.)
--no-cleanup
[Erweitert] Unterdrückt alle Datenbankbereinigungen nach der Finalisierung. Hilfreich beim Debuggen.
--no-pre-finalize
[Erweitert] Überspringt alle Vorabfinalisierungsskripts, die ggf. vom aktiven CodeQL-Extraktor angegebenen wurden.
--[no-]skip-empty
[Erweitert] Gibt eine Warnung aus, anstatt einen Fehler zu verursachen, wenn eine Datenbank leer ist, da während des Builds kein Quellcode verfügbar war. Die leere Datenbank wird nicht finalisiert.
Optionen zum Steuern des TRAP-Importvorgangs
-S, --dbscheme=<file>
[Erweitert] Überschreibe die automatisch erkannte dbscheme-Definition, die die TRAP-Dateien voraussichtlich befolgen werden. Normalerweise wird diese aus dem Extraktor der Datenbank übernommen.
-j, --threads=<num>
Dient zum Festlegen, wie viele Threads für den Importvorgang verwendet werden sollen.
Der Standardwert lautet 1. Du kannst 0 übergeben, um jeweils einen Thread pro Kern auf dem Computer zu verwenden, oder -N, um N Kerne ungenutzt zu lassen. (Es wird allerdings immer noch mindestens ein Thread verwendet.)
-M, --ram=<MB>
Dient zum Festlegen, wie viel Arbeitsspeicher für den Importvorgang verwendet werden soll.
Optionen für die Bereinigung von Datasets auf niedriger Ebene
--max-disk-cache=<MB>
Dient zum Festlegen des maximalen Speicherplatzes, der vom Datenträgercache für Zwischenergebnisse von Abfragen beansprucht werden darf.
Wird diese Größe nicht explizit konfiguriert, versucht der Auswerter, basierend auf der Größe des Datasets und der Komplexität der Abfragen eine angemessene Menge an Cachespeicherplatz zu verwenden. Durch explizites Festlegen eines höheren Grenzwerts (im Vergleich zur Standardnutzung) können mehr Daten zwischengespeichert werden, was spätere Abfragen beschleunigen kann.
--min-disk-free=<MB>
[Erweitert] Dient zum Festlegen der Zielmenge des freien Speicherplatzes im Dateisystem.
Ohne Angabe von --max-disk-cache versucht der Auswerter nach Möglichkeit, die Nutzung des Datenträgercaches einzuschränken, wenn der freie Speicherplatz im Dateisystem diesen Wert unterschreitet.
--min-disk-free-pct=<pct>
[Erweitert] Dient zum Festlegen des Zielanteils des freien Speicherplatzes im Dateisystem.
Ohne Angabe von --max-disk-cache versucht der Auswerter nach Möglichkeit, die Nutzung des Datenträgercaches einzuschränken, wenn der freie Speicherplatz im Dateisystem diesen Prozentsatz unterschreitet.
--cache-cleanup=<mode>
Wähle aus, wie aggressiv der Cache gekürzt werden soll. Verfügbare Optionen:
clear: Entfernt den gesamten Cache, um den Zustand eines frisch extrahierten Datasets zu erreichen.
trim (Standardwert) : Kürzt alles bis auf explizit zwischengespeicherte Prädikate.
fit: Stellt lediglich sicher, dass die definierten Größenlimits für den Datenträgercache eingehalten werden, und löscht so viele Zwischenelemente wie nötig.
--cleanup-upgrade-backups
Löscht alle ggf. vorhandenen Sicherungsverzeichnisse, die bei Datenbankupgrades erstellt wurden.
Optionen zum Überprüfen importierter TRAP-Dateien
--[no-]check-undefined-labels
[Erweitert] Meldet Fehler für nicht definierte Bezeichnungen.
--[no-]check-unused-labels
[Erweitert] Meldet Fehler für nicht genutzte Bezeichnungen.
--[no-]check-repeated-labels
[Erweitert] Meldet Fehler für wiederholte Bezeichnungen.
--[no-]check-redefined-labels
[Erweitert] Meldet Fehler für neu definierte Bezeichnungen.
--[no-]check-use-before-definition
[Erweitert] Meldet Fehler für Bezeichnungen, die verwendet werden, bevor sie definiert wurden.
--[no-]fail-on-trap-errors
[Erweitert] Führt zu einer Beendigung ungleich null, wenn beim TRAP-Import ein Fehler auftritt.
--[no-]include-location-in-star
[Erweitert] Erstellt Entitäts-IDs, die den Speicherort in der TRAP-Datei codieren, aus der sie stammen. Kann für das Debuggen von TRAP-Generatoren nützlich sein, nimmt aber viel Platz im Dataset ein.
--[no-]linkage-aware-import
[Erweitert] Steuert, ob der Import von Codeql-Datasets verknüpfungsfähig (Standard) ist oder nicht. Bei Projekten, bei denen dieser Teil der Datenbankerstellung zu viel Arbeitsspeicher verbraucht, kann die Deaktivierung dieser Option den Fortschritt auf Kosten der Vollständigkeit der Datenbank fördern.
Verfügbar seit v2.15.3.
Allgemeine Optionen
-h, --help
Zeigt diesen Hilfetext an.
-J=<opt>
[Erweitert] Dient zum Angeben einer Option für die JVM-Instanz, die den Befehl ausführt.
(Beachte, dass Optionen, die Leerzeichen enthalten, nicht ordnungsgemäß verarbeitet werden.)
-v, --verbose
Ermöglicht die inkrementelle Erhöhung der Anzahl ausgegebener Statusmeldungen.
-q, --quiet
Ermöglicht die inkrementelle Verringerung der Anzahl ausgegebener Statusmeldungen.
--verbosity=<level>
[Erweitert] Dient zum expliziten Festlegen des Ausführlichkeitsgrads auf „errors“, „warnings“, „progress“, „progress+“, „progress++“ oder „progress+++“. Überschreibt -v und -q:
--logdir=<dir>
[Erweitert] Ermöglicht das Schreiben detaillierter Protokolle in eine oder mehrere Dateien im angegebenen Verzeichnis mit generierten Namen, die Zeitstempel und den Namen des ausgeführten Unterbefehls enthalten.
(Um eine Protokolldatei mit einem Namen zu schreiben, über den du die volle Kontrolle hast, gib stattdessen --log-to-stderr an, und leite stderr wie gewünscht um.)
--common-caches=<dir>
[Erweitert] Steuert den Speicherort zwischengespeicherter Daten auf dem Datenträger, der zwischen mehreren Ausführungsvorgängen der CLI beibehalten wird, z. B. heruntergeladene QL-Pakete und kompilierte Abfragepläne. Wenn dies nicht explizit festgelegt ist, wird dieses Verzeichnis standardmäßig auf ein Verzeichnis mit dem Namen .codeql festgelegt, das sich im Startverzeichnis des Benutzer. Es wird erstellt, wenn es noch nicht vorhanden ist.
Verfügbar seit v2.15.2.