dataset import

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

Shell

codeql dataset import --dbscheme=<file> [--threads=<num>] <options>... -- <dataset> <trap>...

codeql dataset import --dbscheme=<file> [--threads=<num>] <options>... -- <dataset> <trap>...

Beschreibung

[Plumbing] Importiert TRAP-Dateien in ein unformatiertes Dataset.

Erstelle ein Dataset, indem du es mit TRAP-Dateien auffüllst, oder füge einem vorhandenen Dataset Daten aus TRAP-Dateien hinzu. Das Aktualisieren eines Datasets ist nur möglich, wenn es über das richtige Datenbankschema verfügt und sein ID-Pool vom ersten Import beibehalten wurde.

Optionen

Primäre Optionen

`<dataset>`

[Obligatorisch] Pfad zum unformatierten QL-Dataset, das erstellt oder aktualisiert werden soll. Falls das Verzeichnis noch keine vorhanden ist, wird es erstellt.

`<trap>...`

Pfade zu zu importierenden .trap(.gz)-Dateien oder zu Verzeichnissen, die rekursiv nach .trap(.gz)-Dateien durchsucht werden. Wenn keine Dateien angegeben werden, wird ein leeres Dataset erstellt.

`-S, --dbscheme=<file>`

[Obligatorisch] Die Definition des Datenbankschemas, die die TRAP-Dateien beschreibt, die du importieren möchtest.

`-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.)

`--[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.