Abfrageleistung mit Query Explain verstehen

Mit Query Explain können Sie Firestore-Abfragen an den Backend und erhalten detaillierte Leistungsstatistiken zur Ausführung von Backend-Abfragen im Gegenzug erhalten. Sie funktioniert in vielen Fällen wie die EXPLAIN [ANALYZE]-Operation. relationale Datenbanksysteme.

Query Explain-Anfragen können mithilfe der Firestore-Server-Clientbibliotheken gesendet werden.

Die Ergebnisse von Query Explain helfen Ihnen, Ihre Abfragen zu verstehen durchgeführt wurde, was auf Ineffizienzen und den Standort wahrscheinlicher und Engpässe erhalten.

Erklärende Abfrage:

  • Bietet Einblicke in die Abfrageplanungsphase, damit Sie Ihre Abfrage anpassen können und die Effizienz steigern.
  • Mit der Option „Analysieren“ können Sie Ihre Kosten und Leistung auf Abfragen ausführen, sodass Sie schnell verschiedene Abfragen durchlaufen um ihre Nutzung zu optimieren.

Optionen von Query Explain verstehen: Standard und Analyse

Query Explain-Vorgänge können mit der default-Option oder Analyse-Option.

Mit der Standardoption plant Query Explain die Abfrage, überspringt aber der Ausführungsphase. Dadurch werden Informationen zur Planerphase zurückgegeben. Sie können können Sie so prüfen, ob eine Abfrage über die erforderlichen Indexe verfügt, und ermitteln, Indexe verwendet werden. So können Sie z. B. prüfen, ob eine bestimmte verwendet einen zusammengesetzten Index, anstatt sich mit vielen verschiedenen Indexe.

Mit der Option „Analysieren“ plant Query Explain und führt Abfrage. Daraufhin werden alle zuvor genannten Planerinformationen Statistiken aus der Laufzeit der Abfrageausführung. Dies beinhaltet die Abrechnung Informationen der Abfrage und Statistiken auf Systemebene Ausführung. Mit diesem Tool können Sie verschiedene Abfrage- und um Kosten und Latenz zu optimieren.

Was kostet Query Explain?

Wenn Sie Query Explain mit der Standardoption verwenden, gibt es keine Index- oder Lesevorgänge durchgeführt werden. Unabhängig von der Komplexität der Abfrage wird ein Lesevorgang berechnet.

Wenn Sie Query Explain mit der Analyseoption verwenden, werden Index- und Lesevorgänge durchgeführt werden, sodass Ihnen die Abfrage wie gewohnt in Rechnung gestellt wird. Es gibt keine weiteren Analyseaktivität berechnet, nur die übliche Gebühr für die Abfrage ausgeführt haben.

Query Explain mit der Standardoption verwenden

Sie können die Clientbibliotheken verwenden, um eine Standardoptionsanfrage zu senden.

Anfragen werden mit IAM authentifiziert, wobei die gleichen Berechtigungen für reguläre Abfragevorgänge. Andere Authentifizierungstechniken wie Firebase Authentication werden sie ignoriert. Weitere Informationen finden Sie im Leitfaden zur IAM für Server-Clientbibliotheken

Java (Administrator)

Query q = db.collection("col").whereGreaterThan("a", 1);
ExplainOptions options = ExplainOptions.builder().build();

ExplainResults<QuerySnapshot> explainResults = q.explain(options).get();
ExplainMetrics metrics = explainResults.getMetrics();
PlanSummary planSummary = metrics.getPlanSummary();
Knoten (Administrator)

const q = db.collection('col').where('country', '=', 'USA');
const options = { analyze : 'false' };

const explainResults = await q.explain(options);

const metrics = explainResults.metrics;
const plan = metrics.planSummary;

Das genaue Format der Antwort hängt von der Ausführungsumgebung ab. Zurückgegebene Ergebnisse können in JSON konvertiert werden. Beispiel:

{
    "indexes_used": [
        {"query_scope": "Collection", "properties": "(category ASC, __name__ ASC)"},
        {"query_scope": "Collection", "properties": "(country ASC, __name__ ASC)"},
    ]
}

Weitere Informationen finden Sie in der Referenz zum Bericht „Query Explain“.

Query Explain mit der Analyseoption verwenden

