bqrs-Informationen

Zeigt Metadaten für eine BQRS-Datei an.

Wer kann dieses Feature verwenden?

CodeQL ist für die folgenden Repositorytypen verfügbar:

In diesem Artikel

Hinweis

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.

Zusammenfassung

Shell
codeql bqrs info <options>... -- <file>

Description

Zeigt Metadaten für eine BQRS-Datei an.

Dieser Befehl zeigt eine Übersicht über die Daten an, die in der kompakten binären BQRS-Datei enthalten sind, die das Ergebnis der Ausführung einer Abfrage ist. Es werden die Namen und Größen der einzelnen Resultsets (Tabelle) in der BQRS-Datei sowie die Spaltentypen der einzelnen Resultsets angezeigt.

Optional kann es auch Offsets für die Verwendung der Paginierungsoptionen von codeql bqrs decode vorausberechnen. Dies ist vor allem für IDE-Plug-Ins nützlich.

Options

Primäre Optionen

<file>

          \[Obligatorisch] BQRS-Datei, zu der Informationen angezeigt werden sollen.

--format=<fmt>

Dient zum Auswählen des Ausgabeformats: text(Standardwert) oder json

Unterstützung der Paginierung in codeql bqrs decode

--paginate-rows=<num>

          \[Erweitert] Wenn die Option zusammen mit `--format=json` angegeben wird, wird eine Tabelle mit Byteoffsets berechnet, die später der Option `--start-at` von [codeql bqrs decode](/code-security/codeql-cli/codeql-cli-manual/bqrs-decode) übergeben werden kann, um das Streaming der Ergebnisse an den Positionen 0, _\<num>_ , 2\*_\<num>_ usw. zu beginnen.

--paginate-result-set=<name>

          \[Erweitert] `--paginate-rows` wird nur für Resultsets mit diesem Namen verarbeitet. (Wenn der Name keinem Resultset entspricht, `--paginate-rows` ist eine Nulloperation.)

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.