Note
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 dataset check <options>... -- <dataset>
codeql dataset check <options>... -- <dataset>
Beschreibung
[Plumbing] Überprüft ein bestimmtes Dataset auf interne Konsistenz
Dieser Befehl ist am wahrscheinlichsten für Entwickler*innen von CodeQL-Extraktoren nützlich, da er die vom Extraktor erzeugten Daten überprüft. Der kann auch nützlich sein, wenn Abfragen für eine Datenbank inkonsistente Ergebnisse liefern, um Probleme in den zugrunde liegenden Daten als Ursache auszuschließen.
Optionen
Primäre Optionen
<dataset>
[Obligatorisch] Pfad zum unformatierten QL-Dataset, das überprüft werden soll
--failing-exitcode=<code>
[Erweitert] Legt den Exitcode so fest, dass er erzeugt wird, wenn Fehler jeglicher Art auftreten. Normalerweise ist er auf 1 festgelegt, aber für Tools, die die Ausgabe parsen, ist es empfehlenswert, ihn auf 0 festzulegen.
--format=<fmt>
Legt ein Ausgabeformat fest. Mögliche Optionen:
text (Standard) : Für Menschen lesbarer gerenderter Text
json: Ein gestreamtes JSON-Objektarray
jsonz: Ein Stream von nullterminierten JSON-Objekten
--[no-]precise-locations
[Erweitert] Genaue Positionen von Inkonsistenzen werden mit zusätzlichem Aufwand berechnet. Dieser Vorgang nimmt mehr Zeit in Anspruch, kann aber das Debuggen des Extraktorverhaltens erleichtern.
--max-resolve-depth=<n>
[Erweitert] Der maximale Detailgrad, mit dem IDs aufgelöst werden sollen, um Inkonsistenzen zu erklären. (Standard: 3)
--max-errors-per-checker=<n>
Die maximale Anzahl von Inkonsistenzfehlern jeder Art, die explizit gemeldet werden sollen. (Standardwert: 5)
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.