Collection group queries in Firebase - Step-by-Step Execution

Process Flow - Collection group queries

Start Query

↓

Specify Collection Group

↓

Search All Subcollections Named Same

↓

Apply Filters/Conditions

↓

Retrieve Matching Documents

↓

Return Results

The query starts by specifying a collection group name, searches all subcollections with that name across the database, applies any filters, and returns matching documents.

Execution Sample

Firebase

db.collectionGroup('messages')
  .where('read', '==', false)
  .get()
  .then(snapshot => {
    // process documents
  });

This query finds all documents in any 'messages' subcollection where 'read' is false.

Process Table

Step	Action	Target	Filter Applied	Documents Found
1	Start query	collectionGroup('messages')	none	none
2	Search all 'messages' subcollections	All 'messages' subcollections	none	all documents in these subcollections
3	Apply filter	read == false	filter documents where read is false	subset of documents
4	Return results	filtered documents	none	documents matching filter

💡 Query completes after filtering all 'messages' subcollections and returning matching documents.

Status Tracker

Variable	Start	After Step 2	After Step 3	Final
documents	empty	all documents in 'messages' subcollections	filtered documents where read == false	filtered documents

Key Moments - 2 Insights

Why does the query search multiple subcollections instead of just one?

Because collection group queries look across all subcollections with the same name anywhere in the database, as shown in execution_table step 2.

How does the filter affect the documents returned?

The filter narrows down documents to only those matching the condition (read == false), as shown in execution_table step 3.

Visual Quiz - 3 Questions

Look at the execution table, at which step are documents filtered by the 'read' field?

A Step 2

B Step 3

C Step 1

D Step 4

💡 Hint

Check the 'Filter Applied' column in the execution_table rows.

According to variable_tracker, what is the state of 'documents' after step 2?

A Empty

B Filtered documents where read == false

C All documents in 'messages' subcollections

D Final filtered documents

💡 Hint

Look at the 'After Step 2' column for 'documents' in variable_tracker.

If the filter condition changed to 'read == true', how would the execution_table row 3 change?

A Filter would be 'read == true' and documents found would be those with read true

B No change, filter stays the same

C Filter would be removed

D Documents found would be all documents

💡 Hint

Refer to the 'Filter Applied' and 'Documents Found' columns in execution_table row 3.

Concept Snapshot

Collection group queries search all subcollections with the same name across the database.
Use collectionGroup('name') to specify the group.
Apply filters with where() to narrow results.
Returns documents from all matching subcollections.
Useful for querying nested data without knowing exact paths.

Full Transcript

Collection group queries in Firebase let you search all subcollections with the same name anywhere in your database. You start by specifying the collection group name. Then the query looks through every subcollection with that name. After that, you can apply filters to find only documents that match certain conditions. Finally, the query returns all documents that meet the criteria. This is helpful when your data is nested and you want to find documents without knowing their exact location. For example, you can find all unread messages across all users by querying the 'messages' collection group where 'read' is false.

Practice

1. What is the main purpose of a collection group query in Firebase Firestore?

easy

A. To delete an entire collection at once

B. To search documents across all collections with the same name

C. To update multiple documents in a single collection

D. To create a new collection with grouped documents

Solution

1. Step 1: Understand collection group queries

   Collection group queries allow searching across all collections that share the same collection name, regardless of their location in the database.

2. Step 2: Compare options

   Only To search documents across all collections with the same name describes searching across all collections with the same name. Other options describe different operations not related to collection group queries.

3. Final Answer:

   To search documents across all collections with the same name -> Option B

4. Quick Check:

   Collection group query = search across same-named collections [OK]

Hint: Collection group queries search all collections named the same [OK]

Common Mistakes:

• Thinking collection group queries update or delete documents
• Confusing collection group queries with single collection queries
• Assuming collection group queries create new collections

2. Which of the following is the correct syntax to create a collection group query for all collections named comments in Firestore?

easy

A. firebase.firestore().collection('comments').where('text', '==', 'hello')

B. firebase.firestore().collection('comments').get()

C. firebase.firestore().collectionGroup('comments').where('text', '==', 'hello')

D. firebase.firestore().collectionGroup('comments').get()

Solution

1. Step 1: Identify collection group query syntax

   The method collectionGroup('collectionName') is used to query all collections with that name.

2. Step 2: Check options

   firebase.firestore().collectionGroup('comments').get() correctly uses collectionGroup('comments') and calls get() to fetch documents. firebase.firestore().collection('comments').get() uses collection which only queries one collection. Options C and D add filters but the question asks for syntax to create the query, not filtering.

