Index management in Firebase - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is an index in Firebase Firestore?

An index in Firebase Firestore is a way to organize data to make searching and sorting faster. It works like a book's index, helping the database find data quickly without looking through everything.

intermediate

Why do we need composite indexes in Firestore?

Composite indexes are needed when you want to query data using multiple fields together, like filtering by city and sorting by age. Firestore uses composite indexes to speed up these complex queries.

beginner

How can you create an index in Firebase Firestore?

You can create an index in Firestore automatically when a query needs it, by clicking the link in the error message. Or, you can create indexes manually in the Firebase Console under the Indexes tab.

beginner

What happens if a required index is missing for a Firestore query?

If a required index is missing, Firestore will show an error with a direct link to create the needed index. Without the index, the query cannot run efficiently or at all.

intermediate

How does index management affect Firestore costs?

Indexes use storage space and can increase costs because Firestore charges for storage and writes. Managing indexes well helps keep costs low by only creating indexes you really need.

What is the main purpose of an index in Firestore?

A To speed up data queries

B To store user passwords

C To backup data automatically

D To encrypt data

Indexes help Firestore find data faster when you run queries.

When do you need a composite index in Firestore?

A When querying multiple fields together

B When deleting documents

C When querying a single field only

D When exporting data

Composite indexes are for queries that filter or sort by more than one field.

How can you create a missing index after a query error?

A Ignore the error and retry

B Click the link in the error message to create the index

C Restart the Firebase app

D Delete the database

Firestore provides a direct link to create the needed index when a query fails.

What is a downside of having too many indexes in Firestore?

A Slower queries

B Data loss

C Increased storage costs

D No effect

More indexes use more storage, which can increase your Firestore costs.

Where can you manage Firestore indexes manually?

A Firebase Hosting

B Google Docs

C Firebase Authentication

D Firebase Console under Indexes tab

The Firebase Console has a section to view and create indexes manually.

Explain what an index is in Firebase Firestore and why it is important.

Think about how a book index helps you find pages quickly.

Describe how to handle a Firestore query error caused by a missing index.

Firestore guides you to fix missing indexes.

Practice

1.

What is the main purpose of indexes in Firebase Firestore?

easy

A. To speed up searching and sorting data

B. To store large files like images

C. To backup the database automatically

D. To encrypt data for security

Solution

1. Step 1: Understand what indexes do in databases

   Indexes help the database find data faster by organizing it efficiently.

2. Step 2: Apply this to Firebase Firestore

   In Firestore, indexes speed up searching and sorting operations on data.

3. Final Answer:

   To speed up searching and sorting data -> Option A

4. Quick Check:

   Indexes improve query speed = B [OK]

Hint: Indexes speed up queries by organizing data [OK]

Common Mistakes:

• Confusing indexes with file storage
• Thinking indexes backup data
• Assuming indexes encrypt data

2.

Which of the following is the correct way to define a composite index in firestore.indexes.json?

{
  "indexes": [
    {
      "collectionGroup": "users",
      "queryScope": "COLLECTION",
      "fields": [
        {"fieldPath": "age", "order": "ASCENDING"},
        {"fieldPath": "name", "order": "DESCENDING"}
      ]
    }
  ]
}

easy

A. Defines a composite index on 'age' ascending and 'name' descending for 'users' collection

B. Defines a single-field index only on 'age' field

C. Defines an index for storing files in 'users' collection

D. Defines a backup schedule for 'users' collection

Solution

1. Step 1: Read the JSON structure for indexes

   The JSON shows two fields with order specified, which means a composite index.

2. Step 2: Match fields and collectionGroup

   It targets the 'users' collection group with 'age' ascending and 'name' descending order.

3. Final Answer:

   Defines a composite index on 'age' ascending and 'name' descending for 'users' collection -> Option A

4. Quick Check:

   Composite index JSON matches Defines a composite index on 'age' ascending and 'name' descending for 'users' collection [OK]

Hint: Composite index JSON lists multiple fields with order [OK]

Common Mistakes:

• Thinking it defines a single-field index
• Confusing index with file storage or backup
• Ignoring the order property in fields

3.

Given this Firestore query:

db.collection('orders').where('status', '==', 'shipped').orderBy('date', 'desc')

Which index is required to support this query?

medium

A. No index needed for this query

B. Single-field index on 'date' only

C. Composite index on fields 'status' (ASCENDING) and 'date' (DESCENDING)

D. Composite index on 'date' (ASCENDING) and 'status' (DESCENDING)

Solution

1. Step 1: Identify query filters and sort

   The query filters by 'status' equal to 'shipped' and orders by 'date' descending.

2. Step 2: Determine required index fields and order

   Firestore needs a composite index with 'status' ascending (default for equality) and 'date' descending as per orderBy.

3. Final Answer:

   Composite index on fields 'status' (ASCENDING) and 'date' (DESCENDING) -> Option C

4. Quick Check:

   Equality + orderBy needs composite index = A [OK]

Hint: Equality filters + orderBy need composite index [OK]

Common Mistakes:

• Assuming single-field index suffices
• Mixing order directions in index
• Thinking no index is needed

4.

You deployed a new composite index but your Firestore query still fails with an error about missing index. What is the most likely cause?

medium

A. You need to restart your app to apply index changes

B. You forgot to run firebase deploy --only firestore:indexes after editing firestore.indexes.json

C. You used the wrong database URL

D. Your query does not need any index

Solution

1. Step 1: Understand index deployment process

   Editing firestore.indexes.json only changes local config; deployment is needed to update Firestore.

2. Step 2: Identify missing deployment command

   If you forget to run firebase deploy --only firestore:indexes, Firestore won't have the new index.

3. Final Answer:

   You forgot to run firebase deploy --only firestore:indexes after editing firestore.indexes.json -> Option B

4. Quick Check:

   Index changes require deploy command = D [OK]

Hint: Always deploy indexes after editing JSON file [OK]

Common Mistakes:

• Assuming query needs no index
• Thinking app restart applies index
• Confusing database URL with index issues

5.

You want to optimize a Firestore query that filters by category and price, and sorts by rating. Which index should you create?

{
  "collectionGroup": "products",
  "queryScope": "COLLECTION",
  "fields": [
    {"fieldPath": "category", "order": "ASCENDING"},
    {"fieldPath": "price", "order": "ASCENDING"},
    {"fieldPath": "rating", "order": "DESCENDING"}
  ]
}

Why is this index necessary?

hard

A. It stores large files related to 'products'

B. It backs up the 'products' collection automatically

C. It encrypts the 'products' data for security

D. It supports filtering on 'category' and 'price' and sorting by 'rating' efficiently

Solution

1. Step 1: Analyze query requirements

   The query filters on 'category' and 'price' and sorts by 'rating'. All three fields must be indexed.

2. Step 2: Understand composite index role

   A composite index with these fields and orders allows Firestore to quickly find and sort matching documents.

3. Step 3: Confirm index JSON matches query needs

   The JSON defines a composite index on 'category' ASC, 'price' ASC, and 'rating' DESC, matching the query.

4. Final Answer:

   It supports filtering on 'category' and 'price' and sorting by 'rating' efficiently -> Option D

5. Quick Check:

   Composite index matches filters + sort = A [OK]

Hint: Composite index must cover all filters and sort fields [OK]

Common Mistakes:

• Thinking index backs up or encrypts data
• Ignoring the order of fields in index
• Creating single-field indexes only