Wyjaśnienie zapytania umożliwia przesyłanie zapytań Cloud Firestore do backendu i otrzymywanie szczegółowych statystyk wydajności dotyczących wykonywania zapytań w backendzie. Działa ona podobnie do operacji EXPLAIN [ANALYZE] w wielu systemach relacyjnych baz danych.
Żądania wyjaśnienia zapytania można wysyłać za pomocą bibliotek klienta serwera Firestore.
Wyniki Query Explain pomagają zrozumieć, jak są wykonywane zapytania, pokazując nieefektywne elementy i lokalizację prawdopodobnych wąskich gardeł po stronie serwera.
Wyjaśnienie zapytania:
- Dostarcza statystyki dotyczące fazy planowania zapytania, dzięki czemu możesz dostosować indeksy zapytań i zwiększyć wydajność.
- Opcja analizy pomaga zrozumieć koszty i wydajność poszczególnych zapytań oraz szybko przeanalizować różne wzorce zapytań w celu zoptymalizowania ich wykorzystania.
Omówienie opcji wyjaśniania zapytania: domyślna i analiza
Operacje wyjaśniania zapytania można wykonywać za pomocą opcji domyślnej lub analizy.
W przypadku opcji domyślnej funkcja Query Explain planuje zapytanie, ale pomija etap wykonania. Spowoduje to zwrócenie informacji o etapie planowania. Możesz użyć tej funkcji, aby sprawdzić, czy zapytanie ma niezbędne indeksy, i dowiedzieć się, które indeksy są używane. Dzięki temu możesz na przykład sprawdzić, czy konkretne zapytanie używa indeksu złożonego, zamiast przecinać wiele różnych indeksów.
Dzięki opcji analizy funkcja Query Explain planuje i wykonuje zapytanie. Zwraca wszystkie wspomniane wcześniej informacje o planowaniu wraz ze statystykami z czasu wykonywania zapytania. Będą one zawierać informacje rozliczeniowe dotyczące zapytania oraz statystyki na poziomie systemu dotyczące jego wykonania. Za pomocą tego narzędzia możesz testować różne konfiguracje zapytań i indeksów, aby optymalizować ich koszt i opóźnienie.
Ile kosztuje wyjaśnienie zapytania?
Gdy używasz funkcji wyjaśniania zapytania z opcją domyślną, nie są wykonywane żadne operacje indeksowania ani odczytu. Niezależnie od złożoności zapytania naliczana jest opłata za jedną operację odczytu.
Gdy używasz funkcji Query Explain z opcją analizy, wykonywane są operacje indeksowania i odczytu, więc opłata za zapytanie jest naliczana jak zwykle. Za analizę nie jest naliczana dodatkowa opłata, tylko zwykła opłata za wykonanie zapytania.
Korzystanie z wyjaśnienia zapytania 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ń, przy użyciu tych samych uprawnień co w przypadku zwykłych operacji zapytań. Inne techniki uwierzytelniania, takie jak Firebase Authentication, są ignorowane. Więcej informacji znajdziesz w przewodniku na temat uprawnień w bibliotekach 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ć na format 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.
Korzystanie z wyjaśnienia zapytania z opcją analizy
Aby przesłać żądanie opcji analizy, możesz użyć bibliotek klienta.
Pamiętaj, że żądania są uwierzytelniane za pomocą uprawnień, przy użyciu tych samych uprawnień co w przypadku zwykłych operacji zapytań. Inne techniki uwierzytelniania, takie jak Firebase Authentication, są ignorowane. Więcej informacji znajdziesz w przewodniku na temat uprawnień w bibliotekach klienta serwera.
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 zwracany 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 zmian
Przyjrzyjmy się przykładowemu scenariuszowi, w którym wyszukujemy filmy według gatunku i kraju produkcji.
Dla przykładu załóżmy, że jest to odpowiednik tego zapytania SQL.
SELECT * FROM /movies WHERE category = 'Romantic' AND country = 'USA';
Jeśli użyjemy opcji analizy, zwrócone dane pokażą, że zapytanie jest wykonywane na 2 indeksach jednopolowych: (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 wieloskładnikowy (category ASC, country ASC, __name__ ASC).
Jeśli ponownie uruchomimy zapytanie z opcją analizy, zobaczymy, że dla tego zapytania został wybrany nowo utworzony indeks, a zapytanie działa znacznie szybciej i wydajniej.
// 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", } } }