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

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

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

Objective-C

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

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

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

}

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

Objective-C

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

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

ध्यान दें: यह प्रॉडक्ट, watchOS और App Clip टारगेट पर उपलब्ध नहीं है.
- (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 फ़ंक्शन का इस्तेमाल करके, हर बार किसी रेस्टोरेंट को नई रेटिंग मिलने पर कुल जानकारी अपडेट की जा सकती है:

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 फ़ंक्शन का इस्तेमाल करने से, क्लाइंट-साइड लेन-देन से जुड़ी कुछ समस्याएं हल हो जाती हैं. हालांकि, इसमें कुछ अन्य सीमाएं होती हैं:

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