Mit Abfragen in Cloud Firestore können Sie Dokumente in großen Sammlungen finden. Um einen Einblick in die Eigenschaften der gesammelt haben, können Sie Daten über eine Sammlung aggregieren.
Sie können Daten entweder zum Lese- oder zum Schreiben aggregieren:
Zusammenfassungen zur Lesezeit berechnen ein Ergebnis zum Zeitpunkt der Anfrage. Cloud Firestore unterstützt die Aggregationsanfragen
count()
,sum()
undaverage()
bei der Lesezeit. Abfragen zur Aggregation bei der Lesezeit lassen sich Ihrer App leichter hinzufügen als Aggregationen bei der Schreibzeit. Weitere Informationen zu Aggregationsabfragen finden Sie unter Daten mit Aggregationsabfragen zusammenfassen.Bei Aggregationen zur Laufzeit von Schreibvorgängen wird jedes Mal ein Ergebnis berechnet, wenn die App einen relevanten Schreibvorgang ausführt. Aggregationen beim Schreiben sind mit größerer Arbeit verbunden, Sie könnten sie jedoch anstelle von Lesezeit-Aggregationen für eine der folgenden Gründen:
- Sie möchten das Aggregationsergebnis auf Echtzeitaktualisierungen überwachen.
Die Aggregationsabfragen
count()
,sum()
undaverage()
werden nicht unterstützt in Echtzeit. - Sie möchten das Aggregationsergebnis in einem clientseitigen Cache speichern.
Bei Aggregationsabfragen vom Typ
count()
,sum()
undaverage()
wird kein Caching unterstützt. - Sie aggregieren Daten aus Zehntausenden von Dokumenten für jeden und die Kosten berücksichtigen. Bei einer geringeren Anzahl von Dokumenten sind Aggregationen bei der Lesezeit günstiger. Bei einer großen Anzahl von Dokumenten in einer Aggregation Aggregationen bei der Schreibzeit möglicherweise weniger kosten.
- Sie möchten das Aggregationsergebnis auf Echtzeitaktualisierungen überwachen.
Die Aggregationsabfragen
Sie können eine Aggregation zur Schreibzeit entweder mit einer clientseitigen Transaktion oder mit Cloud Functions implementieren. In den folgenden Abschnitten wird beschrieben, wie Sie Aggregationen zur Schreibzeit implementieren.
Lösung: Aggregation der Schreibzeit mit einer clientseitigen Transaktion
Stellen Sie sich eine App mit lokalen Empfehlungen vor, mit der Nutzer bei der Suche nach guten Restaurants unterstützt werden. Mit der folgenden Abfrage werden alle Bewertungen für ein bestimmtes Restaurant abgerufen:
Web
db.collection("restaurants") .doc("arinell-pizza") .collection("ratings") .get();
Swift
do { let snapshot = try await db.collection("restaurants") .document("arinell-pizza") .collection("ratings") .getDocuments() print(snapshot) } catch { print(error) }
Objective-C
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();
Anstatt alle Bewertungen abzurufen und dann die aggregierten Daten zu berechnen, können diese Informationen im Restaurantdokument selbst gespeichert werden:
Web
var arinellDoc = { name: 'Arinell Pizza', avgRating: 4.65, numRatings: 683 };
Swift
struct Restaurant { let name: String let avgRating: Float let numRatings: Int } let arinell = Restaurant(name: "Arinell Pizza", avgRating: 4.65, numRatings: 683)
Objective-C
@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);
Damit diese Aggregationen konsistent bleiben, müssen sie jedes Mal aktualisiert werden, wenn eine neue Bewertung zur untergeordneten Sammlung hinzugefügt wird. Eine Möglichkeit, Konsistenz zu erreichen, besteht darin, das Hinzufügen und Aktualisieren in einer einzigen Transaktion durchzuführen:
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
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
- (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; } }); }
Mit einer Transaktion bleiben Ihre aggregierten Daten mit der zugrunde liegenden Sammlung konsistent. Weitere Informationen zu Transaktionen in Cloud Firestore finden Sie unter Transaktionen und Batch-Schreibvorgänge.
Beschränkungen
Die oben gezeigte Lösung zeigt das Aggregieren von Daten mithilfe der Cloud Firestore-Clientbibliothek, beachten Sie jedoch Folgendes: Einschränkungen:
- Sicherheit – Clientseitige Transaktionen setzen voraus, dass die Clients die Berechtigung zum Aktualisieren der aggregierten Daten in Ihrer Datenbank haben. Sie können zwar die Risiken dieses Ansatzes reduzieren, indem Sie erweiterte Sicherheitsregeln schreiben, dies ist jedoch möglicherweise nicht in allen Situationen angebracht.
- Offline nutzbar – Clientseitige Transaktionen schlagen fehl, wenn das Gerät des Nutzers offline ist. Das bedeutet, dass Sie diesen Fall in Ihrer App verarbeiten und die Transaktion später wiederholen müssen.
- Leistung – Wenn Ihre Transaktion mehrere Lese-, Schreib- und kann es mehrere Anfragen an den Cloud Firestore-Back-End. Auf einem Mobilgerät kann dies viel Zeit in Anspruch nehmen.
- Schreibraten: Diese Lösung funktioniert möglicherweise nicht für häufig aktualisierte Aggregationen, da Cloud Firestore-Dokumente nur einmal pro Sekunde aktualisiert werden können. Wenn eine Transaktion ein Dokument liest, das außerhalb der Transaktion geändert wurde, wird außerdem eine endliche Anzahl von Wiederholungen ausgeführt und schlägt dann fehl. Unter Verteilte Zähler finden Sie eine relevante Problemumgehung für Aggregationen, die häufigere Aktualisierungen erfordern.
Lösung: Aggregation der Schreibzeit mit Cloud Functions
Wenn clientseitige Transaktionen für Ihre Anwendung nicht geeignet sind, können Sie die aggregierten Informationen mit einer Cloud Functions-Funktion jedes Mal aktualisieren, wenn eine neue Bewertung zu einem Restaurant hinzugefügt wird:
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 }); }); });
Mit dieser Lösung wird die Arbeit vom Client an eine gehostete Funktion übertragen. Das bedeutet, dass in Ihrer mobilen App Bewertungen hinzugefügt werden können, ohne auf den Abschluss einer Transaktion warten zu müssen. Code, der in einer Cloud Functions-Funktion ausgeführt wird, ist nicht an Sicherheitsregeln gebunden. Das bedeutet, dass Sie den Clients keinen Schreibzugriff mehr auf die aggregierten Daten geben müssen.
Beschränkungen
Durch die Verwendung einer Cloud Functions-Funktion für Aggregationen werden einige Probleme bei clientseitigen Transaktionen vermieden. Es gibt jedoch andere Einschränkungen:
- Kosten – Jede hinzugefügte Bewertung führt zu einem Aufruf von Cloud Functions, wodurch Ihre Kosten steigen können. Weitere Informationen finden Sie auf der Preisseite für Cloud Functions.
- Latenz – Durch die Übertragung der Aggregationsarbeit auf Cloud Functions werden in Ihrer App keine aktualisierten Daten angezeigt, bis die Cloud Functions-Funktion ausgeführt und der Client über die neuen Daten informiert wurde. Abhängig von der Geschwindigkeit Ihrer Cloud Functions-Funktion kann dies länger dauern als die lokale Ausführung der Transaktion.
- Schreibraten: Diese Lösung funktioniert möglicherweise nicht für häufig aktualisierte Aggregationen, da Cloud Firestore-Dokumente nur einmal pro Sekunde aktualisiert werden können. Wenn eine Transaktion ein Dokument liest, das außerhalb der Transaktion geändert wurde, wird außerdem eine endliche Anzahl von Wiederholungen ausgeführt und schlägt dann fehl. Unter Verteilte Zähler finden Sie eine relevante Problemumgehung für Aggregationen, die häufigere Aktualisierungen erfordern.