Analizza l'esecuzione delle query con Query Explain

Query Explain ti consente di inviare Cloud Firestore query al backend e ricevere in cambio statistiche dettagliate sul rendimento dell'esecuzione delle query backend. Funziona come l'operazione EXPLAIN [ANALYZE] in molti sistemi di database relazionali.

Le richieste di Query Explain possono essere inviate utilizzando le librerie client server di Firestore.

I risultati di Query Explain ti aiutano a capire come vengono eseguite le query, mostrandoti le inefficienze e la posizione dei probabili colli di bottiglia lato server.

Query Explain:

  • Fornisce informazioni dettagliate sulla fase di pianificazione delle query, in modo che tu possa modificare gli indici delle query e aumentare l'efficienza.
  • Utilizzando l'opzione di analisi, ti aiuta a comprendere i costi e il rendimento per ogni query e ti consente di eseguire rapidamente l'iterazione di diversi pattern di query per ottimizzarne l'utilizzo.

Informazioni sulle opzioni di Query Explain: predefinita e analizza

Le operazioni di Query Explain possono essere eseguite utilizzando l'opzione predefinita o analizza opzione.

Con l'opzione predefinita, Query Explain pianifica la query, ma salta la fase di esecuzione. Vengono restituite le informazioni sulla fase di pianificazione. Puoi utilizzarla per verificare che una query abbia gli indici necessari e per capire quali indici vengono utilizzati. In questo modo, ad esempio, puoi verificare che una determinata query utilizzi un indice composito anziché dover intersecare molti indici diversi.

Con l'opzione di analisi, Query Explain pianifica ed esegue la query. Vengono restituite tutte le informazioni di pianificazione menzionate in precedenza, insieme alle statistiche del runtime di esecuzione della query. Sono incluse le informazioni di fatturazione della query e informazioni a livello di sistema sull'esecuzione della query. Puoi utilizzare questo strumento per testare varie configurazioni di query e indici per ottimizzarne il costo e la latenza.

Quanto costa Query Explain?

Quando utilizzi Query Explain con l'opzione predefinita, non vengono eseguite operazioni di indice o di lettura vengono eseguite. Indipendentemente dalla complessità della query, viene addebitata un'operazione di lettura.

Quando utilizzi Query Explain con l'opzione di analisi, vengono eseguite operazioni di indice e di lettura, quindi la query viene addebitata come di consueto. Non sono previsti costi aggiuntivi per l'attività di analisi, ma solo il costo normale per la query in esecuzione.

Utilizzare Query Explain con l'opzione predefinita

Puoi utilizzare le librerie client per inviare una richiesta di opzione predefinita.

Tieni presente che le richieste vengono autenticate con IAM, utilizzando le stesse autorizzazioni per le normali operazioni di query. Altre tecniche di autenticazione, come Firebase Authentication, vengono ignorate. Per saperne di più, consulta la guida su IAM per le librerie client server.

Java (amministratore)

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();
Node (amministratore)

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;

Il formato esatto della risposta dipende dall'ambiente di esecuzione. I risultati restituiti possono essere convertiti in JSON. Ad esempio:

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

Per saperne di più, consulta il riferimento del report di Query Explain.

Utilizzare Query Explain con l'opzione di analisi

Puoi utilizzare le librerie client per inviare una richiesta di opzione di analisi.

Tieni presente che le richieste vengono autenticate con IAM, utilizzando le stesse autorizzazioni per le normali operazioni di query. Altre tecniche di autenticazione, come Firebase Authentication, vengono ignorate. Per saperne di più, consulta la guida su IAM per le librerie client server.

Java (amministratore)

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();
Node (amministratore)

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;

L'esempio seguente mostra l'oggetto stats restituito oltre a planInfo. Il formato esatto della risposta dipende dall'ambiente di esecuzione. La risposta di esempio è in formato JSON.

{
    "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",
               }
    }

}

Per saperne di più, consulta il riferimento del report di Query Explain.

Interpretare i risultati ed effettuare modifiche

Esaminiamo uno scenario di esempio in cui eseguiamo una query sui film per genere e paese di produzione.

A titolo illustrativo, supponiamo l'equivalente di questa query SQL.

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

Se utilizziamo l'opzione di analisi, le metriche restituite mostrano che la query viene eseguita su due indici a campo singolo, (category ASC, __name__ ASC) e (country ASC, __name__ ASC). Scansiona 16.500 voci di indice, ma restituisce solo 1200 documenti. 

// 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",
               }
    }
}

Per ottimizzare il rendimento dell'esecuzione della query, puoi creare un indice composito completamente coperto (category ASC, country ASC, __name__ ASC).

Se eseguiamo di nuovo la query con l'opzione di analisi, possiamo vedere che l' indice appena creato è selezionato per questa query e che la query viene eseguita molto più velocemente ed efficientemente.

// 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",
               }
    }
}