Yazma zamanı toplamaları

Cloud Firestore'daki sorgular, büyük koleksiyonlardaki belgeleri bulmanızı sağlar. Bir bütün olarak koleksiyonun özellikleri hakkında bilgi edinmek için verileri bir koleksiyonda birleştirebilirsiniz.

Verileri okuma anında veya yazma sırasında toplayabilirsiniz:

  • Okuma zamanı toplamaları, istek sırasındaki sonucu hesaplar. Cloud Firestore, okuma zamanında count(), sum() ve average() toplama sorgularını destekler. Uygulamanıza okuma zamanında toplama sorguları eklemek, yazma zamanında toplama işlemlerine kıyasla daha kolaydır. Toplama sorguları hakkında daha fazla bilgi için Toplama sorgularıyla verileri özetleme bölümüne bakın.

  • Yazma zamanı toplamaları, uygulama ilgili bir yazma işlemi gerçekleştirdiğinde bir sonucu hesaplar. Yazma zamanı toplamaları daha etkilidir ancak aşağıdaki nedenlerden biri nedeniyle okuma zamanı toplama yerine bunları kullanabilirsiniz:

    • Gerçek zamanlı güncellemeler için toplama sonucunu dinlemek istiyorsunuz. count(), sum() ve average() toplama sorguları gerçek zamanlı güncellemeleri desteklemez.
    • Toplama sonucunu istemci tarafı önbellekte depolamak istiyorsunuz. count(), sum() ve average() toplama sorguları önbelleğe almayı desteklemez.
    • Kullanıcılarınızın her biri için on binlerce belgeden veri topluyor ve maliyetleri göz önünde bulunduruyorsunuz. Daha az sayıda belgeyle okuma süresi toplamalarının maliyeti daha düşüktür. Toplamalardaki çok sayıda belge için yazma zamanı toplamalarının maliyeti daha düşük olabilir.

İstemci taraflı işlem veya Cloud Functions ile yazma zamanı toplaması uygulayabilirsiniz. Aşağıdaki bölümlerde, yazma zamanı toplamalarının nasıl uygulanacağı açıklanmaktadır.

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

Kullanıcıların mükemmel restoranlar bulmasına yardımcı olan yerel bir öneri uygulaması kullanmayı düşünün. Aşağıdaki sorgu, belirli bir restoranla ilgili tüm puanları getirir:

Web

db.collection("restaurants")
  .doc("arinell-pizza")
  .collection("ratings")
  .get();

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)
}

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

Kotlin+KTX

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

Java

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

Tüm puanları getirmek ve ardından toplu bilgileri hesaplamak yerine, bu bilgileri restoran belgesinin kendisinde depolayabiliriz:

Web

var arinellDoc = {
  name: 'Arinell Pizza',
  avgRating: 4.65,
  numRatings: 683
};

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)

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

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

Bu toplamaların tutarlı olması için alt koleksiyona her yeni puan eklendiğinde bu toplamaların güncellenmesi gerekir. Tutarlılığı sağlamanın bir yolu, ekleme ve güncellemeyi 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 });
        });
    });
}

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 {
    // ...
  }
}

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

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

İşlem kullanmak, birleştirilmiş verilerinizin temel koleksiyonla tutarlı kalmasını sağlar. Cloud Firestore'daki işlemler hakkında daha fazla bilgi edinmek için İşlemler ve Toplu Yazma İşlemleri bölümüne bakın.

Sınırlamalar

Yukarıda gösterilen çözüm, Cloud Firestore istemci kitaplığını kullanarak veri toplamayı gösterir ancak aşağıdaki sınırlamalara dikkat etmeniz gerekir:

  • Güvenlik: İstemci tarafı işlemler, istemcilere veritabanınızdaki birleştirilmiş verileri güncelleme izni verilmesini gerektirir. Gelişmiş güvenlik kuralları yazarak bu yaklaşımın risklerini azaltabilirsiniz. Ancak bu, tüm durumlarda uygun olmayabilir.
  • Çevrimdışı destek: Kullanıcının cihazı çevrimdışıyken istemci taraflı işlemler başarısız olur. Bu da, uygulamanızda bu destek kaydını ele alıp uygun zamanda yeniden denemeniz gerektiği anlamına gelir.
  • Performans: İşleminiz birden fazla okuma, yazma ve güncelleme işlemi içeriyorsa Cloud Firestore arka ucuna birden fazla istek gönderilebilir. Mobil cihazlarda bu işlem çok zaman alabilir.
  • Yazma hızları: Cloud Firestore belgeleri yalnızca saniyede en fazla bir kez güncellenebileceği için bu çözüm, sık güncellenen toplamalarda çalışmayabilir. Buna ek olarak, bir işlem, işlemin dışında değiştirilmiş bir dokümanı okursa sınırlı sayıda yeniden dener ve daha sonra başarısız olur. Daha sık güncellemelere ihtiyaç duyan toplamalara yönelik bir geçici çözüm için dağıtılmış sayaçlara göz atın.

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

İstemci tarafı işlemler uygulamanız için uygun değilse bir restorana her yeni puan eklendiğinde toplu bilgileri güncellemek için Cloud Function 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
        });
      });
    });

Bu çözüm, işi istemciden barındırılan bir işleve aktarır. Böylece mobil uygulamanız, bir işlemin tamamlanmasını beklemeden puan ekleyebilir. Cloud Functions işlevinde yürütülen kod, güvenlik kurallarına tabi değildir. Bu nedenle, artık istemcilere birleştirilmiş veriler için yazma erişimi vermeniz gerekmez.

Sınırlamalar

Toplamalar için Cloud Functions işlevi kullanmak, istemci tarafı işlemleriyle ilgili bazı sorunları önler ancak farklı sınırlamaları beraberinde getirir:

  • Maliyet: Eklenen her derecelendirme bir Cloud Functions işlevi çağrısına neden olur ve maliyetlerinizi artırabilir. Daha fazla bilgi için Cloud Functions fiyatlandırma sayfasına göz atın.
  • Gecikme: Toplama çalışmasını bir Cloud Functions işlevine boşalttığınızda uygulamanız, Cloud Functions işlevinin yürütülmesi bitene ve müşteri yeni veriler hakkında bilgilendirilene kadar güncellenmiş verileri görmez. Cloud Functions işlevinizin hızına bağlı olarak bu, işlemin yerel olarak yürütülmesinden daha uzun sürebilir.
  • Yazma hızları: Cloud Firestore belgeleri yalnızca saniyede en fazla bir kez güncellenebileceği için bu çözüm, sık güncellenen toplamalarda çalışmayabilir. Buna ek olarak, bir işlem, işlemin dışında değiştirilmiş bir dokümanı okursa sınırlı sayıda yeniden dener ve daha sonra başarısız olur. Daha sık güncellemelere ihtiyaç duyan toplamalara yönelik bir geçici çözüm için dağıtılmış sayaçlara göz atın.