Cloud Firestore डेटा बंडल, स्टैटिक डेटा फ़ाइलें होती हैं. इन्हें Cloud Firestore दस्तावेज़ और क्वेरी के स्नैपशॉट से बनाया जाता है. साथ ही, इन्हें CDN, होस्टिंग सेवा या किसी अन्य समाधान पर पब्लिश किया जाता है. डेटा बंडल में, वे दस्तावेज़ शामिल होते हैं जिन्हें आपको अपने क्लाइंट ऐप्लिकेशन को उपलब्ध कराना है. साथ ही, उन क्वेरी के बारे में मेटाडेटा भी शामिल होता है जिनसे वे दस्तावेज़ जनरेट हुए हैं. नेटवर्क या लोकल स्टोरेज से बंडल डाउनलोड करने के लिए, क्लाइंट SDK टूल का इस्तेमाल किया जाता है. इसके बाद, बंडल डेटा को Cloud Firestore लोकल कैश मेमोरी में लोड किया जाता है. बंडल लोड होने के बाद, क्लाइंट ऐप्लिकेशन, स्थानीय कैश मेमोरी या बैकएंड से दस्तावेज़ों के बारे में क्वेरी कर सकता है.
डेटा बंडल की मदद से, आपके ऐप्लिकेशन सामान्य क्वेरी के नतीजे जल्दी लोड कर सकते हैं. ऐसा इसलिए होता है, क्योंकि दस्तावेज़ ऐप्लिकेशन के शुरू होने पर उपलब्ध होते हैं. इसके लिए, Cloud Firestore बैकएंड को कॉल करने की ज़रूरत नहीं होती. अगर नतीजे लोकल कैश मेमोरी से लोड किए जाते हैं, तो आपको ऐक्सेस शुल्क में भी कमी का फ़ायदा मिलता है. शुरुआती 100 दस्तावेज़ों के लिए, एक लाख ऐप्लिकेशन इंस्टेंस के लिए पैसे चुकाने के बजाय, आपको सिर्फ़ उन 100 दस्तावेज़ों को बंडल करने के लिए ज़रूरी क्वेरी के लिए पैसे चुकाने होंगे.
Cloud Firestore डेटा बंडल, Firebase के अन्य बैकएंड प्रॉडक्ट के साथ बेहतर तरीके से काम करने के लिए बनाए गए हैं. इंटिग्रेट किए गए समाधान पर एक नज़र डालें, जिसमें बंडल Cloud Functions से बनाए जाते हैं और Firebase Hosting की मदद से उपयोगकर्ताओं को दिखाए जाते हैं.
अपने ऐप्लिकेशन के साथ बंडल का इस्तेमाल करने के लिए, यह तरीका अपनाएं:
- Admin SDK टूल की मदद से बंडल बनाना
- बंडल को लोकल स्टोरेज या सीडीएन से दिखाना
- क्लाइंट में बंडल लोड करना
डेटा बंडल क्या है?
डेटा बंडल, एक स्टैटिक बाइनरी फ़ाइल होती है. इसे एक या एक से ज़्यादा दस्तावेज़ और/या क्वेरी के स्नैपशॉट को पैकेज करने के लिए बनाया जाता है. साथ ही, इससे नाम वाली क्वेरी निकाली जा सकती हैं. जैसा कि हम यहां बता रहे हैं, सर्वर-साइड SDK टूल की मदद से बंडल बनाए जा सकते हैं और क्लाइंट-साइड SDK टूल की मदद से, बंडल को लोकल कैश मेमोरी में लोड किया जा सकता है.
नाम वाली क्वेरी, बंडल की एक खास सुविधा है. नाम वाली क्वेरी, Query ऑब्जेक्ट होती हैं. इन्हें किसी बंडल से निकाला जा सकता है. इसके बाद, कैश मेमोरी या बैकएंड से डेटा क्वेरी करने के लिए, तुरंत इस्तेमाल किया जा सकता है. यह वही तरीका है जिसका इस्तेमाल, Cloud Firestore से जुड़े अपने ऐप्लिकेशन के किसी भी हिस्से में किया जाता है.
सर्वर पर डेटा बंडल बनाना
Node.js या Java Admin SDK का इस्तेमाल करने पर, आपके पास यह तय करने का पूरा कंट्रोल होता है कि बंडल में क्या शामिल करना है और उन्हें कैसे दिखाना है.
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()
डेटा बंडल दिखाना
अपने क्लाइंट ऐप्लिकेशन को बंडल, सीडीएन से या Cloud Storage से डाउनलोड करके दिखाए जा सकते हैं.
मान लें कि पिछले सेक्शन में बनाया गया बंडल, bundle.txt नाम की फ़ाइल में सेव किया गया है और सर्वर पर पोस्ट किया गया है. यह बंडल फ़ाइल, वेब पर दिखाई जा सकने वाली किसी भी अन्य ऐसेट की तरह ही होती है. यहां एक आसान Node.js Express ऐप्लिकेशन के लिए इसे दिखाया गया है.
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);
क्लाइंट में डेटा बंडल लोड करना
Firestore के बंडल को किसी रिमोट सर्वर से फ़ेच करके लोड किया जाता है. इसके लिए, एचटीटीपी अनुरोध किया जा सकता है, स्टोरेज एपीआई को कॉल किया जा सकता है या नेटवर्क पर बाइनरी फ़ाइलें फ़ेच करने के लिए किसी अन्य तकनीक का इस्तेमाल किया जा सकता है.
फ़ेच होने के बाद, आपका ऐप्लिकेशन Cloud Firestore क्लाइंट SDK टूल का इस्तेमाल करके, loadBundle तरीके को कॉल करता है. इससे, टास्क ट्रैकिंग ऑब्जेक्ट मिलता है. इस ऑब्जेक्ट के पूरा होने की निगरानी, Promise के स्टेटस की निगरानी करने की तरह की जा सकती है.
बंडल लोड होने के बाद, बंडल का कॉन्टेंट लोकल कैश मेमोरी में उपलब्ध हो जाता है.
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
// ...
}
});
}
Dart
// Get a bundle from a server
final url = Uri.https('example.com', '/create-bundle');
final response = await http.get(url);
String body = response.body;
final buffer = Uint8List.fromList(body.codeUnits);
// Load a bundle from a buffer
LoadBundleTask task = FirebaseFirestore.instance.loadBundle(buffer);
await task.stream.toList();
// Use the cached named query
final results = await FirebaseFirestore.instance.namedQueryGet(
"latest-stories-query",
options: const GetOptions(
source: Source.cache,
),
);
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> &){
// ...
});
});
});
ध्यान दें कि अगर आपने 30 मिनट से भी कम समय पहले बनाए गए बंडल से, नाम वाली क्वेरी को लोड किया है, तो कैश मेमोरी के बजाय बैकएंड से पढ़ने के लिए इसका इस्तेमाल करने पर, आपको सिर्फ़ डेटाबेस रीड के लिए पैसे चुकाने होंगे. ऐसा इसलिए, ताकि दस्तावेज़ों को बैकएंड में सेव किए गए डेटा से मैच करने के लिए अपडेट किया जा सके. इसका मतलब है कि आपको सिर्फ़ डेल्टा के लिए पैसे चुकाने होंगे.
आगे क्या करना है?
क्लाइंट साइड (Apple, Android, वेब) और सर्वर साइड (Node.js) के लिए, डेटा बंडल API के रेफ़रंस दस्तावेज़ देखें.
अगर आपने अभी तक ऐसा नहीं किया है, तो बंडल बनाने और उन्हें दिखाने के लिए Cloud Functions और Firebase Hosting समाधान देखें.