Skip to main content

Diese Version von GitHub Enterprise Server wird eingestellt am 2023-12-20. Es wird keine Patch-Freigabe vorgenommen, auch nicht für kritische Sicherheitsprobleme. Für bessere Leistung, verbesserte Sicherheit und neue Features aktualisiere auf die neueste Version von GitHub Enterprise Server. Wende dich an den GitHub Enterprise-Support, um Hilfe zum Upgrade zu erhalten.

query compile

Kompiliert oder überprüft QL-Code.

GitHub CodeQL wird nach der Installation auf Benutzerbasis lizenziert. Du kannst CodeQL nur für bestimmte Aufgaben unter den Lizenzeinschränkungen verwenden. Weitere Informationen findest du unter Informationen zur CodeQL-CLI.

Wenn du über eine GitHub Advanced Security-Lizenz verfügst, kannst du CodeQL für eine automatisierte Analyse sowie für Continuous Integration und Continuous Delivery verwenden. Weitere Informationen findest du unter Informationen zu GitHub Advanced Security.

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 query compile [--check-only] [--keep-going] [--threads=<num>] [--ram=<MB>] <options>... -- <file>...

Beschreibung

Kompiliert oder überprüft QL-Code.

Kompiliert mindestens eine Abfrage. In der Regel ist das Ergebnis dieses Befehls, dass die kompilierte Version der Abfrage in einen Kompilierungscache geschrieben wird, wo sie bei einer späteren Ausführung der Abfrage gefunden werden kann. Andere Ausgabeoptionen dienen hauptsächlich zum Debuggen.

Tastatur

Primäre Optionen

<file>...

[Obligatorisch] Zu kompilierende Abfragen. Jedes Argument ist entweder:

  • Eine zu kompilierende QL-Datei
  • Ein Verzeichnis, das rekursiv nach QL-Dateien durchsucht wird
  • Eine QLS-Datei, die bestimmte Abfragen definiert.
  • Der Basisname einer bekannten QLS-Datei, die von einem der installierten QL-Pakete exportiert wurde.

-n, --check-only

Überprüft lediglich, ob die QL gültig ist, und gibt alle Fehler aus. Der Abfrageplan wird weder optimiert noch gespeichert. Die Ausführung kann erheblich schneller sein als bei einer vollständigen Kompilierung.

--[no-]precompile

[Erweitert] Speichert jede kompilierte Abfrage als Binärdatei (.qlx) an der .ql-Quelle.

Die Verwendung sollte nur beim Vorbereiten eines Abfragepakets für die Verteilung erfolgen (in diesem Fall wird sie automatisch von codeql pack publish verwendet). Wenn .qlx-Dateien vorhanden sind, können spätere Befehle, die Abfragen ausführen, Änderungen an der QL-Quelle zugunsten der vorkompilierten Version ignorieren.

Einige selten verwendete Kompilierungsoptionen sind inkompatibel und führen zu einem Laufzeitfehler.

Verfügbar seit v2.12.0.

--[no-]dump-dil

[Erweitert] gibt beim Kompilieren die optimierte DIL-Zwischendarstellung an der Standardausgabe aus.

Wenn die JSON-Ausgabe ausgewählt wurde, wird die DIL als Array von einzeiligen Zeichenfolgen dargestellt, mit einem Umbruch, um die kompilierte Abfrage zu kennzeichnen.

-k, --[no-]keep-going

Setzt die Kompilierung fort, auch wenn ein Fehler gefunden wird.

--[no-]dump-ra

[Erweitert] Gibt den optimierten RA-Abfrageplan während der Kompilierung an der Standardausgabe aus.

Wenn die JSON-Ausgabe ausgewählt wurde, wird der RA als Array von einzeiligen Zeichenfolgen dargestellt, mit einem Umbruch, um die kompilierte Abfrage zu kennzeichnen.

--format=<fmt>

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

-j, --threads=<num>

Dient zum Festlegen der Anzahl von Threads für die Kompilierung von Abfragen.

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

-M, --ram=<MB>

Legt die Gesamtmenge des RAM fest, die der Compiler verwenden darf.

Optionen zum Steuern der QL-Varianten und Compiler

--warnings=<mode>

Behandeln von Warnungen vom QL-Compiler Enthält einen der folgenden Werte:

hide: unterdrückt Warnungen

show (Standard) : gibt Warnungen aus, setzt die Kompilierung aber fort.

error: behandelt Warnungen als Fehler.

--no-debug-info

Gibt keine Informationen zum Quellspeicherort in RA zum Debuggen aus.

--[no-]fast-compilation

[Veraltet] [Erweitert] Lässt besonders langsame Optimierungsschritte aus.

--no-release-compatibility

[Erweitert] Verwendet die neuesten Compilerfeatures auf Kosten der Portabilität.

Von Zeit zu Zeit werden neue QL-Sprachfeatures und Evaluatoroptimierungen vom QL-Evaluator für einige Releases unterstützt, bevor sie standardmäßig im QL-Compiler aktiviert werden. Dadurch wird sichergestellt, dass die Leistung beim Entwickeln von Abfragen mit dem neuesten CodeQL-Release auch von etwas älteren Releases erreicht werden kann, die möglicherweise noch für die Codeüberprüfung oder CI-Integrationen verwendet werden.

Wenn es für dich nicht wichtig ist, ob deine Abfragen mit anderen (früheren oder späteren) CodeQL-Releases kompatibel sind, kannst du manchmal eine etwas höhere Leistung erzielen, indem du dieses Flag verwendest, um die neuesten Verbesserungen im Compiler frühzeitig zu aktivieren.

