Cloud Firestore 정리 (노소래)

Cloud Firestore는 클라우드에 호스팅되는 NoSQL 데이터베이스 (SDK)
asia-northeast3 is Seoul
컬렉션s - 문서s(키-값 쌍) - 하위컬렉션s - 문서s(키-값 쌍) - 하위컬렉션s ...
표기
- docRef = FirebaseFirestore.collection("").document("")
- ~ = .addOnSuccessListener.addOnFailureListener
추가
- 1️⃣ docRef.set( hashMapOf() ... ) ~
- 2️⃣ docRef.add( ) ~
- 3️⃣ val ref = db.collection("cities").document() ref.set(data)
- 기본적으로 덮어쓰기 but set(data, SetOptoins.merge()) 사용시 병합
- data class 도 문서에 set 할 수 있다구~ @ServerTimestamp ~ Timestamp, @field:JvmField // Boolean Field 에 is 붙을 때
- add 는 자동으로 ID 생성해줘서 document 에 id 따로 지정할 필요도 없다구~
- {} 안에 JSON 형식으로 바로 전달도 가능 https://firebase.google.com/docs/firestore/manage-data/add-data
업데이트
- 초당 한 번만 단일 문서를 업데이트할 수 있음에 유의
- docRef**.update("capital", true)**.addOnSuccessListener.addOnFailureListener
- doc 까지 특정하고 update 메서드에 (키, 값) 인자로 전달
- mapOf() 로 여러 개 동시에 업데이트도 가능하고 '점 표기법'으로 문서내의 중첩된 필드도 참조가능 (안 쓸 경우 중첩된 필드가 통째로 교체되는 수가 있음) https://firebase.google.com/docs/firestore/manage-data/add-data
- 문서에 배열요소가 있다면 arrayUnion()은 배열에 없는 요소만 추가하고, docRef.update("regions", FieldValue.arrayUnion("greater_virginia")) arrayRemove()는 제공된 각 요소의 모든 인스턴스를 삭제 docRef.update("regions", FieldValue.arrayRemove("east_coast"))
- 증분 작업도 가능 docRef.update("population", FieldValue.increment(50))
- 카운터 업데이트를 1초보다 자주해야한다면 분산 카운터 참고
- 업데이트를 필드 추가로 사용할 수도 있다!! docRef.update(키, 값)
삭제
- 문서삭제 docRef.delete() ~ 주의할 점은 문서 내의 하위컬렉션은 삭제되지 않는다는 점! 수동삭제 요망 https://firebase.google.com/docs/firestore/manage-data/delete-data#collections 그래서 문서 삭제 돼도 문서 내의 하위 컬렉션은 그대로 접근이 가능하다.
- 필드삭제
```
val updates = hashMapOf<String, Any>(
        "capital" to **FieldValue.delete()**
)

docRef.update(updates).addOnCompleteListener { }
```
- 컬렉션삭제 전체 컬렉션을 삭제하려면 신뢰할 수 있는 서버 환경에서만 삭제

읽기