Sie können die Clientbibliotheken verwenden, um eine Anfrage zur Analyseoption zu senden.

Anfragen werden mit IAM authentifiziert, wobei die gleichen Berechtigungen für reguläre Abfragevorgänge. Andere Authentifizierungstechniken wie Firebase Authentication werden sie ignoriert. Weitere Informationen finden Sie im Leitfaden zur IAM für Server-Clientbibliotheken

Java (Administrator)

Query q = db.collection("col").whereGreaterThan("a", 1);

ExplainOptions options = ExplainOptions.builder().setAnalyze(true).build();

ExplainResults<QuerySnapshot> explainResults = q.explain(options).get();

ExplainMetrics metrics = explainResults.getMetrics();
PlanSummary planSummary = metrics.getPlanSummary();
List<Map<String, Object>> indexesUsed = planSummary.getIndexesUsed();
ExecutionStats stats = metrics.getExecutionStats();
Knoten (Administrator)

const q = db.collection('col').where('country', '=', 'USA');

const options = { analyze : 'true' };

const explainResults = await q.explain(options);

const metrics = explainResults.metrics;
const plan = metrics.planSummary;
const indexesUsed = plan.indexesUsed;
const stats = metrics.executionStats;

Das folgende Beispiel zeigt das stats-Objekt, das zusätzlich zu planInfo zurückgegeben wird. Das genaue Format der Antwort hängt von der Ausführungsumgebung ab. Die Beispielantwort ist im JSON-Format.

{
    "resultsReturned": "5",
    "executionDuration": "0.100718s",
    "readOperations": "5",
    "debugStats": {
               "index_entries_scanned": "95000",
               "documents_scanned": "5"
               "billing_details": {
                     "documents_billable": "5",
                     "index_entries_billable": "0",
                     "small_ops": "0",
                     "min_query_cost": "0",
               }
    }

}

Weitere Informationen finden Sie in der Referenz zum Bericht „Query Explain“.

Ergebnisse interpretieren und Anpassungen vornehmen

Sehen wir uns ein Beispielszenario an, in dem wir Filme nach Genre und Land der Produktion.

Nehmen wir zur Veranschaulichung an, dass das Äquivalent zu dieser SQL-Abfrage verwendet wird.

SELECT *
FROM /movies
WHERE category = 'Romantic' AND country = 'USA';

Wenn wir die Option „Analysieren“ verwenden, zeigen die zurückgegebenen Messwerte die Abfrage wird auf zwei Einzelfeldindexen ausgeführt, (category ASC, __name__ ASC) und (country ASC, __name__ ASC). Es scannt 16.500 Indexeinträge, gibt aber nur 1200 Dokumente. 

// Output query planning info
{
    "indexes_used": [
        {"query_scope": "Collection", "properties": "(category ASC, __name__ ASC)"},
        {"query_scope": "Collection", "properties": "(country ASC, __name__ ASC)"},
    ]
}

// Output query status
{
    "resultsReturned": "1200",
    "executionDuration": "0.118882s",
    "readOperations": "1200",
    "debugStats": {
               "index_entries_scanned": "16500",
               "documents_scanned": "1200"
               "billing_details": {
                     "documents_billable": "1200",
                     "index_entries_billable": "0",
                     "small_ops": "0",
                     "min_query_cost": "0",
               }
    }
}

Um die Leistung beim Ausführen der Abfrage zu optimieren, können Sie einen vollständig abgedeckter zusammengesetzter Index (category ASC, country ASC, __name__ ASC).

Wenn wir die Abfrage noch einmal mit der Option „Analysieren“ ausführen, Für diese Abfrage wird ein neu erstellter Index ausgewählt und die Abfrage wird viel schneller ausgeführt und effizienter zu gestalten.

// Output query planning info
{
    "indexes_used": [
        {"query_scope": "Collection", "properties": "(category ASC, country ASC,  __name__ ASC)"}
    ]
}

// Output query stats
{
    "resultsReturned": "1200",
    "executionDuration": "0.026139s",
    "readOperations": "1200",
    "debugStats": {
               "index_entries_scanned": "1200",
               "documents_scanned": "1200"
               "billing_details": {
                     "documents_billable": "1200",
                     "index_entries_billable": "0",
                     "small_ops": "0",
                     "min_query_cost": "0",
               }
    }
}