Ta strona została przetłumaczona przez Cloud Translation API.

Poznawanie wydajności zapytań za pomocą funkcji Query Explain

Wyjaśnienie zapytania pozwala przesyłać zapytania Cloud Firestore do backendu i otrzymywać szczegółowe statystyki wydajności wykonywania zapytań w backendzie. Działa jak operacja EXPLAIN [ANALYZE] w wielu systemach relacyjnych baz danych.

Żądania zapytania Explain można wysyłać za pomocą bibliotek klienta serwera Firestore.

Wyniki Wyjaśnienia zapytania pomagają zrozumieć, jak są wykonywane zapytania, co wskazuje na niewydajność i lokalizację potencjalnych wąskich gardła po stronie serwera.

Wyjaśnienie zapytania:

Udostępnia statystyki na temat etapu planowania zapytań, dzięki czemu możesz dostosować indeksy zapytań i zwiększyć wydajność.
Dzięki opcji analizy możesz poznać koszty i wydajność zapytań w odniesieniu do konkretnych zapytań, a także szybko powtarzać te wzorce, aby zoptymalizować ich wykorzystanie.

Opcje wyjaśnienia zapytania: domyślne i analiza

Operacje Query Explain można wykonywać za pomocą opcji default (domyślnej) lub analyze (Analiza)

W przypadku opcji domyślnej Query Explain planuje wykonanie zapytania, ale pomija etap wykonywania. Spowoduje to zwrócenie informacji o etapie planera. W ten sposób możesz sprawdzić, czy zapytanie ma niezbędne indeksy, i dowiedzieć się, które indeksy są używane. Pomoże Ci to na przykład sprawdzić, czy dane zapytanie korzysta z indeksu złożonego, a nie tylko do wielu różnych indeksów.

W przypadku opcji analizy zapytanie wyjaśnia zarówno plany, jak i wykonuje zapytanie. Spowoduje to zwrócenie wszystkich wymienionych wcześniej informacji o planerze wraz ze statystykami ze środowiska wykonawczego wykonywania zapytań. Obejmuje to informacje rozliczeniowe zapytania razem ze statystykami na poziomie systemu związanymi z wykonaniem zapytania. Za pomocą tego narzędzia możesz testować różne konfiguracje zapytań i indeksów, aby zoptymalizować ich koszty i czas oczekiwania.

Ile kosztuje zapytanie Explain?

Gdy używasz metody Query Explain z opcją domyślną, nie są wykonywane żadne operacje indeksowania ani odczytu. Niezależnie od złożoności zapytania naliczana jest jedna operacja odczytu.

Gdy używasz Query Explain z opcją analizy, wykonywane są operacje indeksowania i odczytu, więc opłaty za zapytanie są naliczane jak zwykle. Nie ma dodatkowych opłat za działania związane z analizą, a jedynie standardowe opłaty za wykonywanie zapytań.

Użyj rozszerzenia Query Explain z opcją domyślną

Aby przesłać żądanie opcji domyślnej, możesz użyć bibliotek klienta.

Pamiętaj, że żądania są uwierzytelniane za pomocą uprawnień z użyciem tych samych uprawnień w przypadku zwykłych operacji dotyczących zapytań. Inne techniki uwierzytelniania, np. Uwierzytelnianie Firebase, są ignorowane. Więcej informacji znajdziesz w przewodniku na temat uprawnień bibliotek klienta serwera.

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

Węzeł (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;

Dokładny format odpowiedzi zależy od środowiska wykonawczego. Zwrócone wyniki można przekonwertować do formatu JSON. Przykład:

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

Więcej informacji znajdziesz w dokumentacji raportu Wyjaśnienie zapytania.

Użyj rozszerzenia Query Explain z opcją analizy

Aby przesłać żądanie opcji analizy, możesz użyć bibliotek klienta.

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

Węzeł (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;

Poniższy przykład pokazuje obiekt stats zwrócony oprócz planInfo. Dokładny format odpowiedzi zależy od środowiska wykonawczego. Przykładowa odpowiedź jest w formacie 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",
               }
    }

}

Więcej informacji znajdziesz w dokumentacji raportu Wyjaśnienie zapytania.

Interpretowanie wyników i wprowadzanie korekt

Przeanalizujmy przykładowy scenariusz, w którym wyszukujemy filmy według gatunku i kraju produkcji.

Na potrzeby ilustracji załóżmy, że jest to odpowiednik tego zapytania SQL.

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

Jeśli użyjesz opcji analizy, zwrócone dane pokazują, że zapytanie zostało uruchomione w 2 indeksach z pojedynczym polem: (category ASC, __name__ ASC) i (country ASC, __name__ ASC). Skanuje 16 500 wpisów indeksu, ale zwraca tylko 1200 dokumentów.

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

Aby zoptymalizować wydajność wykonywania zapytania, możesz utworzyć w pełni pokryty indeks złożony (category ASC, country ASC, __name__ ASC).

Uruchamiając zapytanie ponownie z opcją analizy, widzimy, że dla tego zapytania wybrany został nowo utworzony indeks, dzięki czemu zapytanie działa znacznie szybciej i bardziej wydajnie.

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