ExplainMetrics

Explain metrics for the query.

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

object (PlanSummary)

Planning phase information for the query.

executionStats

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
indexesUsed[]

object (Struct format)

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

ExecutionStats

Execution statistics for the query.

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

string (int64 format)

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

executionDuration

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".

readOperations

string (int64 format)

Total billable read operations.

debugStats

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" } }