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 bqrs decode [--output=<file>] [--result-set=<name>] [--sort-key=<col>[,<col>...]] <options>... -- <file>
codeql bqrs decode [--output=<file>] [--result-set=<name>] [--sort-key=<col>[,<col>...]] <options>... -- <file>
Beschreibung
Konvertiert Ergebnisdaten aus BQRS in andere Formulare.
Die decodierte Ausgabe wird in die Standardausgabe geschrieben, es sei denn, die --output-Option ist angegeben.
Optionen
Primäre Optionen
<file>
[Obligatorisch] Zu dekodierende BQRS-Datei.
-o, --output=<file>
Die Datei, in die die gewünschte Ausgabe geschrieben werden soll.
-r, --result-set=<name>
Wähle ein bestimmtes Resultset aus der zu decodierten BQRS-Datei aus. Die verfügbaren Resultsets können mit codeql bqrs info aufgelistet werden.
Wenn kein Resultset ausgewählt ist, werden alle Resultsets decodiert, sofern das ausgewählte Ausgabeformat und die Verarbeitungsoptionen dies erlauben. Andernfalls tritt ein Fehler auf.
-k, --sort-key=<col>[,<col>...]
Sortiere das ausgewählte Resultset nach den angegebenen Spalten.
--sort-direction=<direction>[,<direction>...]
Sortiere das ausgewählte Resultset mithilfe der angegebenen Sortierrichtungen.
Wenn die Sortierrichtungen nicht angegeben werden, wird die aufsteigende Reihenfolge für alle Spalten verwendet.
Ausgabeformatoptionen
--format=<fmt>
Lege ein Ausgabeformat fest. Verfügbare Optionen:
text (Standard) : Eine für Menschen lesbare Nur-Text-Tabelle.
csv: Durch Trennzeichen getrennte Werte.
json: JSON-Streaming.
bqrs: BQRS. Diese Option muss mit --output verwendet werden. Am nützlichsten ist sie in Verbindung mit --sort-key.
--no-titles
Dadurch werden Spaltentitel für text- und csv-Formate weggelassen.
--entities=<fmt>[,<fmt>...]
[Erweitert] Legen Sie fest, wie die Ergebnisspalten des Entitätstyps angezeigt werden sollen. Es gibt eine durch Trennzeichen getrennte Liste mit folgenden Auswahlmöglichkeiten:
url: Eine URL, die auf einen Quellspeicherort verweist, wenn die Abfrage so kompiliert wurde, dass sie solche URLs für Entitätstypen erzeugt
string: Eine Zeichenfolge, die von der toString()-Methode in QL berechnet wird, wenn die Abfrage so kompiliert wurde, dass sie solche Zeichenfolgen für die Spalte erzeugt.
id: Die interne ID der Entität, die möglicherweise nicht aussagekräftig ist.
all: Zeigt Spalten mit allen Informationen an, die die BQRS-Datei enthält.
Wenn möglich, werden alle ausgewählten Optionen angezeigt.
Optionen für die Paginierung (zur Verwendung durch interaktive Front-Ends)
--rows=<num>
[Erweitert] Gibt so viele Zeilen aus dem ausgewählten Resultset aus, beginnend am Anfang oder an der mit --start-at angegebenen Stelle.
--start-at=<offset>
[Erweitert] Startet die Ausgabe der Zeile, die an einem bestimmten Byteoffset in der BQRS-Datei definiert ist. Der Offset muss aus codeql bqrs info oder aus dem „next“-Zeiger in der JSON-Ausgabe eines vorherigen Aufrufs mit --rows abgerufen werden. Andere Offsets führen wahrscheinlich zu unsinnigen Ausgaben und bzw. oder expliziten Fehlern.
Diese Option muss immer zusammen mit --rows verwendet werden und ist nicht mit --sort-key kompatibel.
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.