Cloud Firestore-Datenpakete sind statische Datendateien, die Sie aus Cloud Firestore-Dokument- und Abfrage-Snapshots erstellen und in einem CDN, einem Hostingdienst oder einer anderen Lösung veröffentlichen. Daten-Bundles enthalten sowohl die Dokumente, die Sie für Ihre Client-Apps zur Verfügung stellen möchten, sowie Metadaten zu den Abfragen der sie generiert hat. Sie verwenden Client-SDKs, um Bundles über das Netzwerk oder aus dem lokalen Speicher, bevor Sie die Bundle-Daten in den Cloud Firestore laden lokalen Cache. Sobald ein Bundle geladen ist, kann eine Client-App Dokumente aus dem lokalen Cache oder das Back-End.
Mit Daten-Bundles können Ihre Anwendungen die Ergebnisse häufiger Abfragen schneller laden, da Dokumente beim Start zur Verfügung stehen, ohne dass Cloud Firestore-Back-End. Wenn Ergebnisse aus dem lokalen Cache geladen werden, profitieren von geringeren Zugriffskosten. Anstatt für eine Million Apps zu bezahlen, dieselben ersten 100 Dokumente abgefragt werden, bezahlen Sie nur für die um diese 100 Dokumente zu bündeln.
Cloud Firestore-Daten-Bundles sind für die Zusammenarbeit mit anderen Firebase-Produkten konzipiert Back-End-Produkte. Integrierte Lösung kennenlernen in denen Bundles von Cloud Functions erstellt und für Nutzer mit Firebase Hosting.
Die Verwendung eines Bundles mit Ihrer App umfasst drei Schritte:
- Bundle mit dem Admin SDK erstellen
- Bundle aus lokalem Speicher oder über ein CDN bereitstellen
- Bundles im Client laden
Was ist ein Datenpaket?
Ein Datenpaket ist eine statische Binärdatei, die Sie zum Verpacken eines oder mehrerer Dokument- und/oder Abfrage-Snapshots erstellen und aus der Sie benannte Abfragen extrahieren können. Wie unten erläutert, können Sie mit den serverseitigen SDKs Bundles und Client-SDKs bieten Methoden zum Laden von Bundles in den lokalen Cache.
Benannte Abfragen sind eine besonders leistungsstarke Funktion von Sets. Benannte Abfragen sind
Query
Objekte, die Sie aus einem Bundle extrahieren und sofort verwenden können
um Daten entweder aus dem Cache oder vom Back-End abzufragen, wie Sie es normalerweise in
Teil deiner App, der mit Cloud Firestore kommuniziert.
Daten-Bundles auf dem Server erstellen
Mit dem Node.js oder Java Admin SDK können Sie was in die Sets aufgenommen und wie sie ausgeliefert werden.
Node.js
var bundleId = "latest-stories"; var bundle = firestore.bundle(bundleId); var docSnapshot = await firestore.doc('stories/stories').get(); var querySnapshot = await firestore.collection('stories').get(); // Build the bundle // Note how querySnapshot is named "latest-stories-query" var bundleBuffer = bundle.add(docSnapshot); // Add a document .add('latest-stories-query', querySnapshot) // Add a named query. .build()
Java
Firestore db = FirestoreClient.getFirestore(app); // Query the 50 latest stories QuerySnapshot latestStories = db.collection("stories") .orderBy("timestamp", Direction.DESCENDING) .limit(50) .get() .get(); // Build the bundle from the query results FirestoreBundle bundle = db.bundleBuilder("latest-stories") .add("latest-stories-query", latestStories) .build();
Python
from google.cloud import firestore from google.cloud.firestore_bundle import FirestoreBundle db = firestore.Client() bundle = FirestoreBundle("latest-stories") doc_snapshot = db.collection("stories").document("news-item").get() query = db.collection("stories")._query() # Build the bundle # Note how `query` is named "latest-stories-query" bundle_buffer: str = bundle.add_document(doc_snapshot).add_named_query( "latest-stories-query", query, ).build()
Daten-Bundles bereitstellen
Sie können Bundles für Ihre Client-Apps von einem CDN bereitstellen oder sie herunterladen. aus, z. B. Cloud Storage.
Angenommen, das im vorherigen Abschnitt erstellte Bundle
in einer Datei namens bundle.txt
gespeichert und auf einem Server veröffentlicht. Diese Bundle-Datei ist wie jedes andere Asset, das Sie über das Web bereitstellen können, wie hier für eine einfache Node.js Express-Anwendung gezeigt.
const fs = require('fs');
const server = require('http').createServer();
server.on('request', (req, res) => {
const src = fs.createReadStream('./bundle.txt');
src.pipe(res);
});
server.listen(8000);
Daten-Bundles im Client laden
Firestore-Bundles laden Sie, indem Sie sie von einem Remote-Server abrufen, unabhängig davon, ob durch Senden einer HTTP-Anfrage, durch Aufrufen einer Storage API oder mithilfe einer anderen Methode zum Abrufen von Binärdateien in einem Netzwerk.
Nach dem Abruf mit dem Cloud Firestore-Client-SDK ruft deine App die
loadBundle
-Methode, die ein Aufgaben-Tracking-Objekt zurückgibt,
die Sie bei der Überwachung des Status eines Promise sehr häufig überwachen können.
Nach Abschluss der Aufgabe zum Laden des Bundles sind die Bundle-Inhalte im lokalen Cache verfügbar.
Web
import { loadBundle, namedQuery, getDocsFromCache } from "firebase/firestore"; async function fetchFromBundle() { // Fetch the bundle from Firebase Hosting, if the CDN cache is hit the 'X-Cache' // response header will be set to 'HIT' const resp = await fetch('/createBundle'); // Load the bundle contents into the Firestore SDK await loadBundle(db, resp.body); // Query the results from the cache const query = await namedQuery(db, 'latest-stories-query'); const storiesSnap = await getDocsFromCache(query); // Use the results // ... }
Web
// If you are using module bundlers. import firebase from "firebase/app"; import "firebase/firestore"; import "firebase/firestore/bundle"; // This line enables bundle loading as a side effect. // ... async function fetchFromBundle() { // Fetch the bundle from Firebase Hosting, if the CDN cache is hit the 'X-Cache' // response header will be set to 'HIT' const resp = await fetch('/createBundle'); // Load the bundle contents into the Firestore SDK await db.loadBundle(resp.body); // Query the results from the cache // Note: omitting "source: cache" will query the Firestore backend. const query = await db.namedQuery('latest-stories-query'); const storiesSnap = await query.get({ source: 'cache' }); // Use the results // ... }
Swift
// Utility function for errors when loading bundles. func bundleLoadError(reason: String) -> NSError { return NSError(domain: "FIRSampleErrorDomain", code: 0, userInfo: [NSLocalizedFailureReasonErrorKey: reason]) } func fetchRemoteBundle(for firestore: Firestore, from url: URL) async throws -> LoadBundleTaskProgress { guard let inputStream = InputStream(url: url) else { let error = self.bundleLoadError(reason: "Unable to create stream from the given url: \(url)") throw error } return try await firestore.loadBundle(inputStream) } // Fetches a specific named query from the provided bundle. func loadQuery(named queryName: String, fromRemoteBundle bundleURL: URL, with store: Firestore) async throws -> Query { let _ = try await fetchRemoteBundle(for: store, from: bundleURL) if let query = await store.getQuery(named: queryName) { return query } else { throw bundleLoadError(reason: "Could not find query named \(queryName)") } } // Load a query and fetch its results from a bundle. func runStoriesQuery() async { let queryName = "latest-stories-query" let firestore = Firestore.firestore() let remoteBundle = URL(string: "https://example.com/createBundle")! do { let query = try await loadQuery(named: queryName, fromRemoteBundle: remoteBundle, with: firestore) let snapshot = try await query.getDocuments() print(snapshot) // handle query results } catch { print(error) } }
Objective-C
// Utility function for errors when loading bundles. - (NSError *)bundleLoadErrorWithReason:(NSString *)reason { return [NSError errorWithDomain:@"FIRSampleErrorDomain" code:0 userInfo:@{NSLocalizedFailureReasonErrorKey: reason}]; } // Loads a remote bundle from the provided url. - (void)fetchRemoteBundleForFirestore:(FIRFirestore *)firestore fromURL:(NSURL *)url completion:(void (^)(FIRLoadBundleTaskProgress *_Nullable, NSError *_Nullable))completion { NSInputStream *inputStream = [NSInputStream inputStreamWithURL:url]; if (inputStream == nil) { // Unable to create input stream. NSError *error = [self bundleLoadErrorWithReason: [NSString stringWithFormat:@"Unable to create stream from the given url: %@", url]]; completion(nil, error); return; } [firestore loadBundleStream:inputStream completion:^(FIRLoadBundleTaskProgress * _Nullable progress, NSError * _Nullable error) { if (progress == nil) { completion(nil, error); return; } if (progress.state == FIRLoadBundleTaskStateSuccess) { completion(progress, nil); } else { NSError *concreteError = [self bundleLoadErrorWithReason: [NSString stringWithFormat: @"Expected bundle load to be completed, but got %ld instead", (long)progress.state]]; completion(nil, concreteError); } completion(nil, nil); }]; } // Loads a bundled query. - (void)loadQueryNamed:(NSString *)queryName fromRemoteBundleURL:(NSURL *)url withFirestore:(FIRFirestore *)firestore completion:(void (^)(FIRQuery *_Nullable, NSError *_Nullable))completion { [self fetchRemoteBundleForFirestore:firestore fromURL:url completion:^(FIRLoadBundleTaskProgress *progress, NSError *error) { if (error != nil) { completion(nil, error); return; } [firestore getQueryNamed:queryName completion:^(FIRQuery *query) { if (query == nil) { NSString *errorReason = [NSString stringWithFormat:@"Could not find query named %@", queryName]; NSError *error = [self bundleLoadErrorWithReason:errorReason]; completion(nil, error); return; } completion(query, nil); }]; }]; } - (void)runStoriesQuery { NSString *queryName = @"latest-stories-query"; FIRFirestore *firestore = [FIRFirestore firestore]; NSURL *bundleURL = [NSURL URLWithString:@"https://example.com/createBundle"]; [self loadQueryNamed:queryName fromRemoteBundleURL:bundleURL withFirestore:firestore completion:^(FIRQuery *query, NSError *error) { // Handle query results }]; }
Kotlin+KTX
@Throws(IOException::class) fun getBundleStream(urlString: String?): InputStream { val url = URL(urlString) val connection = url.openConnection() as HttpURLConnection return connection.inputStream } @Throws(IOException::class) fun fetchFromBundle() { val bundleStream = getBundleStream("https://example.com/createBundle") val loadTask = db.loadBundle(bundleStream) // Chain the following tasks // 1) Load the bundle // 2) Get the named query from the local cache // 3) Execute a get() on the named query loadTask.continueWithTask<Query> { task -> // Close the stream bundleStream.close() // Calling .result propagates errors val progress = task.getResult(Exception::class.java) // Get the named query from the bundle cache db.getNamedQuery("latest-stories-query") }.continueWithTask { task -> val query = task.getResult(Exception::class.java)!! // get() the query results from the cache query.get(Source.CACHE) }.addOnCompleteListener { task -> if (!task.isSuccessful) { Log.w(TAG, "Bundle loading failed", task.exception) return@addOnCompleteListener } // Get the QuerySnapshot from the bundle val storiesSnap = task.result // Use the results // ... } }
Java
public InputStream getBundleStream(String urlString) throws IOException { URL url = new URL(urlString); HttpURLConnection connection = (HttpURLConnection) url.openConnection(); return connection.getInputStream(); } public void fetchBundleFrom() throws IOException { final InputStream bundleStream = getBundleStream("https://example.com/createBundle"); LoadBundleTask loadTask = db.loadBundle(bundleStream); // Chain the following tasks // 1) Load the bundle // 2) Get the named query from the local cache // 3) Execute a get() on the named query loadTask.continueWithTask(new Continuation<LoadBundleTaskProgress, Task<Query>>() { @Override public Task<Query> then(@NonNull Task<LoadBundleTaskProgress> task) throws Exception { // Close the stream bundleStream.close(); // Calling getResult() propagates errors LoadBundleTaskProgress progress = task.getResult(Exception.class); // Get the named query from the bundle cache return db.getNamedQuery("latest-stories-query"); } }).continueWithTask(new Continuation<Query, Task<QuerySnapshot>>() { @Override public Task<QuerySnapshot> then(@NonNull Task<Query> task) throws Exception { Query query = task.getResult(Exception.class); // get() the query results from the cache return query.get(Source.CACHE); } }).addOnCompleteListener(new OnCompleteListener<QuerySnapshot>() { @Override public void onComplete(@NonNull Task<QuerySnapshot> task) { if (!task.isSuccessful()) { Log.w(TAG, "Bundle loading failed", task.getException()); return; } // Get the QuerySnapshot from the bundle QuerySnapshot storiesSnap = task.getResult(); // Use the results // ... } }); }
C++
db->LoadBundle("bundle_name", [](const LoadBundleTaskProgress& progress) { switch(progress.state()) { case LoadBundleTaskProgress::State::kError: { // The bundle load has errored. Handle the error in the returned future. return; } case LoadBundleTaskProgress::State::kInProgress: { std::cout << "Bytes loaded from bundle: " << progress.bytes_loaded() << std::endl; break; } case LoadBundleTaskProgress::State::kSuccess: { std::cout << "Bundle load succeeeded" << std::endl; break; } } }).OnCompletion([db](const Future<LoadBundleTaskProgress>& future) { if (future.error() != Error::kErrorOk) { // Handle error... return; } const std::string& query_name = "latest_stories_query"; db->NamedQuery(query_name).OnCompletion([](const Future<Query>& query_future){ if (query_future.error() != Error::kErrorOk) { // Handle error... return; } const Query* query = query_future.result(); query->Get().OnCompletion([](const Future<QuerySnapshot> &){ // ... }); }); });
Wenn Sie eine benannte Abfrage aus einem Bundle laden, das weniger als 30 Minuten Wenn Sie es zum Lesen aus dem Back-End statt aus dem Cache verwendet haben, zahlen nur für Datenbanklesevorgänge, die zum Aktualisieren der Dokumente erforderlich sind, auf dem Back-End gespeichert ist. Sie zahlen also nur für die Deltas.
Und jetzt?
Weitere Informationen finden Sie in der Client-Referenzdokumentation zur Data Bundles API (Apple, Android, Web) und serverseitig (Node.js)
Falls Sie dies noch nicht getan haben, werfen Sie einen Blick auf die Cloud Functions und Firebase Hosting-Lösung für die Erstellung und Bereitstellung Sets