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

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();

Swift

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

Objective-C

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

Kotlin+KTX

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 और ऐप्लिकेशन क्लिप टारगेट पर उपलब्ध नहीं है.
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+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)

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 और ऐप्लिकेशन क्लिप टारगेट पर उपलब्ध नहीं है.
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+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
    }
}

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

सीमाएं

एग्रीगेशन के लिए Cloud Function का इस्तेमाल करने से, लेन-देन के मामलों में कुछ अलग सीमाएं होती हैं, जैसे कि:

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