Query Explain позволяет отправлять запросы Cloud Firestore в бэкенд и получать подробную статистику производительности выполнения бэкенд-запросов. Функция работает аналогично операции EXPLAIN [ANALYZE] во многих реляционных системах баз данных.
Запросы Query Explain можно отправлять с использованием клиентских библиотек сервера Firestore .
Результаты Query Explain помогают понять, как выполняются ваши запросы, показывая неэффективность и местоположение вероятных узких мест на стороне сервера.
Запрос Объяснение:
- Предоставляет информацию о этапе планирования запросов, чтобы вы могли скорректировать индексы запросов и повысить эффективность.
- Использование параметра анализа помогает вам оценить затраты и производительность для каждого запроса, а также позволяет быстро перебирать различные шаблоны запросов с целью оптимизации их использования.
Понять параметры объяснения запроса: по умолчанию и анализировать
Операции запроса Explain могут быть выполнены с использованием параметра по умолчанию или параметра анализа .
При использовании параметра по умолчанию Query Explain планирует запрос, пропуская этап выполнения. Это возвращает информацию об этапе планировщика. Это можно использовать для проверки наличия в запросе необходимых индексов и определения используемых индексов. Это поможет, например, убедиться, что в конкретном запросе используется составной индекс, а не пересекаются несколько различных индексов.
При использовании функции анализа Query Explain одновременно планирует и выполняет запрос. В результате возвращается вся ранее упомянутая информация планировщика, а также статистика выполнения запроса. Сюда входят данные о выставлении счетов за запрос и системная информация о его выполнении. Вы можете использовать этот инструментарий для тестирования различных конфигураций запросов и индексов с целью оптимизации их стоимости и задержки.
Сколько стоит Query Explain?
При использовании Query Explain с опцией по умолчанию операции индексирования и чтения не выполняются. Стоимость одной операции чтения взимается независимо от сложности запроса.
При использовании Query Explain с опцией анализа выполняются операции индексирования и чтения, поэтому плата за запрос взимается как обычно. Дополнительная плата за анализ не взимается, взимается только плата за выполнение запроса.
Использовать Query Explain с опцией по умолчанию
Вы можете использовать клиентские библиотеки для отправки запроса на параметры по умолчанию.
Обратите внимание, что запросы аутентифицируются с помощью IAM с использованием тех же разрешений, что и для обычных операций запроса. Другие методы аутентификации, например, Firebase Authentication , игнорируются. Подробнее см. в руководстве по IAM для клиентских библиотек сервера .
Java (Администратор)
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();
Узел (Администратор)
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;
Точный формат ответа зависит от среды выполнения. Возвращаемые результаты можно преобразовать в JSON. Например:
{
"indexes_used": [
{"query_scope": "Collection", "properties": "(category ASC, __name__ ASC)"},
{"query_scope": "Collection", "properties": "(country ASC, __name__ ASC)"},
]
}Более подробную информацию см. в справочнике по отчету «Объяснение запроса» .
Используйте Query Explain с опцией анализа
Вы можете использовать клиентские библиотеки для отправки запроса на вариант анализа.
Обратите внимание, что запросы аутентифицируются с помощью IAM с использованием тех же разрешений, что и для обычных операций запроса. Другие методы аутентификации, например, Firebase Authentication , игнорируются. Подробнее см. в руководстве по IAM для клиентских библиотек сервера .
Java (Администратор)
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();
Узел (Администратор)
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;
В следующем примере показан объект stats , возвращаемый в дополнение к planInfo . Точный формат ответа зависит от среды выполнения. В примере ответ представлен в формате 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",
}
}
}Более подробную информацию см. в справочнике по отчету «Объяснение запроса» .
Интерпретируйте результаты и внесите коррективы
Давайте рассмотрим пример сценария, в котором мы запрашиваем фильмы по жанру и стране производства.
Для иллюстрации предположим эквивалент этого SQL-запроса.
SELECT * FROM /movies WHERE category = 'Romantic' AND country = 'USA';
Если использовать опцию анализа, возвращаемые метрики показывают, что запрос выполняется по двум индексам с одним полем: (category ASC, __name__ ASC) и (country ASC, __name__ ASC) . Он сканирует 16500 записей индекса, но возвращает только 1200 документов.
// 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", } } }
Для оптимизации производительности выполнения запроса можно создать полностью покрытый составной индекс (category ASC, country ASC, __name__ ASC) .
Запустив запрос еще раз с опцией анализа, мы видим, что для этого запроса выбран недавно созданный индекс, и запрос выполняется гораздо быстрее и эффективнее.
// 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", } } }