Firestore collections and documents in GCP - Mini Project: Build & Apply

Firestore Collections and Documents

📖 Scenario: You are building a simple app to store user profiles in Google Firestore. Each user has a unique ID and some basic information like name and email.

🎯 Goal: Create a Firestore collection called users and add documents with user data. Then configure a query to retrieve users with a specific email domain.

📋 What You'll Learn

Create a Firestore collection named users with three user documents

Each user document must have fields name and email with exact values

Add a configuration variable to filter users by email domain

Write a query to get all users whose email contains the configured domain

💡 Why This Matters

🌍 Real World

Managing user profiles in Firestore is common in apps that need to store and query user data efficiently.

💼 Career

Understanding Firestore collections, documents, and querying is essential for cloud developers working with Google Cloud Platform.

1

Create Firestore collection with user documents

Create a Firestore collection called users with three documents. Each document should have the fields: name and email with these exact values:

- Document ID: user1, name: Alice, email: [e-mail]
- Document ID: user2, name: Bob, email: [e-mail]
- Document ID: user3, name: Charlie, email: [e-mail]

GCP

# Initialize Firestore client and create collection 'users' with documents
# Your code here

Need a hint?

Use client.collection('users') to get the collection reference. Use document('user1').set({...}) to add documents.

2

Add email domain filter configuration

Create a variable called email_domain and set it to the string '@example.com'. This will be used to filter users by their email domain.

GCP

from google.cloud import firestore

client = firestore.Client()

users_ref = client.collection('users')

users_ref.document('user1').set({'name': 'Alice', 'email': '[e-mail]'})
users_ref.document('user2').set({'name': 'Bob', 'email': '[e-mail]'})
users_ref.document('user3').set({'name': 'Charlie', 'email': '[e-mail]'})

# Create email_domain variable
# Your code here

Need a hint?

Just create a variable named email_domain and assign the string '@example.com'.

3

Write query to filter users by email domain

Write a query called query that gets all documents from the users collection where the email field contains the string stored in email_domain. Use Firestore's where method with the operator array_contains is not suitable here, so instead, retrieve all users and filter in Python using a list comprehension with email_domain in the email field.

GCP

from google.cloud import firestore

client = firestore.Client()

users_ref = client.collection('users')

users_ref.document('user1').set({'name': 'Alice', 'email': '[e-mail]'})
users_ref.document('user2').set({'name': 'Bob', 'email': '[e-mail]'})
users_ref.document('user3').set({'name': 'Charlie', 'email': '[e-mail]'})

email_domain = '@example.com'

# Retrieve all users and filter by email domain
# Your code here

Need a hint?

Firestore does not support 'contains' queries on strings. Retrieve all documents with stream() and filter in Python using a list comprehension.

4

Complete by printing filtered user names

Add a for loop to iterate over query and print the name field of each user document.

GCP

from google.cloud import firestore

client = firestore.Client()

users_ref = client.collection('users')

users_ref.document('user1').set({'name': 'Alice', 'email': '[e-mail]'})
users_ref.document('user2').set({'name': 'Bob', 'email': '[e-mail]'})
users_ref.document('user3').set({'name': 'Charlie', 'email': '[e-mail]'})

email_domain = '@example.com'

all_users = users_ref.stream()

query = [user for user in all_users if email_domain in user.to_dict().get('email', '')]

# Loop through query and print user names
# Your code here

Need a hint?

Use a for loop over query and print the name field from each document's data.