Wenn Releases keine neuen Verbesserungen aufweisen, führt diese Option im Hintergrund keine Aktionen aus. Daher kannst du sie bedenkenlos dauerhaft in deiner globalen CodeQL-Konfigurationsdatei festlegen.

Verfügbar seit v2.11.1.

--[no-]local-checking

Führt die anfänglichen Überprüfungen nur für den verwendeten Teil der QL-Quelle durch.

--no-metadata-verification

Überprüft eingebettete Abfragemetadaten in QLDoc-Kommentaren nicht auf Gültigkeit.

--compilation-cache-size=<MB>

[Erweitert] Setzt den Standardwert für die maximale Größe des Verzeichnisse für den Kompilierungscache außer Kraft.

--fail-on-ambiguous-relation-name

[Erweitert] Schlägt die Kompilierung fehl, wenn während der Kompilierung ein mehrdeutiger Beziehungsname generiert wird.

Optionen zum Einrichten der Kompilierungsumgebung

--search-path=<dir>[:<dir>...]

Eine Liste der Verzeichnisse, in denen QL-Pakete gefunden werden können. Jedes Verzeichnis kann entweder ein QL-Paket (oder ein Bündel von Paketen mit einer Datei vom Typ .codeqlmanifest.json am Stamm) oder das unmittelbar übergeordnete Element eines oder mehrerer solcher Verzeichnisse sein.

Wenn der Pfad mehrere Verzeichnisse enthält, definiert deren Reihenfolge ihre Rangfolge: Ist ein Paketname, der aufgelöst werden muss, in mehreren der Verzeichnisstrukturen enthalten, wird die erste Angabe verwendet.

Ein entsprechender Verweis beim Auschecken des Open-Source-CodeQL-Repositorys sollte funktionieren, wenn eine der darin enthaltenen Sprachen abgefragt wird.

Wenn du das CodeQL-Repository als gleichgeordnetes Element der entpackten CodeQL-Toolkette ausgecheckt hast, musst du diese Option nicht verwenden. Solche gleichgeordneten Verzeichnisse werden immer nach QL-Paketen durchsucht, die andernfalls nicht gefunden werden können. (Wenn diese Standardeinstellung nicht funktioniert, solltest du unbedingt --search-path in einer Benutzerkonfigurationsdatei festlegen.)

(Hinweis: Unter Windows wird ; als Pfadtrennzeichen verwendet.)

--additional-packs=<dir>[:<dir>...]

Bei Angabe dieser Verzeichnisliste werden die Verzeichnisse vor den Verzeichnissen in --search-path nach Paketen durchsucht. Die Reihenfolge zwischen diesen Elementen spielt keine Rolle. Wenn ein Paketname über diese Liste an zwei verschiedenen Stellen gefunden wird, handelt es sich um einen Fehler.

Dies ist hilfreich, wenn du vorübergehend eine neue Version eines Pakets entwickelst, die auch am Standardpfad vorhanden ist. Andererseits wird davon abgeraten, diese Option in einer Konfigurationsdatei außer Kraft zu setzen. Einige interne Aktionen fügen diese Option direkt hinzu, wodurch alle konfigurierten Werte überschrieben werden.

(Hinweis: Unter Windows wird ; als Pfadtrennzeichen verwendet.)

--library-path=<dir>[:<dir>...]

[Erweitert] Eine optionale Liste von Verzeichnissen, die dem unformatierten Suchpfad für den Import von QL-Bibliotheken hinzugefügt werden. Sollte nur verwendet werden, wenn du QL-Bibliotheken verwendest, die nicht als QL-Pakete gepackt wurden.

(Hinweis: Unter Windows wird ; als Pfadtrennzeichen verwendet.)

--dbscheme=<file>

[Erweitert] Definiert explizit, für welche Abfragen des Datenbankschemas kompiliert werden sollen. Sollte nur von Aufrufer*innen angegeben werden, die sehr genau wissen, was sie tun.

--compilation-cache=<dir>

[Erweitert] Gibt ein zusätzliches Verzeichnis an, das als Kompilierungscache verwendet werden soll.

--no-default-compilation-cache

[Erweitert] Verwendet keine Kompilierungscaches an Standardspeicherorten, z. B. im QL-Paket mit der Abfrage oder im Verzeichnis der CodeQL-Toolkette.

Optionen zum Konfigurieren des CodeQL-Paket-Managers

--registries-auth-stdin

Führt eine Authentifizierung bei GitHub Enterprise Server-Containerregistrierungen durch, indem eine durch Trennzeichen getrennte Liste von <registry_url>=<token>-Paaren übergeben wird.

Du kannst https://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2 übergeben, um dich bei zwei GitHub Enterprise Server-Instanzen zu authentifizieren.

Dadurch werden die Umgebungsvariablen CODEQL_REGISTRIES_AUTH und GITHUB_TOKEN überschrieben. Wenn du dich nur bei der Containerregistrierung von github.com authentifizieren musst, kannst du dich stattdessen mit der einfacheren Option --github-auth-stdin authentifizieren.

--github-auth-stdin

Authentifiziere dich bei der Containerregistrierung auf github.com, indem du auf github.com ein GitHub Apps-Token oder ein persönliches Zugriffstoken über die Standardeingabe übergibst.

Für die Authentifizierung bei Containerregistrierungen in GitHub Enterprise Server übergibst du --registries-auth-stdin oder verwendest die Umgebungsvariable „CODEQL_REGISTRIES_AUTH“.

Dadurch wird die GITHUB_TOKEN-Umgebungsvariable überschrieben.

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.