database unbundle

Extrahiert ein CodeQL-Datenbankarchiv

Wer kann dieses Feature verwenden?

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

Öffentliche Repositorys auf GitHub.com, siehe Geschäftsbedingungen für GitHub CodeQL
Organisationseigene Repositorys in GitHub Enterprise Cloud mit aktivierter GitHub Advanced Security

In diesem Artikel

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 database unbundle <options>... -- <archive>

codeql database unbundle <options>... -- <archive>

Dieser Befehl extrahiert ein CodeQL-Datenbankarchiv, das mit codeql database bundle erstellt wurde. Der Vorgang ähnelt dem Entzippen, um die Datenbank zu extrahieren, funktioniert aber in bestimmten Szenarios besser (das Entzippen ist unter Windows sehr langsam) und unterstützt zusätzliche Optionen wie das Festlegen des Namens der extrahierten Datenbank.

Optionen

Primäre Optionen

`<archive>`

[Obligatorisch] Pfad zum CodeQL-Datenbankarchiv, das entzippt werden soll

`--name=<name>`

Der Name, den die erstellte CodeQL-Datenbank erhalten soll. Wenn keiner angegeben ist, wird der Name der Datenbank aus dem Archiv verwendet.

`--target=<target>`

Das Verzeichnis, in dem die CodeQL-Datenbank entzippt werden soll. Wenn keines angegeben ist, wird standardmäßig das aktuelle Arbeitsverzeichnis verwendet.

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.