Query Explain report reference
Stay organized with collections
Save and categorize content based on your preferences.
The following values are returned as results to operations performed with
Firestore Query Explain.
Plan records
Key |
Type |
Field subject to change? |
Description |
indexes_used
|
List of Generic Structs
|
Yes, 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.
Key |
Type |
Description |
query_scope
|
String
|
The scope at which a query is run. For example:
Collection , Collection Group
and Includes Ancestors .
|
properties
|
String
|
The index fields in a format. For example:
(age ASC, __name__ ASC) .
|
Execution statistics
Aggregated execution statistics for the query.
Key
|
Type
|
Field subject to change?
|
Description
|
results_returned
|
long
|
No
|
Total number of results returned, including documents, projections,
aggregation results, keys.
|
execution_duration
|
Duration
|
No
|
Total time to execute the query in the backend.
|
read_operations
|
long
|
No
|
Total billable read operations.
|
debug_stats
|
Generic Struct
|
Yes, 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.
Key
|
Type
|
Description
|
index_entries_scanned
|
String
|
Total number of index entries inspected during the query.
|
documents_scanned
|
String
|
Total number of documents scanned during the query.
|
billing_details
|
Generic Struct
|
Billing details including metrics like: "documents_billable",
"index_entries_billable", "knn_vector_index_entries_billable", "min_query_cost".
|
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-09-23 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"
}]
{"lastModified": "Last updated 2024-09-23 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-09-23 UTC."]]