Datensatzüberprüfung

Zusammenfassung

Shell

codeql dataset check <options>... -- <dataset>

codeql dataset check <options>... -- <dataset>

Description

          \[Plumbing] Überprüft einen bestimmten Datensatz 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.

Options

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-Array von Objekten.

          `jsonz`: Ein Stream von nullterminierten JSON-Objekten

`--[no-]precise-locations`

          \[Erweitert] Machen Sie sich die Mühe, den genauen Ort von Inkonsistenzen zu berechnen. 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`

Erhöhen Sie schrittweise die Anzahl der ausgegebenen Fortschrittsmeldungen.

`-q, --quiet`

Ermöglicht das schrittweise Verringern der Anzahl der gedruckten Statusmeldungen.

`--verbosity=<level>`

          \[[Erweitert] Legen Sie explizit den Ausführlichkeitsgrad auf „errors“, „warnings“, „progress“, „progress+“, „progress++“ oder „progress+++“ fest. Ü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.

Wer kann dieses Feature verwenden?

In diesem Artikel