Anpassen von Einstellungen

Informationen zu den Einstellungen in der CodeQLVisual Studio Code Erweiterung

Sie können viele Einstellungen für die Erweiterung CodeQL von Visual Studio Code ändern, darunter:

Welche Version der CodeQL CLI Erweiterung verwendet wird.
Wie die Erweiterung frühere Abfragen anzeigt.
Wie die Erweiterung Abfragen ausführt.

Bearbeitungseinstellungen für die CodeQL Erweiterung

Öffnen Sie die Ansicht "Erweiterungen", und klicken Sie mit der rechten Maustaste CodeQL, und klicken Sie dann auf Erweiterungseinstellungen.
Bearbeiten Sie im Fenster „Einstellungen“ Einstellungen nach Bedarf. Die neuen Einstellungen werden automatisch gespeichert.

Tipp

Alternativ können Sie die Einstellungen im JSON-Format bearbeiten, indem Sie VS Code Command Palette öffnen und "Einstellungen: Benutzereinstellungen (JSON) öffnen" auswählen.

Eine Version von CodeQL CLI auswählen

Um das Standardverhalten außer Kraft zu setzen und eine bestimmte Version der CodeQL CLIDatei zu verwenden, können Sie den CodeQL CLI "Ausführbaren Pfad" in den Erweiterungseinstellungen angeben und auf Ihre vorhandene Kopie der CodeQL CLIErweiterung verweisen. Das heißt, die Datei mit dem Namen codeql (Linux und macOS) oder codeql.exe (Windows). Weitere Informationen zum Standardverhalten findest du unter Das Verwalten der CodeQL-CLI in der VS Code-Erweiterung.

Ändern der Bezeichnungen von Abfrageverlaufselementen

Die Einstellung „Format“ für den Abfrageverlauf steuert, wie die Erweiterung Abfragen im Abfrageverlauf auflistet. Standardmäßig verfügt jedes Element über eine Bezeichnung mit dem folgenden Format:

QUERY-NAME on DATABASE-NAME - QUERY-STATUS NUMBER-OF-RESULTS [QUERY-RUNTIME]

Um die Standardbezeichnung außer Kraft zu setzen, können Sie ein anderes Format für die Abfrageverlaufselemente angeben.

Ändern des Aufbewahrungszeitraums für Abfrageverlaufselemente

Standardmäßig werden Elemente in der Ansicht „Abfrageverlauf“ 30 Tage lang aufbewahrt. Sie können eine andere Gültigkeitsdauer (TTL) festlegen, indem Sie die Einstellung „Abfrageverlauf: Ttl“ ändern. Wenn Elemente unbegrenzt aufbewahrt werden sollen, legen Sie den Wert auf 0 fest.

Konfigurieren von Einstellungen für die lokale Ausführung von Abfragen

Es gibt eine Reihe von Einstellungen unter „Ausführen von Abfragen“. Wenn Ihre Abfragen z. B. zu langsam ausgeführt werden und häufig ein Timeout auftritt, können Sie den Arbeitsspeicher erhöhen, indem Sie die Einstellung „Abfragen ausführen: Speicher“ ändern.

Wenn Sie die Abfrageleistung untersuchen möchten, aktivieren Sie die Einstellung „Ausführen von Abfragen: Debuggen“, um Laufzeit und Tupelanzahl einzuschließen. Dies wird dann in den Protokollen auf der CodeQL Registerkarte "Abfrageserver" der Ansicht "Ausgabe" angezeigt. Die Tupelanzahl ist nützlich, da sie die Größe der von der Abfrage berechneten Prädikate angibt.

Um Abfrageserverprotokolle an einem benutzerdefinierten Speicherort zu speichern, bearbeiten Sie die Einstellung „Ausführen von Abfragen: Benutzerdefiniertes Protokollverzeichnis“. Wenn Sie ein benutzerdefiniertes Protokollverzeichnis verwenden, speichert die Erweiterung die Protokolle dauerhaft, anstatt sie nach jeder Arbeitsbereichssitzung automatisch zu löschen. Dies ist nützlich, wenn Sie diese Protokolle untersuchen möchten, um die Leistung Ihrer Abfragen zu verbessern.

Konfigurieren von Einstellungen für die Variantenanalyse

Sie können die in der Ansicht "Variant Analysis Repositories" angezeigten Elemente auch bearbeiten, indem Sie eine Datei in Ihrem Visual Studio Code Arbeitsbereich namens databases.json bearbeiten. Diese Datei enthält eine JSON-Darstellung aller Elemente, die in der Ansicht angezeigt werden. Um die databases.json-Datei in einem Editorfenster zu öffnen, klicken Sie oben rechts in der Ansicht „Variantenanalyse-Repositorys“ auf das Symbol { }. Anschließend können Sie eine strukturierte Darstellung der Repositorys, Organisationen und Listen in Ihrer Ansicht anzeigen. Beispiel:

{
  "version": 1,
  "databases": {
    "variantAnalysis": {
      "repositoryLists": [
        {
          "name": "My favorite JavaScript repos",
          "repositories": [
            "facebook/react",
            "babel/babel",
            "angular/angular"
          ]
        }
      ],
      "owners": [
        "microsoft"
      ],
      "repositories": [
        "apache/hadoop"
      ]
    }
  },
  "selected": {
    "kind": "variantAnalysisSystemDefinedList",
    "listName": "top_10"
  }
}

Sie können die in der Ansicht angezeigten Elemente ändern oder neue Elemente hinzufügen, indem Sie diese Datei direkt bearbeiten.

Konfigurieren von Einstellungen zum Hinzufügen von Datenbanken

Um Ihrem Arbeitsbereich automatisch Datenbankquellordner hinzuzufügen, können Sie die Einstellung „Datenbankquelle zum Arbeitsbereich hinzufügen“ aktivieren.

Diese Einstellung ist standardmäßig deaktiviert. Sie können die Einstellung aktivieren, wenn Sie regelmäßig den Quellcode von Datenbanken durchsuchen (z. B. um die abstrakte Syntaxstruktur des Codes anzuzeigen). Weitere Informationen findest du unter Untersuchen der Struktur Ihres Quellcodes.

Hinweis

Wenn Sie sich in einem Arbeitsbereich mit einem einzigen Ordner befinden, bewirkt das Hinzufügen von Datenbankquellordnern, dass der Arbeitsbereich als Mehrstammarbeitsbereich neu geladen wird. Dies kann dazu führen, dass der Abfrageverlauf und Datenbanklisten zurückgesetzt werden.

Bevor Sie diese Einstellung aktivieren, empfiehlt es sich, den Arbeitsbereich als Mehrstammarbeitsbereich zu speichern. Weitere Informationen finden Sie in der Dokumentation unter Visual Studio Code.

        [Benutzer- und Arbeitsbereichseinstellungen](https://code.visualstudio.com/docs/configure/settings) in der Visual Studio Code Dokumentation

In diesem Artikel