लिखने के समय का एग्रीगेशन

Cloud Firestore में क्वेरी की मदद से, बड़े कलेक्शन में दस्तावेज़ ढूंढे जा सकते हैं. पूरे कलेक्शन की प्रॉपर्टी के बारे में अहम जानकारी पाने के लिए, कलेक्शन में डेटा इकट्ठा किया जा सकता है.

डेटा को पढ़ने के समय या लिखने के समय, दोनों में से किसी भी समय एग्रीगेट किया जा सकता है:

  • रीड-टाइम एग्रीगेशन, अनुरोध के समय नतीजे का हिसाब लगाते हैं. Cloud Firestore, पढ़ने के समय count(), sum(), और average() एग्रीगेशन क्वेरी के साथ काम करता है. डेटा को पढ़ने के समय एग्रीगेट करने वाली क्वेरी को, डेटा को लिखने के समय एग्रीगेट करने वाली क्वेरी के मुकाबले, ऐप्लिकेशन में जोड़ना आसान होता है. एग्रीगेशन क्वेरी के बारे में ज़्यादा जानने के लिए, एग्रीगेशन क्वेरी की मदद से डेटा की खास जानकारी पाना लेख पढ़ें.

  • डेटा लिखने के समय एग्रीगेट करने की सुविधा, हर बार नतीजा कैलकुलेट करती है, जब ऐप्लिकेशन कोई काम का डेटा लिखने का काम करता है. डेटा को लिखने के समय एग्रीगेट करने की सुविधा को लागू करना ज़्यादा मुश्किल होता है. हालांकि, इनमें से किसी एक वजह से, डेटा को पढ़ने के समय एग्रीगेट करने की सुविधा के बजाय, डेटा को लिखने के समय एग्रीगेट करने की सुविधा का इस्तेमाल किया जा सकता है:

    • आपको रीयल-टाइम अपडेट के लिए, एग्रीगेशन का नतीजा सुनना है. count(), sum(), और average() एग्रीगेशन क्वेरी, रीयल-टाइम अपडेट के साथ काम नहीं करती हैं.
    • आपको एग्रीगेशन का नतीजा, क्लाइंट-साइड कैश मेमोरी में सेव करना है. count(), sum(), और average() एग्रीगेशन क्वेरी, कैश मेमोरी का इस्तेमाल नहीं करतीं.
    • आपके पास अपने हर उपयोगकर्ता के लिए, 10 हज़ार दस्तावेज़ों से डेटा इकट्ठा करने और लागत का हिसाब लगाने का विकल्प है. कम दस्तावेज़ों के लिए, पढ़ने के समय के आधार पर डेटा इकट्ठा करने की सुविधा की लागत कम होती है. एग्रीगेशन में बड़ी संख्या में दस्तावेज़ों के लिए, लिखने के समय एग्रीगेशन की लागत कम हो सकती है.

क्लाइंट-साइड ट्रांज़ैक्शन या Cloud Functions का इस्तेमाल करके, डेटा को लिखने के समय एग्रीगेट किया जा सकता है. नीचे दिए गए सेक्शन में, लिखने के समय एग्रीगेशन लागू करने का तरीका बताया गया है.

समाधान: क्लाइंट-साइड लेन-देन के साथ, डेटा लिखने के समय एग्रीगेशन

स्थानीय सुझाव देने वाला कोई ऐप्लिकेशन बनाएं, ताकि लोग बेहतरीन रेस्टोरेंट ढूंढ सकें. नीचे दी गई क्वेरी, किसी रेस्टोरेंट की सभी रेटिंग दिखाती है:

वेब

db.collection("restaurants")
  .doc("arinell-pizza")
  .collection("ratings")
  .get();
test.solution-aggregation.js

Swift

ध्यान दें: यह प्रॉडक्ट, watchOS और ऐप्लिकेशन क्लिप टारगेट पर उपलब्ध नहीं है. 
do {
  let snapshot = try await db.collection("restaurants")
    .document("arinell-pizza")
    .collection("ratings")
    .getDocuments()
  print(snapshot)
} catch {
  print(error)
}
SolutionAggregationViewController.swift

Objective-C

ध्यान दें: यह प्रॉडक्ट, watchOS और ऐप्लिकेशन क्लिप टारगेट पर उपलब्ध नहीं है. 
FIRQuery *query = [[[self.db collectionWithPath:@"restaurants"]
    documentWithPath:@"arinell-pizza"] collectionWithPath:@"ratings"];
[query getDocumentsWithCompletion:^(FIRQuerySnapshot * _Nullable snapshot,
                                    NSError * _Nullable error) {
  // ...
}];
FIRSolutionAggregationViewController.m

Kotlin+KTX 

db.collection("restaurants")
    .document("arinell-pizza")
    .collection("ratings")
    .get()
SolutionAggregation.kt

Java 

db.collection("restaurants")
        .document("arinell-pizza")
        .collection("ratings")
        .get();
SolutionAggregation.java

सभी रेटिंग फ़ेच करने और फिर कुल जानकारी का हिसाब लगाने के बजाय, हम इस जानकारी को रेस्टोरेंट के दस्तावेज़ में सेव कर सकते हैं:

वेब

var arinellDoc = {
  name: 'Arinell Pizza',
  avgRating: 4.65,
  numRatings: 683
};
test.solution-aggregation.js

Swift

ध्यान दें: यह प्रॉडक्ट, watchOS और ऐप्लिकेशन क्लिप टारगेट पर उपलब्ध नहीं है. 
struct Restaurant {

  let name: String
  let avgRating: Float
  let numRatings: Int

}

