Indexes with a collection query scope specified allow queries
against a collection that is the child of a specific document, specified
at query time, and that has the collection id specified by the index.
CollectionGroup
Indexes with a collection group query scope specified allow queries
against all collections that has the collection id specified by the
index.
CollectionRecursive
Include all the collections's ancestor in the index. Only available for
Datastore Mode databases.
Unspecified
The query scope is unspecified. Not a valid option.
[[["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 2025-08-07 UTC."],[[["\u003cp\u003eThe latest version of the \u003ccode\u003eGoogle.Cloud.Firestore.Admin.V1\u003c/code\u003e API is 3.12.0, and this page provides access to documentation for versions ranging from 2.2.0 to 3.12.0.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eIndex.Types.QueryScope\u003c/code\u003e enum is used within the Firestore Admin v1 API to define the scope at which a query is executed, and is specified within the \u003ccode\u003efrom\u003c/code\u003e field of a \u003ccode\u003eStructuredQuery\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThere are four possible fields within the \u003ccode\u003eIndex.Types.QueryScope\u003c/code\u003e enum: \u003ccode\u003eCollection\u003c/code\u003e, \u003ccode\u003eCollectionGroup\u003c/code\u003e, \u003ccode\u003eCollectionRecursive\u003c/code\u003e, and \u003ccode\u003eUnspecified\u003c/code\u003e, each with its own implications for query execution.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eCollection\u003c/code\u003e field allows queries against a collection that is the child of a specific document, while the \u003ccode\u003eCollectionGroup\u003c/code\u003e field allows queries against all collections with a specific ID.\u003c/p\u003e\n"],["\u003cp\u003eThe field \u003ccode\u003eCollectionRecursive\u003c/code\u003e is used to include all of the collections' ancestors within the index, but is only available for Datastore Mode databases.\u003c/p\u003e\n"]]],[],null,[]]
