Skip to main content

resolve ram

[Deep Plumbing] Bereitet RAM-Optionen vor.

Wer kann dieses Feature verwenden?

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 resolve ram [--ram=<MB>] <options>...

Beschreibung

[Deep Plumbing] Bereitet RAM-Optionen vor.

Dieser Deep Plumbing-Befehl bereitet geeignete Befehlszeilenoptionen vor, um einen Unterbefehl zu starten, der eine QL-Abfrageauswertung ausführt. Er kennt geeignete Heuristiken für die Entscheidung, ob ein Teil des konfigurierten Arbeitsspeichers außerhalb des Java-Heaps beibehalten werden soll.

Er sollte insbesondere verwendet werden, um geeignete Optionen für -J-Xmx und --off-heap-ram zu finden, bevor ein Abfrageserver basierend auf einer gewünschten RAM-Gesamtmenge gestartet wird.

Optionen

Primäre Optionen

--format=<fmt>

Legt ein Ausgabeformat fest. Verfügbare Optionen:

lines (Standard) : Damit werden Befehlszeilenargumente jeweils in einer Zeile ausgegeben.

json: gibt sie als JSON-Array aus.

Optionen von der Befehlszeile des aufrufenden Befehls

-M, --ram=<MB>

Die Abfrageauswertung bemüht sich, ihren Gesamtspeicherbedarf unter diesem Wert zu halten. (Bei großen Datenbanken kann es jedoch vorkommen, dass der Schwellenwert durch dateigesicherte Speicherzuordnungen überschritten wird, die bei Speicherauslastung auf einen Datenträger ausgelagert werden können).

Der Wert sollte mindestens 2048 MB betragen; kleinere Werte werden transparent aufgerundet.

--dataset=<directory>

[Erweitert] Optimieren Sie die RAM-Einstellungen entsprechend für die Abfrage des angegebenen Datasets unter Berücksichtigung von Komponenten der RAM-Nutzung, die mit der Größe der Datenbank skaliert werden. Andernfalls wird eine generische Standardgröße angenommen.

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.