Query Explain report reference

The following values are returned as results to operations performed with Firestore Query Explain.

Plan records

KeyTypeField subject to change?Description
indexes_usedList of Generic StructsYes, the contents in the Struct response are subject to change.List of indexes selected for this query. See below.

Indexes used

The contents of indexes used are subject to change as Cloud Firestore evolves.

KeyTypeDescription
query_scopeStringThe scope at which a query is run. For example: Collection, Collection Group and Includes Ancestors.
propertiesStringThe index fields in a format. For example: (age ASC, __name__ ASC).

Execution statistics

Aggregated execution statistics for the query.

KeyTypeField subject to change?Description
results_returnedlongNoTotal number of results returned, including documents, projections, aggregation results, keys.
execution_durationDurationNoTotal time to execute the query in the backend.
read_operationslongNoTotal billable read operations.
debug_statsGeneric StructYes, the contents in the Struct response are subject to change.Debugging statistics from the execution of the query. See below.

Debug statistics

The following results are helpful for debugging use cases and analysis of raw, optional statistics.

The contents of debug statistics are subject to change as Cloud Firestore evolves.

KeyTypeDescription
index_entries_scannedStringTotal number of index entries inspected during the query.
documents_scannedStringTotal number of documents scanned during the query.
billing_detailsGeneric StructBilling details including metrics like: "documents_billable", "index_entries_billable", "knn_vector_index_entries_billable", "min_query_cost".