문서가져오기 (addOnSuccessListener 에서 확인) val source = Source.CACHE docRef**.get(source)**.addOnSuccessListener { document -> document.data ~ source 를 안 넣어도 된다. 오프라인 대비 캐시다.

커스텀 객체 문서(?) 가져오기

docRef.get().addOnSuccessListener { documentSnapshot ->
    val city = documentSnapshot.toObject<City>()
}

컬렉션에서 여러 문서 가져오기

db.collection("cities")
        .**whereEqualTo**("capital", true)
        .**get**()
        .**addOnSuccessListener** { documents ->
            for (document in documents) {
                Log.d(TAG, "${document.id} => ${document.data}")
            }
        }
        .addOnFailureListener { exception ->
            Log.w(TAG, "Error getting documents: ", exception)
        }

문서에 리스너 달아서 실시간 업데이트 문서 가져오기

val docRef = db.collection("cities").document("SF")
docRef.**addSnapshotListener** { snapshot, e ->
    if (e != null) {
        Log.w(TAG, "Listen failed.", e)
        return@addSnapshotListener
    }

    if (snapshot != null && snapshot.exists()) {
        Log.d(TAG, "Current data: ${snapshot.data}")
    } else {
        Log.d(TAG, "Current data: null")
    }
}

쿼리넣어서 업데이트 쿼리 결과 문서들 가져오기

db.collection("cities")
        **.whereEqualTo("state", "CA")**
        .**addSnapshotListener** { value, e ->
            if (e != null) {
                Log.w(TAG, "Listen failed.", e)
                return@addSnapshotListener
            }

            val cities = ArrayList<String>()
            for (doc in value!!) {
                doc.getString("name")?.let {
                    cities.add(it)
                }
            }
            Log.d(TAG, "Current cites in CA: $cities")
        }

db.collection("cities")
        .whereEqualTo("state", "CA")
        .**addSnapshotListener** { snapshots, e ->
            if (e != null) {
                Log.w(TAG, "listen:error", e)
                return@addSnapshotListener
            }

            for (dc in snapshots!!**.documentChanges**) {
                when (dc**.type**) {
                    DocumentChange.Type.ADDED -> Log.d(TAG, "New city: ${dc.document.data}")
                    DocumentChange.Type.MODIFIED -> Log.d(TAG, "Modified city: ${dc.document.data}")
                    DocumentChange.Type.REMOVED -> Log.d(TAG, "Removed city: ${dc.document.data}")
                }
            }
        }

컬렉션에 리스너 달아서 업데이트 문서 가져오기 및 제거

val query = db.collection("cities")
val registration = query.**addSnapshotListener** { snapshots, e ->
    // ...
}

// ...

// Stop listening to changes
registration.**remove()**

오류가 발생하면 리스너는 이벤트를 더 이상 수신하지 않으므로 리스너를 분리할 필요 X

단순쿼리
- 쿼리 결과는 기본적으로 위 읽기 섹션의 get, addSnapshotListener 로 읽어올 수 있음
- whereEqualTo(키, 값) collectionRef.whereEqualTo(키, 값)
```
db.collection("cities")
        .whereEqualTo("capital", true)
        .get()
        .addOnSuccessListener { documents ->
            for (document in documents) {
                Log.d(TAG, "${document.id} => ${document.data}")
            }
        }
        .addOnFailureListener { exception ->
            Log.w(TAG, "Error getting documents: ", exception)
        }
```
- whereLessThan
- whereGreaterThanOrEqualTo
- whereNotEqualTo 지정된 필드가 있는 문서만 쿼리와 일치 가능(다른 Not 붙은 함수도 마찬가지) 복합 쿼리에 결합할 수 없음 복합 쿼리에서 범위(<, <=, >, >=)와 같지 않음(!=, not-in) 비교는 모두 동일한 필드에서 필터링되어야 함
- whereArrayContains (쿼리당 최대 1번, array-contains와 array-contains-any를 결합할 수 X)
- collectionRef.whereIn("country", listOf("USA", "Japan")) (최대 10개 OR 결합) collectionRef.whereIn("regions", listOf(arrayOf("west_coast"), arrayOf("east_coast")))
- collectionRef.whereNotIn("country", listOf("USA", "Japan")) (최대 10개 OR 결합) 쿼리당 in, not-in, array-contains-any 절을 최대 하나만 사용할 수 있음. 같은 쿼리에서 이러한 연산자를 결합할 수 X
- collectionRef.whereArrayContainsAny("regions", listOf("west_coast", "east_coast")) 필드 하나에서만 범위(<, <=, >, >=)나 같지 않음(!=) 비교를 할 수 있으며 복합 쿼리에서 최대 1개의 array-contains 또는 array-contains-any 절을 포함할 수 있음
- 등호(==) 또는 in 절에 포함된 필드를 기준으로 쿼리를 정렬할 수 없음

복합쿼리

collectionRef.whereEqualTo("state", "CO").whereEqualTo("name", "Denver")
collectionRef.whereEqualTo("state", "CA").whereLessThan("population", 1000000)

collectionRef.whereGreaterThanOrEqualTo("state", "CA")
        .whereLessThanOrEqualTo("state", "IN")
collectionRef.whereEqualTo("state", "CA")
        .whereGreaterThan("population", 1000000)

복합 쿼리에서 범위(<, <=, >, >=)와 같지 않음(!=, not-in) 비교는 모두 동일한 필드에서 필터링되어야 함

컬렉션그룹쿼리
- 상황 예시로는 어떤 컬렉션에 문서들이 있고 각 문서에 각각 같은 id의 하위컬렉션이 있을 때
```
db.**collectionGroup**("landmarks").whereEqualTo("type", "museum").get()
        .addOnSuccessListener { queryDocumentSnapshots ->
            // ...
        }
```
  컬렉션 그룹 쿼리를 사용하기 전에 컬렉션 그룹 쿼리를 지원하는 색인을 만들어야 함 https://firebase.google.com/docs/firestore/query-data/indexing https://firebase.google.com/docs/firestore/security/rules-query#secure_and_query_documents_based_on_collection_groups
정렬
- 기본적으로 쿼리 조건에 맞는 모든 문서를 문서 ID 에 따라 오름차순으로 검색
- orderBy()를 사용하여 데이터의 정렬 순서를 지정하고 limit()를 사용하여 검색된 문서 수를 제한 collectionRef.orderBy("name").limit(3) collectionRef.orderBy("name", Query.Direction.DESCENDING).limit(3) collectionRef.orderBy("state").orderBy("population", Query.Direction.DESCENDING) collectionRef.whereGreaterThan("population", 100000).orderBy("population").limit(2) 필터에 범위 비교(<, <=, >, >=)가 포함된 경우 동일한 필드를 기준으로 1차 정렬이 이루어져야 함 citiesRef.whereGreaterThan("population", 100000).orderBy("population") O citiesRef.whereGreaterThan("population", 100000).orderBy("country") X orderBy() 절은 특정 필드의 존재 여부도 필터링 즉, 결과 집합에는 지정된 필드가 포함되지 않은 문서가 제외
페이징
- https://firebase.google.com/docs/firestore/query-data/query-cursors

Cloud Firestore 더 읽어볼만 한 것들

색인 https://firebase.google.com/docs/firestore/query-data/index-overview
분산 카운터 https://firebase.google.com/docs/firestore/solutions/counters
트랜잭션 및 일괄 쓰기 https://firebase.google.com/docs/firestore/manage-data/transactions
콘솔에서 관리 https://firebase.google.com/docs/firestore/using-console
데이터 내보내기 및 가져오기 https://firebase.google.com/docs/firestore/manage-data/export-import