Esta página fornece exemplos de estratégia de indexação que devem ser usados para consultas com intervalo e filtros de desigualdade em vários campos para criar uma experiência de consulta eficiente.
Leia sobre os conceitos relacionados antes de otimizar suas consultas.
Otimizar consultas com o Query Explain
Para determinar se a consulta e os índices usados são ideais, use o Query Explain para conferir o resumo do plano de consulta e as estatísticas de execução da consulta:
Java
Query q = db.collection("employees").whereGreaterThan("salary",
100000).whereGreaterThan("experience", 0);
ExplainResults<QuerySnapshot> explainResults = q.explain(ExplainOptions.builder().analyze(true).build()).get();
ExplainMetrics metrics = explainResults.getMetrics();
PlanSummary planSummary = metrics.getPlanSummary();
ExecutionStats executionStats = metrics.getExecutionStats();
System.out.println(planSummary.getIndexesUsed());
System.out.println(stats.getResultsReturned());
System.out.println(stats.getExecutionDuration());
System.out.println(stats.getReadOperations());
System.out.println(stats.getDebugStats());
Node.js
let q = db.collection("employees")
.where("salary", ">", 100000)
.where("experience", ">",0);
let options = { analyze : 'true' };
let explainResults = await q.explain(options);
let planSummary = explainResults.metrics.planSummary;
let stats = explainResults.metrics.executionStats;
console.log(planSummary);
console.log(stats);
O exemplo a seguir mostra como o uso da ordem correta do índice reduz o número de entradas de índice verificadas pelo Cloud Firestore.
Consultas simples
Com o exemplo anterior de um conjunto de funcionários, a consulta simples
executada com o índice (experience ASC, salary ASC)
é a seguinte:
Java
db.collection("employees")
.whereGreaterThan("salary", 100000)
.whereGreaterThan("experience", 0)
.orderBy("experience")
.orderBy("salary");
A consulta verifica 95.000 entradas de índice apenas para retornar cinco documentos. Como o predicado de consulta não é atendido, um grande número de entradas de índice é lido, mas filtrado.
// Output query planning info { "indexesUsed": [ { "properties": "(experience ASC, salary ASC, __name__ ASC)", "query_scope": "Collection" } ], // Output Query Execution Stats "resultsReturned": "5", "executionDuration": "2.5s", "readOperations": "100", "debugStats": { "index_entries_scanned": "95000", "documents_scanned": "5", "billing_details": { "documents_billable": "5", "index_entries_billable": "95000", "small_ops": "0", "min_query_cost": "0" } } }
Podemos inferir, a partir da experiência de domínio, que a maioria dos funcionários terá ao menos alguma experiência, mas poucos terão um salário maior que
100.000. Com esse insight, podemos concluir que a restrição salary
é mais seletiva que a restrição experience
. Para influenciar o índice que o Cloud Firestore usa para executar a consulta, especifique uma cláusula orderBy
que ordene a restrição salary
antes da experience
.
Java
db.collection("employees")
.whereGreaterThan("salary", 100000)
.whereGreaterThan("experience", 0)
.orderBy("salary")
.orderBy("experience");
Quando você usa explicitamente a cláusula orderBy()
para adicionar os predicados, o Cloud Firestore usa o índice (salary ASC, experience ASC)
para executar a
consulta. Assim, como a seletividade do filtro do primeiro intervalo é maior nesta consulta em comparação com
a consulta anterior, ela será executada com mais rapidez e será mais econômica.
// Output query planning info { "indexesUsed": [ { "properties": "(salary ASC, experience ASC, __name__ ASC)", "query_scope": "Collection" } ], // Output Query Execution Stats "resultsReturned": "5", "executionDuration": "0.2s", "readOperations": "6", "debugStats": { "index_entries_scanned": "1000", "documents_scanned": "5", "billing_details": { "documents_billable": "5", "index_entries_billable": "1000", "small_ops": "0", "min_query_cost": "0" } } }
A seguir
- Saiba mais sobre o Query Explain.
- Saiba mais sobre práticas recomendadas de indexação.