let arinell = Restaurant(name: "Arinell Pizza", avgRating: 4.65, numRatings: 683)
SolutionAggregationViewController.swift

Objective-C

ध्यान दें: यह प्रॉडक्ट, watchOS और ऐप्लिकेशन क्लिप टारगेट पर उपलब्ध नहीं है. 
@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
FIRSolutionAggregationViewController.m

Kotlin+KTX 

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)
SolutionAggregation.kt

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);
SolutionAggregation.java

इन एग्रीगेशन को एक जैसा बनाए रखने के लिए, हर बार जब सबकलेक्शन में कोई नई रेटिंग जोड़ी जाती है, तो उन्हें अपडेट करना ज़रूरी होता है. एक ही ट्रांज़ैक्शन में जोड़ने और अपडेट करने की सुविधा चालू करने का एक तरीका यह है:

वेब

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 });
        });
    });
}
test.firestore.js

Swift

ध्यान दें: यह प्रॉडक्ट, watchOS और ऐप्लिकेशन क्लिप टारगेट पर उपलब्ध नहीं है. 
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 {
    // ...
  }
}
SolutionAggregationViewController.swift

Objective-C

ध्यान दें: यह प्रॉडक्ट, watchOS और ऐप्लिकेशन क्लिप टारगेट पर उपलब्ध नहीं है. 
- (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) {
    // ...
  }];
}
FIRSolutionAggregationViewController.m

Kotlin+KTX 

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
    }
}
SolutionAggregation.kt

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;
        }
    });
}
SolutionAggregation.java

ट्रांज़ैक्शन का इस्तेमाल करने से, आपका एग्रीगेट डेटा, मौजूदा कलेक्शन के साथ एक जैसा रहता है. Cloud Firestore में लेन-देन के बारे में ज़्यादा जानने के लिए, लेन-देन और एक साथ कई रिकॉर्ड लिखना लेख पढ़ें.

सीमाएं

ऊपर दिए गए समाधान में, Cloud Firestore क्लाइंट लाइब्रेरी का इस्तेमाल करके डेटा इकट्ठा करने का तरीका बताया गया है. हालांकि, आपको इन सीमाओं के बारे में पता होना चाहिए:

  • सुरक्षा - क्लाइंट-साइड लेन-देन के लिए, क्लाइंट को आपके डेटाबेस में इकट्ठा किया गया डेटा अपडेट करने की अनुमति देना ज़रूरी है. बेहतर सुरक्षा नियम लिखकर, इस तरीके से जुड़े जोखिमों को कम किया जा सकता है. हालांकि, ऐसा सभी मामलों में सही नहीं हो सकता.
  • ऑफ़लाइन सहायता - जब उपयोगकर्ता का डिवाइस ऑफ़लाइन होगा, तब क्लाइंट-साइड लेन-देन नहीं हो पाएंगे. इसका मतलब है कि आपको अपने ऐप्लिकेशन में इस मामले को मैनेज करना होगा और सही समय पर फिर से कोशिश करनी होगी.
  • परफ़ॉर्मेंस - अगर आपके लेन-देन में कई बार पढ़ने, लिखने, और अपडेट करने की कार्रवाइयां शामिल हैं, तो इसके लिए Cloud Firestore बैकएंड को कई अनुरोध करने पड़ सकते हैं. मोबाइल डिवाइस पर, इसमें काफ़ी समय लग सकता है.
  • लिखने की दरें - ऐसा हो सकता है कि यह तरीका, बार-बार अपडेट किए जाने वाले एग्रीगेशन के लिए काम न करे. इसकी वजह यह है कि Cloud Firestore दस्तावेज़ों को हर सेकंड में ज़्यादा से ज़्यादा एक बार ही अपडेट किया जा सकता है. इसके अलावा, अगर कोई लेन-देन ऐसे दस्तावेज़ को पढ़ता है जिसमें लेन-देन के बाहर बदलाव किया गया था, तो वह कुछ समय के लिए फिर से कोशिश करता है और फिर काम नहीं करता. डिस्ट्रिब्यूटेड काउंटर देखें. इससे, आपको उन एग्रीगेशन के लिए काम का समाधान मिल सकता है जिन्हें बार-बार अपडेट करने की ज़रूरत होती है.

समाधान: Cloud Functions की मदद से, डेटा डालने के समय एग्रीगेशन

अगर क्लाइंट-साइड लेन-देन आपके ऐप्लिकेशन के लिए सही नहीं हैं, तो रेस्टोरेंट में हर बार नई रेटिंग जोड़ने पर, कुल जानकारी अपडेट करने के लिए Cloud फ़ंक्शन का इस्तेमाल किया जा सकता है:

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
        });
      });
    });
index.js

यह समाधान, क्लाइंट से होस्ट किए गए फ़ंक्शन पर काम को ऑफ़लोड करता है. इसका मतलब है कि आपका मोबाइल ऐप्लिकेशन, लेन-देन के पूरा होने का इंतज़ार किए बिना रेटिंग जोड़ सकता है. Cloud फ़ंक्शन में चलाया गया कोड, सुरक्षा नियमों के दायरे में नहीं आता. इसका मतलब है कि अब आपको क्लाइंट को एग्रीगेट किए गए डेटा का लिखने का ऐक्सेस देने की ज़रूरत नहीं है.

सीमाएं

एग्रीगेशन के लिए Cloud फ़ंक्शन का इस्तेमाल करने से, क्लाइंट-साइड लेन-देन से जुड़ी कुछ समस्याओं से बचा जा सकता है. हालांकि, इसमें कुछ और सीमाएं भी होती हैं:

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