Yazma zamanı toplamaları

Cloud Firestore'teki sorgular, büyük koleksiyonlardaki belgeleri bulmanıza olanak tanır. Koleksiyonun bir bütün olarak özellikleri hakkında bilgi edinmek için verileri bir koleksiyon üzerinden toplayabilirsiniz.

Verileri okuma veya yazma sırasında toplayabilirsiniz:

  • Okuma zamanı toplama işlemleri, istek sırasında bir sonucu hesaplar. Cloud Firestore, okuma sırasında count(), sum() ve average() toplama sorgularını destekler. Okuma zamanı toplama sorguları, yazma zamanı toplama işlemlerine kıyasla uygulamanıza daha kolay eklenir. Toplama sorguları hakkında daha fazla bilgi için Toplama sorgularıyla verileri özetleme başlıklı makaleyi inceleyin.

  • Yazma sırasındaki toplama işlemleri, uygulama her alakalı yazma işlemi gerçekleştirdiğinde bir sonuç hesaplar. Yazma zamanı toplamalarının uygulanması daha fazla iş gerektirir ancak aşağıdaki nedenlerden biri nedeniyle okuma zamanı toplamalarının yerine bunları kullanabilirsiniz:

    • Anlık güncellemeler için toplama sonucunu dinlemek istiyorsunuz. count(), sum() ve average() toplama sorguları gerçek zamanlı güncellemeleri desteklemez.
    • Toplama sonucunu istemci tarafında bir önbellekte depolamak istiyorsanız. count(), sum() ve average() toplama sorguları önbelleğe almayı desteklemez.
    • Kullanıcılarınızın her biri için on binlerce dokümanda bulunan verileri toplayıp maliyetleri göz önünde bulunduruyorsunuz. Daha az sayıda belgede okuma süresi toplama işlemleri daha az maliyetlidir. Bir toplamadaki çok sayıda belge için yazma zamanındaki toplama işlemleri daha uygun maliyetli olabilir.

Yazma zamanında toplama işlemini istemci tarafı işlem veya Cloud Functions ile uygulayabilirsiniz. Aşağıdaki bölümlerde, yazma zamanında toplama işlemlerinin nasıl uygulanacağı açıklanmaktadır.

Çözüm: İstemci tarafı işlemle yazma zamanında toplama

Kullanıcıların mükemmel restoranlar bulmasına yardımcı olan bir yerel öneriler uygulaması düşünebilirsiniz. Aşağıdaki sorgu, belirli bir restoranın tüm puanlarını alır:

Web

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

Swift

Not: Bu ürün, watchOS ve App Clip hedeflerinde kullanılamaz. 
do {
  let snapshot = try await db.collection("restaurants")
    .document("arinell-pizza")
    .collection("ratings")
    .getDocuments()
  print(snapshot)
} catch {
  print(error)
}
SolutionAggregationViewController.swift

Objective-C

Not: Bu ürün, watchOS ve App Clip hedeflerinde kullanılamaz. 
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

Tüm derecelendirmeleri getirip toplu bilgileri hesaplamak yerine bu bilgileri restoran belgesinde saklayabiliriz:

Web

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

Swift

Not: Bu ürün, watchOS ve App Clip hedeflerinde kullanılamaz. 
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

Not: Bu ürün, watchOS ve App Clip hedeflerinde kullanılamaz. 
@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

Bu toplama işlemlerinin tutarlı kalması için alt koleksiyona her yeni derecelendirme eklendiğinde güncellenmesi gerekir. Tutarlılığı sağlamanın bir yolu, ekleme ve güncelleme işlemlerini tek bir işlemde gerçekleştirmektir:

Web

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

Not: Bu ürün, watchOS ve App Clip hedeflerinde kullanılamaz. 
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

Not: Bu ürün, watchOS ve App Clip hedeflerinde kullanılamaz. 
- (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

İşlem kullanmak, toplu verilerinizi temel koleksiyonla tutarlı tutar. Cloud Firestore'teki işlemler hakkında daha fazla bilgi edinmek için İşlemler ve Toplu Yazmalar başlıklı makaleyi inceleyin.

Sınırlamalar

Yukarıda gösterilen çözümde, Cloud Firestore istemci kitaplığı kullanılarak verilerin toplanması gösterilmektedir. Ancak aşağıdaki sınırlamalara dikkat etmeniz gerekir:

  • Güvenlik: İstemci tarafı işlemler, istemcilere veritabanınızdaki toplu verileri güncelleme izni verilmesini gerektirir. Gelişmiş güvenlik kuralları yazarak bu yaklaşımın risklerini azaltabilirsiniz ancak bu her durumda uygun olmayabilir.
  • Çevrimdışı destek: Kullanıcının cihazı çevrimdışı olduğunda istemci tarafı işlemler başarısız olur. Bu durumda, bu durumu uygulamanızda ele almanız ve uygun zamanda yeniden denemeniz gerekir.
  • Performans: İşleminiz birden fazla okuma, yazma ve güncelleme işlemi içeriyorsa Cloud Firestore arka ucuna birden fazla istek gönderilmesi gerekebilir. Bu işlem mobil cihazlarda biraz zaman alabilir.
  • Yazma hızları: Cloud Firestore belgeleri en fazla saniyede bir güncellenebildiğinden bu çözüm, sık güncellenen toplama işlemleri için işe yaramayabilir. Ayrıca, bir işlem işlem dışında değiştirilmiş bir dokümanı okursa sınırlı sayıda deneme yapar ve ardından başarısız olur. Daha sık güncelleme gerektiren toplama işlemleri için ilgili geçici çözüm için dağıtılmış sayaçlara göz atın.

Çözüm: Cloud Functions ile yazma zamanında toplama

Müşteri tarafı işlemleri uygulamanız için uygun değilse bir restorana her yeni puan eklendiğinde toplu bilgileri güncellemek için bir Cloud işlevi kullanabilirsiniz:

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

Bu çözüm, istemciden barındırılan bir işleve iş yükünü aktarır. Bu sayede mobil uygulamanız, bir işlemin tamamlanmasını beklemeden puan ekleyebilir. Cloud Functions'da çalıştırılan kod, güvenlik kurallarına tabi değildir. Bu, artık istemcilere toplu verilere yazma erişimi vermeniz gerekmediği anlamına gelir.

Sınırlamalar

Toplama işlemleri için Cloud Functions kullanmak, istemci tarafı işlemlerle ilgili bazı sorunları önler ancak farklı bir dizi sınırlamayla birlikte gelir:

  • Maliyet: Eklenen her puan, Cloud işlevi çağrısına neden olur ve bu da maliyetlerinizi artırabilir. Daha fazla bilgi için Cloud Functions fiyatlandırma sayfasını inceleyin.
  • Gecikme: Toplama işlemini bir Cloud Functions işlevine aktardığınızda, Cloud Functions işlevi yürütülmeyi tamamlayana ve istemci yeni veriler hakkında bilgilendirilene kadar uygulamanız güncellenmiş verileri görmez. Bu işlem, Cloud Functions işlevinizin hızına bağlı olarak yerel olarak yürütmekten daha uzun sürebilir.
  • Yazma hızları: Cloud Firestore belgeleri en fazla saniyede bir güncellenebildiğinden bu çözüm, sık güncellenen toplama işlemleri için işe yaramayabilir. Ayrıca, bir işlem işlem dışında değiştirilmiş bir dokümanı okursa sınırlı sayıda deneme yapar ve ardından başarısız olur. Daha sık güncelleme gerektiren toplama işlemleri için ilgili geçici çözüm için dağıtılmış sayaçlara göz atın.