इस पेज का अनुवाद Cloud Translation API से किया गया है.

लिखने के दौरान एग्रीगेशन

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

डेटा को पढ़ने के समय या लिखते समय इकट्ठा किया जा सकता है:

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

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

समाधान: क्लाइंट-साइड ट्रांज़ैक्शन की मदद से राइट-टाइम एग्रीगेशन

आस-पास के नतीजे दिखाने वाले किसी ऐसे ऐप्लिकेशन का इस्तेमाल करें जिससे उपयोगकर्ताओं को अच्छे रेस्टोरेंट ढूंढने में मदद मिले. नीचे दी गई क्वेरी में किसी रेस्टोरेंट की सभी रेटिंग फिर से इकट्ठा की जाती हैं:

वेब

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

Swift

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

do {
  let snapshot = try await db.collection("restaurants")
    .document("arinell-pizza")
    .collection("ratings")
    .getDocuments()
  print(snapshot)
} catch {
  print(error)
}SolutionAggregationViewController.swift

Objective-C

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

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 और App Clip टारगेट पर उपलब्ध नहीं है.

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 और 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;
}

@endFIRSolutionAggregationViewController.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 और 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 {
    // ...
  }
}SolutionAggregationViewController.swift

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

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

सीमाएं

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

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