Referência do relatório de explicação de consultas

Referência do relatório de explicação de consultas

Os seguintes valores são devolvidos como resultados das operações realizadas com Firestore Query Explain.

Nota: a explicação de consultas foi concebida para uma análise ad hoc útil. O formato do relatório vai evoluir para maximizar a facilidade de leitura e compreensão, e não a adequação ao processamento automático. Espera-se que algumas métricas mudem à medida que o Firestore no modo nativo evolui (ou seja, as métricas podem ser adicionadas, removidas ou atualizadas) e não estão abrangidas pela mesma política de descontinuação que outras APIs do Firestore no modo nativo. As tabelas seguintes indicam que partes dos dados estão sujeitas a alterações.

Registos do plano

Chave	Tipo	Campo sujeito a alterações?	Descrição
indexes_used	Lista de estruturas genéricas	Sim, os conteúdos na resposta Struct estão sujeitos a alterações.	Lista de índices selecionados para esta consulta. Consulte abaixo.

Índices usados

O conteúdo dos índices usados está sujeito a alterações à medida que o Firestore no modo nativo evolui.

Chave	Tipo	Descrição
query_scope	String	O âmbito no qual uma consulta é executada. Por exemplo: Collection, Collection Group e Includes Ancestors.
propriedades	String	Os campos de índice num formato. Por exemplo: (age ASC, __name__ ASC).

Estatísticas de execução

Estatísticas de execução agregadas para a consulta.

Chave	Tipo	Campo sujeito a alterações?	Descrição
results_returned	longo	Não	Número total de resultados devolvidos, incluindo documentos, projeções, resultados de agregação e chaves.
execution_duration	Duração	Não	Tempo total para executar a consulta no back-end.
read_operations	longo	Não	Total de operações de leitura faturáveis.
debug_stats	Generic Struct	Sim, os conteúdos na resposta Struct estão sujeitos a alterações.	Depuração de estatísticas da execução da consulta. Consulte abaixo.

Estatísticas de depuração

Os resultados seguintes são úteis para depurar exemplos de utilização e analisar estatísticas opcionais não processadas.

O conteúdo das estatísticas de depuração está sujeito a alterações à medida que o Firestore no modo nativo evolui.

Chave	Tipo	Descrição
index_entries_scanned	String	O número total de entradas de índice inspecionadas durante a consulta.
documents_scanned	String	O número total de documentos analisados durante a consulta.
billing_details	Generic Struct	Detalhes de faturação, incluindo métricas como: "documents_billable", "index_entries_billable", "knn_vector_index_entries_billable", "min_query_cost".