Consulta de referência do relatório de explicação

Consulta de referência do relatório de explicação

Os valores a seguir são retornados como resultados das operações realizadas com Explicação sobre a consulta do Firestore.

Observação: o Query Explain foi criado para análises ad hoc úteis. O relatório formato vai evoluir para maximizar a facilidade de leitura e compreensão, não para o processamento de máquinas. Algumas métricas podem mudar conforme o Firestore evolui (ou seja, as métricas podem ser adicionadas, removidas ou atualizadas) e não são cobertos pela mesma política de descontinuação das outras APIs do Firestore. As tabelas a seguir indicam quais partes dos dados estão sujeitas a mudanças.

Registros do plano

Chave	Tipo	Campo sujeito a mudanças?	Descrição
indexes_used	Lista de structs genéricos	Sim, o conteúdo da resposta struct está sujeito a alterações.	Lista de índices selecionados para esta consulta. Confira abaixo.

Índices usados

O conteúdo dos índices usados está sujeito a mudanças conforme o Firestore evolui.

Chave	Tipo	Descrição
query_scope	String	O escopo em que uma consulta é executada. Por exemplo: Collection, Collection Group e Includes Ancestors.
do bucket	String	Os campos de índice em um formato. Por exemplo, (age ASC, __name__ ASC).

Estatísticas de execução

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

Chave	Tipo	O campo está sujeito a mudanças?	Descrição
results_returned	long	Não	Número total de resultados retornados, 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	long	Não	Total de operações de leitura faturáveis.
debug_stats	Estrutura genérica	Sim, o conteúdo na resposta do Struct está sujeito a alterações.	Estatísticas de depuração da execução da consulta. Consulte abaixo.

Estatísticas de depuração

Os resultados a seguir são úteis para depurar casos de uso e analisar estatísticas opcionais brutas.

O conteúdo das estatísticas de depuração está sujeito a mudanças à medida que o Firestore evolui.

Chave	Tipo	Descrição
index_entries_scanned	String	Número total de entradas de índice inspecionadas durante a consulta.
documents_scanned	String	Número total de documentos verificados durante a consulta.
billing_details	Estrutura genérica	Detalhes de faturamento, incluindo métricas como "documents_billable", "index_entradas_billable", "knn_vector_index_entradas_billable", "min_query_cost".