[Firebase] FireStore 문서 CRUD

📌 해당 글은 리액트 네이티브 기반으로 작성했습니다.

데이터 조회(Read)

const getFolders = async (user: TUser): Promise<IFolder[]> => {
  const querySnapshot = await foldersCollection
    .where("creatorId", "==", user?.uid)
    .orderBy("createdAt", "asc")
    .get();

  const data: IFolder[] = querySnapshot.docs.map((documentSnapshot) => {
    const docData = documentSnapshot.data();
    return {
      id: documentSnapshot.id,
      createdAt: docData.createdAt,
      creatorId: docData.creatorId,
      name: docData.name,
    };
  });

  return data;
};

querySnapshot

• 파이어베이스 데이터베이스에서 쿼리를 실행한 결과로 얻어지는 객체이다. (쿼리는 데이터를 검색하거나 필터링하는 작업)
• 쿼리에 해당하는 모든 문서의 스냅샷을 포함하고 있다. (실시간 데이터베이스)
• 스냅샷은 문서의 데이터와 해당 문서에 대한 메타데이터를 포함하고 있다.
• querySnapshot.docs(): 쿼리스냅샷에 있는 모든 데이터을 배열 형태로 반환하는 프로퍼티이다.
• querySnapshot.forEach() 메소드는 데이터를 열거할 때 사용한다.

  const userUid = "user123"; // 예시 사용자 UID
  
  const querySnapshot = await memosCollection.where("creatorId", "==", userUid).get();
  
  querySnapshot.forEach((documentSnapshot) => {
    const memoData = documentSnapshot.data();
    console.log("Memo Title:", memoData.title);
  });
  
  // 콘솔 1
  // 콘솔 2
  // 콘솔 3
  // 콘솔 4

• 문서 즉 데이터에 접근하려면 docs() 속성을 통해 배열로 반환받거나 forEach() 메소드를 사용하여 열거할 수 있다.

documentSnapshot

• querySnapshot을 통해 얻은 데이터의 개별 문서에 대한 스냅샷이다.
• 각 문서에는 데이터와 해당 문서에 대한 참조가 포함되어 있다.
• documentSnapshot.data() 메소드를 통해서 데이터를 불러와야한다.
  • 해당 문서의 데이터를 가져오는 메소드이다.
  • 스냅샷에 포함되어 있는 메타데이터 등을 제외한 실제 데이터만 추출하기 위해서 사용한다.

❓쿼리(필터링)없이 documentSnapshot만을 가져오려면

const getSingleDocumentSnapshot = async (documentId: string) => {
  const documentSnapshot = await memosCollection.doc(documentId).get();

  if (documentSnapshot.exists) {
    const data = documentSnapshot.data();
    // 이제 data를 사용하여 문서의 데이터를 활용할 수 있습니다.
    console.log("Document Data:", data);
  } else {
    console.log("Document not found");
  }
};

// 특정 컬렉션과 문서 ID로 DocumentReference 생성
const documentRef = firestore.collection("collectionName").doc("documentId");

// 문서의 데이터 가져오기
documentRef.get().then((documentSnapshot) => {
  if (documentSnapshot.exists) {
    const data = documentSnapshot.data();
    console.log("Document Data:", data);
  } else {
    console.log("Document not found");
  }
});

// 문서 업데이트
documentRef.update({ field: newValue }).then(() => {
  console.log("Document updated successfully");
});

// 문서 삭제
documentRef.delete().then(() => {
  console.log("Document deleted successfully");
});

• 컬렉션에 접근하여 doc메소드를 통해 특정 ID를 갖는 문서에 접근한다. (get)
• 이후 개별 문서 (single document)의 data를 가져온다.

---

데이터 추가 및 생성 (Create)

const addNote = async (newNote: INote) => {
  await memosCollection.add(newNote);
};

• add() 메소드에 추가할 내용(객체)를 넣으면 된다.

---

데이터 수정 및 업데이트 (Update)

const updateNote = async ({ noteId, updated }: IUpdateNote) => {
  await memosCollection.doc(noteId).update(updated);
};

• update() 메소드에 업데이트할 내용(객체)를 넣으면 된다.
• doc() : 데이터베이스 내의 특정 문서에 접근하기 위한 참조(reference)를 생성하는 역할을 한다. 이 메소드는 인자로 전달된 문서나 ID나 경로에 해당하는 문서에 대한 참조를 생성한다.
  • 해당 문서의 고유 ID를 사용해서 접근한다.

---

데이터 삭제 (Delete)

const deleteNote = async (noteId: undefined | string) => {
  await memosCollection.doc(noteId).delete();
};

• 마찬가지로 doc메소드를 통해서 특정 문서에 접근하여 삭제

일괄 삭제

export const deleteNotesFromFolder = async (user: TUser, name: string) => {
  const querySnapshot = await memosCollection
    .where("creatorId", "==", user?.uid)
    .where("folder", "==", name)
    .get();
  querySnapshot.forEach((documentSnapshot) => {
    documentSnapshot.ref.delete();
  });
};

• querySnapshot의 메소드인 forEach를 사용하여 개별 문서에 접근한다.
• documentSnapshot.ref = DocumentReference
  • documentSnapshot에 포함된 문서의 DocumentReference
  • 특정 문서 스냅샷에 대한 참조를 반환한다.
  • 이를 통해 해당 문서에 대한 다양한 작업을 수행할 수 있다.
• 특정 문서에 대한 참조를 얻고나서 forEach를 사용해서 순차적으로 삭제한다.

📌 Reference 참조란?

데이터베이스에서 특정 데이터를 식별하고 접근하기 위한 방법을 제공하는 것이다.
즉, 데이터의 위치를 알려주는 역할을 하며 이를 통해 데이터를 조회, 수정, 삭제하거나 다양한 작업을 수행할 수 있다.
Firestore에서 DocumentReference와 CollectionReference는 데이터를 참조하는 데 사용되는 객체이다. DocumentReference는 특정 문서를 참조하며, CollectionReference는 특정 컬렉션을 참조한다.

References

React-Native Firebase Docs
Firebase - FireStore 공식 문서