Abfrageausführung mit Query Explain analysieren

Auf dieser Seite wird beschrieben, wie Sie Informationen zur Abfrageausführung abrufen, wenn Sie eine Abfrage ausführen.

Query Explain verwenden

Mit Query Explain können Sie nachvollziehen, wie Ihre Abfragen ausgeführt werden. Sie erhalten Details, mit denen Sie Ihre Abfragen optimieren können.

Sie können Query Explain über die Google Cloud Console oder die Firestore-Server-Clientbibliotheken verwenden.

Console

Führen Sie eine Abfrage im Abfrageeditor aus und öffnen Sie den Tab Erklärung:

  1. Rufen Sie in der Google Cloud Console die Seite Datenbanken auf.

    Zur Seite „Datenbanken“

  2. Wählen Sie in der Liste der Datenbanken eine Firestore-Datenbank aus. In der Google Cloud Console wird der Firestore Explorer für diese Datenbank geöffnet.
  3. Geben Sie eine Abfrage in den Abfrageeditor ein und klicken Sie auf Ausführen.

  4. Klicken Sie auf den Tab Erklärung , um die Ausgabe der Abfrageanalyse anzusehen.

Node.js (Admin)
const q = db.pipeline()
        .collection('/users')
        .sort(field('status').ascending())
        .limit(100);
let results;
try {
    results = await q.execute({
        explainOptions: { mode: 'analyze', outputFormat: 'text' }
    });
} catch (error) {
    console.log(error);
}
const metrics = results?.explainStats?.text;

console.log(metrics);
Java (Admin)
Pipeline q = db.pipeline()
        .collection("/users")
        .sort(field("status").ascending())
        .limit(100);

PipelineExecuteOptions pipelineOpts = new PipelineExecuteOptions().withExplainOptions(
        new ExplainOptions().withExecutionMode(ExplainOptions.ExecutionMode.ANALYZE)
);
Pipeline.Snapshot result = q.execute(pipelineOpts).get();

String metrics = null;
if (result.getExplainStats() != null) {
    metrics = result.getExplainStats().getText();
    System.out.println(metrics);
}

Modi für „Erklären“

Je nachdem, was Sie debuggen möchten, können Sie eine Abfrage mit Query Explain in verschiedenen Modi ausführen:

  • analyze: Plant und führt die Abfrage aus. Gibt neben den regulären Ergebnissen der Abfrage auch Informationen zum Planer, Statistiken zur Laufzeitausführung und Messwerte zurück.

  • explain: Plant die Abfrage, führt sie aber nicht aus. Gibt die Informationen zum Planer, aber keine Laufzeitstatistiken, Messwerte oder Ergebnisse zurück. Dies ist nützlich, um das Verhalten einer Abfrage zu debuggen, ohne kostspielige Vorgänge auszuführen.

  • stats: Plant und führt die Abfrage aus, gibt aber keine Ergebnisse zurück. Gibt Informationen zum Planer, Statistiken zur Laufzeitausführung und Messwerte zurück.

Analyse

Die Ausgabe von Query Explain enthält zwei Hauptkomponenten: die Zusammenfassungsstatistiken und die Ausführungsstruktur. Betrachten Sie diese Abfrage als Beispiel:

db.pipeline().collection('/users').sort(field("status").ascending()).limit(100)

Zusammenfassungsstatistiken

Oben in der erklärten Ausgabe finden Sie eine Zusammenfassung der Ausführungsstatistiken. Anhand dieser Statistiken können Sie feststellen, ob eine Abfrage eine hohe Latenz oder hohe Kosten verursacht. Sie enthält auch Speicherstatistiken, mit denen Sie sehen können, wie nah Ihre Abfrage an den Speicherlimitsliegt.

Execution:
 results returned: 2
 request peak memory usage: 20.25 KiB (20,736 B)
 data bytes read: 148 B
 entity row scanned: 2

Billing:
 read units: 1

Ausführungsstruktur

Die Ausführungsstruktur beschreibt die Abfrageausführung als eine Reihe von Knoten. Die unteren Knoten (Blattknoten) rufen Daten aus der Speicherebene ab, die in der Struktur nach oben durchlaufen werden, um eine Abfrageantwort zu generieren.

Details zu den einzelnen Ausführungsknoten finden Sie in der Ausführungsreferenz.

Informationen dazu, wie Sie diese Informationen verwenden können, um Ihre Abfragen zu optimieren, finden Sie unter Abfrageausführung optimieren.

Im Folgenden sehen Sie ein Beispiel für eine Ausführungsstruktur:

Tree:
• Compute
|  $out_1: map_set($record_1, "__name__", $__name___1, "__key__", unset)
|  is query result: true
|
|  Execution:
|   records returned: 2
|   latency: 5.96 ms (local <1 ms)
|
└── • Compute
    |  $__name___1: map_get($record_1, "__key__")
    |
    |  Execution:
    |   records returned: 2
    |   latency: 5.88 ms (local <1 ms)
    |
    └── • MajorSort
        |  fields: [$v_1 ASC]
        |  output: [$record_1]
        |  limit: 100
        |
        |  Execution:
        |   records returned: 2
        |   latency: 5.86 ms (local <1 ms)
        |   peak memory usage: 20.25 KiB (20,736 B)
        |
        └── • Compute
            |  $v_1: map_get($record_1, "status")
            |
            |  Execution:
            |   records returned: 2
            |   latency: 5.23 ms (local <1 ms)
            |
            └── • TableScan
                   source: /users
                   order: UNDEFINED
                   properties: *
                   row range: (-∞..+∞)
                   output record: $record_1
                   variables: [$record_1]

                   Execution:
                    records returned: 2
                    latency: 4.68 ms
                    records scanned: 2
                    data bytes read: 148 B

Nächste Schritte