Send feedback
ExplainMetrics
Stay organized with collections
Save and categorize content based on your preferences.
Explain metrics for the query.
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" } }
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-07-08 UTC.
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"Missing the information I need"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"Too complicated / too many steps"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"Out of date"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"Samples / code issue"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
Need to tell us more?
{"lastModified": "Last updated 2024-07-08 UTC."}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-07-08 UTC."]]