3. Final Answer:

   firebase.firestore().collectionGroup('comments').get() -> Option D

4. Quick Check:

   Use collectionGroup('name') for group queries [OK]

Hint: Use collectionGroup('name') to query all same-named collections [OK]

Common Mistakes:

• Using collection() instead of collectionGroup() for group queries
• Adding filters when only syntax for query creation is asked
• Confusing collectionGroup with collectionGroupQuery

3. Given the following Firestore data structure:

users/{userId}/posts/{postId}/comments/{commentId}

What will the following query return?

firebase.firestore().collectionGroup('comments').where('approved', '==', true).get()

medium

A. Only approved comments from the root 'comments' collection

B. All comments regardless of approval status

C. All approved comments from all users' posts

D. Syntax error because nested collections cannot be queried

Solution

1. Step 1: Understand collection group query on nested collections

   The query uses collectionGroup('comments') which searches all collections named 'comments' anywhere in the database, including nested ones.

2. Step 2: Apply the filter condition

   The where('approved', '==', true) filters only comments where the 'approved' field is true.

3. Final Answer:

   All approved comments from all users' posts -> Option C

4. Quick Check:

   collectionGroup + where filters = filtered docs from all same-named collections [OK]

Hint: collectionGroup queries nested collections by name with filters [OK]

Common Mistakes:

• Thinking collectionGroup only queries root collections
• Ignoring the filter condition in the query
• Assuming syntax error for nested collections

4. You wrote this Firestore query:

firebase.firestore().collectionGroup('orders').where('status', '==', 'shipped').get()

But Firestore returns an error asking to create an index. What is the best way to fix this?

medium

A. Create a composite index for the 'orders' collection group on the 'status' field

B. Change the query to use collection() instead of collectionGroup()

C. Remove the where clause to avoid indexing

D. Restart the Firestore service to clear the error

Solution

1. Step 1: Understand Firestore index requirements

   Firestore requires indexes for queries with filters on collection groups to optimize performance.

2. Step 2: Fix the error by creating the required index

   The error message usually provides a link to create the needed composite index on the 'status' field for the 'orders' collection group.

3. Final Answer:

   Create a composite index for the 'orders' collection group on the 'status' field -> Option A

4. Quick Check:

   Index needed for filtered collectionGroup queries [OK]

Hint: Create indexes when Firestore requests for collection group filters [OK]

Common Mistakes:

• Ignoring the index error and expecting query to work
• Switching to collection() which won't query all collections
• Removing filters to avoid indexing, losing query purpose

5. You want to find all reviews documents across your Firestore database where the rating is greater than 4, but only for reviews inside products collections (not other reviews collections). Your data structure is:

products/{productId}/reviews/{reviewId}
services/{serviceId}/reviews/{reviewId}

Which approach correctly achieves this using collection group queries?

hard

A. Use collectionGroup('reviews') and add a filter on a field indicating parent collection is 'products'

B. Use collectionGroup('reviews').where('rating', '>', 4) without filtering parent collection

C. Use collection('products').doc(productId).collection('reviews').where('rating', '>', 4)

D. Use collection('reviews').where('rating', '>', 4) to get all reviews with rating > 4

Solution

1. Step 1: Understand collection group query scope

   collectionGroup('reviews') queries all 'reviews' collections regardless of parent collection.

2. Step 2: Filter by parent collection

   Since you want only reviews under 'products', you must add a filter or structure your data to identify the parent collection, such as a field indicating the parent type.

3. Step 3: Evaluate options

   Use collectionGroup('reviews') and add a filter on a field indicating parent collection is 'products' uses collectionGroup with a filter on a field indicating the parent collection, which is correct. Use collectionGroup('reviews').where('rating', '>', 4) without filtering parent collection lacks filtering by parent. Use collection('products').doc(productId).collection('reviews').where('rating', '>', 4) queries only one product's reviews, not all products. Use collection('reviews').where('rating', '>', 4) to get all reviews with rating > 4 is invalid because 'reviews' is not a root collection.

4. Final Answer:

   Use collectionGroup('reviews') and add a filter on a field indicating parent collection is 'products' -> Option A

5. Quick Check:

   Filter collectionGroup by parent info to limit scope [OK]

Hint: Add parent info filter to collectionGroup queries to limit scope [OK]

Common Mistakes:

• Assuming collectionGroup can filter by parent collection automatically
• Querying only one product's reviews instead of all
• Using collection() on a non-root collection name