การค้นหาใน Cloud Firestore ช่วยให้คุณค้นหาเอกสาร ในคอลเล็กชันขนาดใหญ่ได้ หากต้องการรับข้อมูลเชิงลึกเกี่ยวกับพร็อพเพอร์ตี้ของ คอลเล็กชันโดยรวม คุณสามารถรวบรวมข้อมูลในคอลเล็กชันได้
คุณจะรวบรวมข้อมูลได้ทั้งในเวลาอ่านหรือเวลาเขียน
การรวบรวมข้อมูลแบบเรียลไทม์จะคำนวณผลลัพธ์ ณ เวลาที่ส่งคำขอ Cloud Firestore รองรับการค้นหาการรวม
count()
,sum()
และaverage()
ในเวลาอ่าน การค้นหาการรวมแบบเรียลไทม์จะเพิ่มลงในแอปได้ง่ายกว่าการรวมแบบเวลาเขียน ดูข้อมูลเพิ่มเติมเกี่ยวกับ การค้นหาการรวบรวมได้ที่สรุปข้อมูลด้วยการค้นหาการรวบรวมการรวมข้อมูลขณะเขียนจะคำนวณผลลัพธ์ทุกครั้งที่แอปทำการดำเนินการเขียนที่เกี่ยวข้อง การรวมข้อมูลขณะเขียนต้องใช้ความพยายามในการติดตั้งใช้งานมากกว่า แต่คุณอาจใช้แทนการรวมข้อมูลขณะอ่านด้วยเหตุผลต่อไปนี้
- คุณต้องการฟังผลการรวบรวมข้อมูลเพื่อรับข้อมูลอัปเดตแบบเรียลไทม์
คําค้นหาการรวบรวม
count()
,sum()
และaverage()
ไม่รองรับ การอัปเดตแบบเรียลไทม์ - คุณต้องการจัดเก็บผลการรวมไว้ในแคชฝั่งไคลเอ็นต์
การค้นหาการรวบรวม
count()
,sum()
และaverage()
ไม่รองรับ การแคช - คุณกำลังรวบรวมข้อมูลจากเอกสารหลายหมื่นฉบับสำหรับผู้ใช้แต่ละรายและพิจารณาค่าใช้จ่าย หากมีเอกสารจำนวนน้อยลง การรวบรวมเวลาในการอ่าน จะมีค่าใช้จ่ายน้อยลง สำหรับการรวมเอกสารจำนวนมาก การรวมที่เวลาเขียนอาจมีค่าใช้จ่ายน้อยกว่า
- คุณต้องการฟังผลการรวบรวมข้อมูลเพื่อรับข้อมูลอัปเดตแบบเรียลไทม์
คําค้นหาการรวบรวม
คุณสามารถใช้การรวบรวมข้อมูลขณะเขียนได้โดยใช้ธุรกรรมฝั่งไคลเอ็นต์หรือใช้ Cloud Functions ส่วนต่อไปนี้จะอธิบายวิธีใช้การรวมข้อมูลขณะเขียน
โซลูชัน: การรวบรวมข้อมูลขณะเขียนด้วยธุรกรรมฝั่งไคลเอ็นต์
ลองนึกถึงแอปแนะนำในพื้นที่ที่ช่วยผู้ใช้ค้นหาร้านอาหารยอดนิยม การค้นหาต่อไปนี้จะดึงคะแนนทั้งหมดของร้านอาหารที่ระบุ
เว็บ
db.collection("restaurants") .doc("arinell-pizza") .collection("ratings") .get();
Swift
do { let snapshot = try await db.collection("restaurants") .document("arinell-pizza") .collection("ratings") .getDocuments() print(snapshot) } catch { print(error) }
Objective-C
FIRQuery *query = [[[self.db collectionWithPath:@"restaurants"] documentWithPath:@"arinell-pizza"] collectionWithPath:@"ratings"]; [query getDocumentsWithCompletion:^(FIRQuerySnapshot * _Nullable snapshot, NSError * _Nullable error) { // ... }];
Kotlin
db.collection("restaurants") .document("arinell-pizza") .collection("ratings") .get()
Java
db.collection("restaurants") .document("arinell-pizza") .collection("ratings") .get();
เราสามารถจัดเก็บข้อมูลนี้ไว้ในเอกสารร้านอาหารได้เลยแทนที่จะดึงคะแนนทั้งหมดแล้วคำนวณข้อมูลรวม
เว็บ
var arinellDoc = { name: 'Arinell Pizza', avgRating: 4.65, numRatings: 683 };
Swift
struct Restaurant { let name: String let avgRating: Float let numRatings: Int } let arinell = Restaurant(name: "Arinell Pizza", avgRating: 4.65, numRatings: 683)
Objective-C
@interface FIRRestaurant : NSObject @property (nonatomic, readonly) NSString *name; @property (nonatomic, readonly) float averageRating; @property (nonatomic, readonly) NSInteger ratingCount; - (instancetype)initWithName:(NSString *)name averageRating:(float)averageRating ratingCount:(NSInteger)ratingCount; @end @implementation FIRRestaurant - (instancetype)initWithName:(NSString *)name averageRating:(float)averageRating ratingCount:(NSInteger)ratingCount { self = [super init]; if (self != nil) { _name = name; _averageRating = averageRating; _ratingCount = ratingCount; } return self; } @end
Kotlin
data class Restaurant( // default values required for use with "toObject" internal var name: String = "", internal var avgRating: Double = 0.0, internal var numRatings: Int = 0, )
val arinell = Restaurant("Arinell Pizza", 4.65, 683)
Java
public class Restaurant { String name; double avgRating; int numRatings; public Restaurant(String name, double avgRating, int numRatings) { this.name = name; this.avgRating = avgRating; this.numRatings = numRatings; } }
Restaurant arinell = new Restaurant("Arinell Pizza", 4.65, 683);
คุณต้องอัปเดตการรวบรวมข้อมูลเหล่านี้ทุกครั้งที่มีการเพิ่มการจัดประเภทใหม่ลงในคอลเล็กชันย่อย เพื่อให้การรวบรวมข้อมูลมีความสอดคล้องกัน วิธีหนึ่งในการสร้างความสอดคล้องกัน คือการเพิ่มและอัปเดตในธุรกรรมเดียว
เว็บ
function addRating(restaurantRef, rating) { // Create a reference for a new rating, for use inside the transaction var ratingRef = restaurantRef.collection('ratings').doc(); // In a transaction, add the new rating and update the aggregate totals return db.runTransaction((transaction) => { return transaction.get(restaurantRef).then((res) => { if (!res.exists) { throw "Document does not exist!"; } // Compute new number of ratings var newNumRatings = res.data().numRatings + 1; // Compute new average rating var oldRatingTotal = res.data().avgRating * res.data().numRatings; var newAvgRating = (oldRatingTotal + rating) / newNumRatings; // Commit to Firestore transaction.update(restaurantRef, { numRatings: newNumRatings, avgRating: newAvgRating }); transaction.set(ratingRef, { rating: rating }); }); }); }
Swift
func addRatingTransaction(restaurantRef: DocumentReference, rating: Float) async { let ratingRef: DocumentReference = restaurantRef.collection("ratings").document() do { let _ = try await db.runTransaction({ (transaction, errorPointer) -> Any? in do { let restaurantDocument = try transaction.getDocument(restaurantRef).data() guard var restaurantData = restaurantDocument else { return nil } // Compute new number of ratings let numRatings = restaurantData["numRatings"] as! Int let newNumRatings = numRatings + 1 // Compute new average rating let avgRating = restaurantData["avgRating"] as! Float let oldRatingTotal = avgRating * Float(numRatings) let newAvgRating = (oldRatingTotal + rating) / Float(newNumRatings) // Set new restaurant info restaurantData["numRatings"] = newNumRatings restaurantData["avgRating"] = newAvgRating // Commit to Firestore transaction.setData(restaurantData, forDocument: restaurantRef) transaction.setData(["rating": rating], forDocument: ratingRef) } catch { // Error getting restaurant data // ... } return nil }) } catch { // ... } }
Objective-C
- (void)addRatingTransactionWithRestaurantReference:(FIRDocumentReference *)restaurant rating:(float)rating { FIRDocumentReference *ratingReference = [[restaurant collectionWithPath:@"ratings"] documentWithAutoID]; [self.db runTransactionWithBlock:^id (FIRTransaction *transaction, NSError **errorPointer) { FIRDocumentSnapshot *restaurantSnapshot = [transaction getDocument:restaurant error:errorPointer]; if (restaurantSnapshot == nil) { return nil; } NSMutableDictionary *restaurantData = [restaurantSnapshot.data mutableCopy]; if (restaurantData == nil) { return nil; } // Compute new number of ratings NSInteger ratingCount = [restaurantData[@"numRatings"] integerValue]; NSInteger newRatingCount = ratingCount + 1; // Compute new average rating float averageRating = [restaurantData[@"avgRating"] floatValue]; float newAverageRating = (averageRating * ratingCount + rating) / newRatingCount; // Set new restaurant info restaurantData[@"numRatings"] = @(newRatingCount); restaurantData[@"avgRating"] = @(newAverageRating); // Commit to Firestore [transaction setData:restaurantData forDocument:restaurant]; [transaction setData:@{@"rating": @(rating)} forDocument:ratingReference]; return nil; } completion:^(id _Nullable result, NSError * _Nullable error) { // ... }]; }
Kotlin
private fun addRating(restaurantRef: DocumentReference, rating: Float): Task<Void> { // Create reference for new rating, for use inside the transaction val ratingRef = restaurantRef.collection("ratings").document() // In a transaction, add the new rating and update the aggregate totals return db.runTransaction { transaction -> val restaurant = transaction.get(restaurantRef).toObject<Restaurant>()!! // Compute new number of ratings val newNumRatings = restaurant.numRatings + 1 // Compute new average rating val oldRatingTotal = restaurant.avgRating * restaurant.numRatings val newAvgRating = (oldRatingTotal + rating) / newNumRatings // Set new restaurant info restaurant.numRatings = newNumRatings restaurant.avgRating = newAvgRating // Update restaurant transaction.set(restaurantRef, restaurant) // Update rating val data = hashMapOf<String, Any>( "rating" to rating, ) transaction.set(ratingRef, data, SetOptions.merge()) null } }
Java
private Task<Void> addRating(final DocumentReference restaurantRef, final float rating) { // Create reference for new rating, for use inside the transaction final DocumentReference ratingRef = restaurantRef.collection("ratings").document(); // In a transaction, add the new rating and update the aggregate totals return db.runTransaction(new Transaction.Function<Void>() { @Override public Void apply(@NonNull Transaction transaction) throws FirebaseFirestoreException { Restaurant restaurant = transaction.get(restaurantRef).toObject(Restaurant.class); // Compute new number of ratings int newNumRatings = restaurant.numRatings + 1; // Compute new average rating double oldRatingTotal = restaurant.avgRating * restaurant.numRatings; double newAvgRating = (oldRatingTotal + rating) / newNumRatings; // Set new restaurant info restaurant.numRatings = newNumRatings; restaurant.avgRating = newAvgRating; // Update restaurant transaction.set(restaurantRef, restaurant); // Update rating Map<String, Object> data = new HashMap<>(); data.put("rating", rating); transaction.set(ratingRef, data, SetOptions.merge()); return null; } }); }
การใช้ธุรกรรมจะช่วยให้ข้อมูลรวมสอดคล้องกับการรวบรวมข้อมูลพื้นฐาน ดูข้อมูลเพิ่มเติมเกี่ยวกับธุรกรรมใน Cloud Firestore ได้ที่ธุรกรรมและการเขียนแบบกลุ่ม
ข้อจำกัด
โซลูชันที่แสดงด้านบนสาธิตการรวบรวมข้อมูลโดยใช้ Cloud Firestoreไลบรารีไคลเอ็นต์ แต่คุณควรทราบข้อจำกัดต่อไปนี้
- ความปลอดภัย - ธุรกรรมฝั่งไคลเอ็นต์ต้องให้สิทธิ์แก่ไคลเอ็นต์ ในการอัปเดตข้อมูลรวมในฐานข้อมูล แม้ว่าคุณจะลดความเสี่ยงของแนวทางนี้ได้ด้วยการเขียนกฎความปลอดภัยขั้นสูง แต่ก็อาจไม่เหมาะสมในบางสถานการณ์
- การรองรับแบบออฟไลน์ - ธุรกรรมฝั่งไคลเอ็นต์จะล้มเหลวเมื่ออุปกรณ์ของผู้ใช้ออฟไลน์ ซึ่งหมายความว่าคุณต้องจัดการกรณีนี้ในแอปและลองอีกครั้งในเวลาที่เหมาะสม
- ประสิทธิภาพ - หากธุรกรรมมีการอ่าน เขียน และ การดำเนินการอัปเดตหลายรายการ อาจต้องใช้คำขอหลายรายการไปยังแบ็กเอนด์ของ Cloud Firestore ซึ่งอาจใช้เวลานานพอสมควรบนอุปกรณ์เคลื่อนที่
- อัตราการเขียน - โซลูชันนี้อาจใช้ไม่ได้กับการรวมที่อัปเดตบ่อย เนื่องจากเอกสาร Cloud Firestore อัปเดตได้สูงสุด 1 ครั้งต่อวินาทีเท่านั้น นอกจากนี้ หากธุรกรรมอ่านเอกสารที่ได้รับการแก้ไขนอกธุรกรรม ระบบจะลองอีกครั้งตามจำนวนครั้งที่กำหนด แล้วจะล้มเหลว ดูตัวนับแบบกระจาย เพื่อดูวิธีแก้ปัญหาที่เกี่ยวข้องสำหรับการรวบรวมข้อมูลที่ต้องมีการอัปเดตบ่อยขึ้น
โซลูชัน: การรวบรวมข้อมูลขณะเขียนด้วย Cloud Functions
หากธุรกรรมฝั่งไคลเอ็นต์ไม่เหมาะกับแอปพลิเคชัน คุณสามารถใช้ Cloud Function เพื่ออัปเดตข้อมูลรวม ทุกครั้งที่มีการเพิ่มคะแนนใหม่ให้กับร้านอาหารได้โดยทำดังนี้
Node.js
exports.aggregateRatings = functions.firestore .document('restaurants/{restId}/ratings/{ratingId}') .onWrite(async (change, context) => { // Get value of the newly added rating const ratingVal = change.after.data().rating; // Get a reference to the restaurant const restRef = db.collection('restaurants').doc(context.params.restId); // Update aggregations in a transaction await db.runTransaction(async (transaction) => { const restDoc = await transaction.get(restRef); // Compute new number of ratings const newNumRatings = restDoc.data().numRatings + 1; // Compute new average rating const oldRatingTotal = restDoc.data().avgRating * restDoc.data().numRatings; const newAvgRating = (oldRatingTotal + ratingVal) / newNumRatings; // Update restaurant info transaction.update(restRef, { avgRating: newAvgRating, numRatings: newNumRatings }); }); });
โซลูชันนี้จะส่งต่อการทำงานจากไคลเอ็นต์ไปยังฟังก์ชันที่โฮสต์ ซึ่งหมายความว่าแอปบนอุปกรณ์เคลื่อนที่จะเพิ่มคะแนนได้โดยไม่ต้องรอให้ธุรกรรมเสร็จสมบูรณ์ โค้ดที่เรียกใช้ใน Cloud Functions จะไม่ผูกมัดตามกฎความปลอดภัย ซึ่งหมายความว่าคุณไม่จำเป็นต้องให้สิทธิ์การเขียนแก่ไคลเอ็นต์เพื่อเข้าถึงข้อมูลรวมอีกต่อไป
ข้อจำกัด
การใช้ Cloud Function สำหรับการรวบรวมจะช่วยหลีกเลี่ยงปัญหาบางอย่างเกี่ยวกับ ธุรกรรมฝั่งไคลเอ็นต์ แต่ก็มีข้อจำกัดที่แตกต่างกันดังนี้
- ค่าใช้จ่าย - การให้คะแนนแต่ละครั้งจะทำให้เกิดการเรียกใช้ Cloud Functions ซึ่งอาจทำให้ค่าใช้จ่ายเพิ่มขึ้น ดูข้อมูลเพิ่มเติมได้ที่หน้าราคาของ Cloud Functions
- เวลาในการตอบสนอง - การส่งต่อการทำงานของการรวบรวมไปยัง Cloud Functions จะทำให้แอปไม่เห็นข้อมูลที่อัปเดตจนกว่า Cloud Functions จะดำเนินการเสร็จสิ้นและไคลเอ็นต์ได้รับการแจ้งเตือนเกี่ยวกับข้อมูลใหม่ ซึ่งอาจใช้เวลานานกว่าการดำเนินการธุรกรรมในเครื่อง ทั้งนี้ขึ้นอยู่กับความเร็วของ Cloud Function
- อัตราการเขียน - โซลูชันนี้อาจใช้ไม่ได้กับการรวมที่อัปเดตบ่อย เนื่องจากเอกสาร Cloud Firestore อัปเดตได้สูงสุด 1 ครั้งต่อวินาทีเท่านั้น นอกจากนี้ หากธุรกรรมอ่านเอกสารที่ได้รับการแก้ไขนอกธุรกรรม ระบบจะลองอีกครั้งตามจำนวนครั้งที่กำหนด แล้วจะล้มเหลว ดูตัวนับแบบกระจาย เพื่อดูวิธีแก้ปัญหาที่เกี่ยวข้องสำหรับการรวบรวมข้อมูลที่ต้องมีการอัปเดตบ่อยขึ้น