ExplainMetrics

Explain metrics for the query.

JSON representation
 { 
 "planSummary" 
 : 
 { 
 object (  PlanSummary 
 
) 
 } 
 , 
 "executionStats" 
 : 
 { 
 object (  ExecutionStats 
 
) 
 } 
 } 
Fields
plan Summary

object ( PlanSummary )

Planning phase information for the query.

execution Stats

object ( ExecutionStats )

Aggregated stats from the execution of the query. Only present when ExplainOptions.analyze is set to true.

PlanSummary

Planning phase information for the query.

JSON representation
 { 
 "indexesUsed" 
 : 
 [ 
 { 
 object 
 } 
 ] 
 } 
Fields
indexes Used[]

object ( Struct format)

The indexes selected for the query. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, nameASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, nameASC)"} ]

ExecutionStats

Execution statistics for the query.

JSON representation
 { 
 "resultsReturned" 
 : 
 string 
 , 
 "executionDuration" 
 : 
 string 
 , 
 "readOperations" 
 : 
 string 
 , 
 "debugStats" 
 : 
 { 
 object 
 } 
 } 
Fields
results Returned

string ( int64 format)

Total number of results returned, including documents, projections, aggregation results, keys.

execution Duration

string ( Duration format)

Total time to execute the query in the backend.

A duration in seconds with up to nine fractional digits, ending with ' s '. Example: "3.5s" .

read Operations

string ( int64 format)

Total billable read operations.

debug Stats

object ( Struct format)

Debugging statistics from the execution of the query. Note that the debugging stats are subject to change as Firestore evolves. It could include: { "indexes_entries_scanned": "1000", "documents_scanned": "20", "billing_details" : { "documents_billable": "20", "index_entries_billable": "1000", "min_query_cost": "0" } }

Design a Mobile Site
View Site in Mobile | Classic
Share by: