Getting a single document in Firebase - Commands & Configuration

Introduction

Sometimes you need to get information about one specific item stored in your database. This concept shows how to fetch a single document from Firebase Firestore, so you can use or show its data.

When you want to display details of a user profile on a webpage.

When you need to check the status of a single order in an online store.

When you want to load settings for a specific device or app instance.

When you want to fetch a single blog post to show on a page.

When you need to get a single record to update or delete it.

Commands

Log in to your Firebase account to access your projects and data.

Terminal

firebase login

Expected Output

✔  Success! Logged in as [e-mail]

Initialize Firestore in your project folder to set up the database rules and indexes.

Terminal

firebase init firestore

Expected Output

Firestore rules and indexes files have been created in your project directory.

Run the Node.js script that fetches a single document from Firestore and prints its data.

Terminal

node getDocument.js

Expected Output

{ name: 'Alice', age: 30, city: 'New York' }

Key Concept

If you remember nothing else from this pattern, remember: fetching a single document requires specifying its exact path in the database.

Common Mistakes

Trying to get a document without specifying the full path including collection and document ID.

Firestore needs the exact location to find the document; missing parts cause errors or empty results.

Always provide the full path like 'collectionName/documentID' when fetching a document.

Not handling the case when the document does not exist.

Your code might crash or behave unexpectedly if the document is missing.

Check if the document exists before accessing its data to avoid errors.

Summary

Use 'firebase login' to access your Firebase account.

Initialize Firestore in your project with 'firebase init firestore'.

Run a script that specifies the document path to fetch and print its data.

Practice

1. What does the getDoc() function do in Firebase when working with a single document?

easy

A. It fetches the data of a specific document from the database.

B. It creates a new document in the database.

C. It deletes a document from the database.

D. It updates the fields of a document.

Solution

1. Step 1: Understand the purpose of getDoc()

   The getDoc() function is used to retrieve data from a specific document in Firebase Firestore.

2. Step 2: Differentiate from other functions

   Functions like setDoc() create or update documents, while deleteDoc() removes them. getDoc() only reads data.

3. Final Answer:

   It fetches the data of a specific document from the database. -> Option A

4. Quick Check:

   getDoc() reads document data [OK]

Hint: Remember: getDoc() reads, setDoc() writes [OK]

Common Mistakes:

• Confusing getDoc() with setDoc() or deleteDoc()
• Thinking getDoc() creates documents
• Assuming getDoc() updates data

2. Which of the following is the correct way to get a single document from a Firestore collection named users with ID user123 in JavaScript?

easy

A. const docRef = getDoc(db, 'users', 'user123');

B. const docSnap = await getDoc('users/user123');

C. const docRef = doc(db, 'users', 'user123'); const docSnap = await getDoc(docRef);

D. const docSnap = doc(db, 'users', 'user123');

Solution

1. Step 1: Use doc() to reference the document

   The doc() function takes the database, collection name, and document ID to create a reference.

2. Step 2: Use getDoc() with the document reference

   Pass the document reference to getDoc() to fetch the document snapshot asynchronously.

3. Final Answer:

   const docRef = doc(db, 'users', 'user123'); const docSnap = await getDoc(docRef); -> Option C

4. Quick Check:

   doc() creates ref, getDoc() fetches [OK]

Hint: Always create doc ref first, then getDoc(ref) [OK]

Common Mistakes:

• Passing string path directly to getDoc()
• Using getDoc() to create doc reference
• Calling doc() without database argument

3. Given the following code snippet, what will be logged if the document with ID doc1 exists and has a field name with value Alice?

const docRef = doc(db, 'users', 'doc1');
const docSnap = await getDoc(docRef);
if (docSnap.exists()) {
  console.log(docSnap.data().name);
} else {
  console.log('No such document!');
}

medium

A. No such document!

B. Alice

C. undefined

D. Error: docSnap.data() is not a function

Solution

1. Step 1: Check if document exists

   The code uses docSnap.exists() to verify the document presence, which is true here.

2. Step 2: Access the name field from document data

   Since the document exists, docSnap.data() returns the data object, and name is Alice.

3. Final Answer:

   Alice -> Option B

4. Quick Check:

   Document exists, print name field [OK]

Hint: Check exists() before accessing data() [OK]

Common Mistakes:

• Not checking exists() before data()
• Expecting data() to return undefined if no doc
• Confusing data() with get()

4. What is wrong with the following code snippet for getting a document from Firestore?

const docSnap = await getDoc('users/user123');
if (docSnap.exists()) {
  console.log(docSnap.data());
}

medium

A. You cannot use console.log with docSnap.data().

B. Missing await keyword before getDoc().

C. docSnap.exists() is not a valid method.

D. getDoc() requires a document reference, not a string path.

Solution

1. Step 1: Understand getDoc() argument requirements

   The getDoc() function expects a document reference created by doc(), not a string path.

2. Step 2: Identify the error in argument type

   Passing a string like 'users/user123' directly causes an error because it's not a valid document reference.

3. Final Answer:

   getDoc() requires a document reference, not a string path. -> Option D

4. Quick Check:

   getDoc() needs doc() ref [OK]

Hint: Always use doc() to create reference before getDoc() [OK]

Common Mistakes:

• Passing string path directly to getDoc()
• Forgetting to create doc reference
• Assuming getDoc() accepts string paths

5. You want to fetch a user's profile document from Firestore and safely handle the case when the document does not exist. Which code snippet correctly implements this behavior?

hard

A. const docRef = doc(db, 'profiles', userId);
const docSnap = await getDoc(docRef);
if (docSnap.exists()) {
return docSnap.data();
} else {
return null;
}

B. const docSnap = await getDoc(doc(db, 'profiles', userId));
return docSnap.data();

C. const docRef = doc(db, 'profiles', userId);
const docSnap = getDoc(docRef);
if (docSnap.exists()) {
return docSnap.data();
} else {
return {};
}

D. const docSnap = await getDoc('profiles/' + userId);
if (docSnap.exists()) {
return docSnap.data();
} else {
throw new Error('Document missing');
}

Solution

1. Step 1: Create a document reference correctly

   Use doc(db, 'profiles', userId) to get the document reference.

2. Step 2: Await the asynchronous getDoc() call and check existence

   Use await getDoc(docRef) and check docSnap.exists() before accessing data.

3. Step 3: Return data if exists, else return null

   This safely handles missing documents by returning null instead of causing errors.

4. Final Answer:

   Code snippet that awaits getDoc, checks exists(), returns data or null. -> Option A

5. Quick Check:

   Check exists() before data() to avoid errors [OK]

Hint: Always check exists() before using data() [OK]

Common Mistakes:

• Not awaiting getDoc() causing unresolved promises
• Accessing data without checking exists()
• Passing string path directly to getDoc()
• Throwing error instead of handling missing doc gracefully