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 के दस्तावेज़ों को हर सेकंड में सिर्फ़ एक बार अपडेट किया जा सकता है. इसके अलावा, अगर कोई ट्रांज़ैक्शन किसी ऐसे दस्तावेज़ को पढ़ता है जिसे ट्रांज़ैक्शन के बाहर जाकर बदला गया है, तो वह कुछ बार फिर से कोशिश करता है और फिर पूरा नहीं हो पाता. ऐसे एग्रीगेशन के लिए, डिस्ट्रिब्यूटेड काउंटर देखें जिन्हें ज़्यादा बार अपडेट करने की ज़रूरत होती है.
तरीका: 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 Function में एक्ज़ीक्यूट किया गया कोड, सुरक्षा के नियमों से बंधा नहीं होता. इसका मतलब है कि अब आपको क्लाइंट को एग्रीगेट किए गए डेटा में लिखने का ऐक्सेस देने की ज़रूरत नहीं है.
सीमाएं
एग्रीगेशन के लिए Cloud Function का इस्तेमाल करने से, क्लाइंट-साइड ट्रांज़ैक्शन से जुड़ी कुछ समस्याएं हल हो जाती हैं. हालांकि, इसकी कुछ सीमाएं भी हैं:
- लागत - हर रेटिंग जोड़े जाने पर, Cloud Function को कॉल किया जाएगा. इससे आपकी लागत बढ़ सकती है. ज़्यादा जानकारी के लिए, Cloud Functions की कीमत वाला पेज देखें.
- लेटेंसी - एग्रीगेशन का काम Cloud Function को सौंपने पर, आपका ऐप्लिकेशन अपडेट किया गया डेटा तब तक नहीं देख पाएगा, जब तक Cloud Function का एक्ज़ीक्यूशन पूरा नहीं हो जाता और क्लाइंट को नए डेटा के बारे में सूचना नहीं मिल जाती. आपके Cloud Function की स्पीड के आधार पर, इसमें ट्रांज़ैक्शन को स्थानीय तौर पर एक्ज़ीक्यूट करने से ज़्यादा समय लग सकता है.
- राइट रेट - यह तरीका, अक्सर अपडेट किए जाने वाले एग्रीगेशन के लिए काम नहीं कर सकता. ऐसा इसलिए है, क्योंकि Cloud Firestore के दस्तावेज़ों को हर सेकंड में सिर्फ़ एक बार अपडेट किया जा सकता है. इसके अलावा, अगर कोई ट्रांज़ैक्शन किसी ऐसे दस्तावेज़ को पढ़ता है जिसे ट्रांज़ैक्शन के बाहर जाकर बदला गया है, तो वह कुछ बार फिर से कोशिश करता है और फिर पूरा नहीं हो पाता. ऐसे एग्रीगेशन के लिए, डिस्ट्रिब्यूटेड काउंटर देखें जिन्हें ज़्यादा बार अपडेट करने की ज़रूरत होती है.