Cloud Firestore, ऑफ़लाइन डेटा को सेव रखने की सुविधा के साथ काम करता है. यह सुविधा, Cloud Firestore के उस डेटा की कॉपी को कैश मेमोरी में सेव करती है जिसे आपका ऐप्लिकेशन इस्तेमाल कर रहा है. इससे आपका ऐप्लिकेशन, डिवाइस के ऑफ़लाइन होने पर डेटा को ऐक्सेस कर सकता है. आपके पास कैश मेमोरी में सेव किए गए डेटा को लिखने, पढ़ने, सुनने, और क्वेरी करने का विकल्प होता है. डिवाइस के ऑनलाइन होने पर, Cloud Firestore आपके ऐप्लिकेशन में किए गए सभी स्थानीय बदलावों को Cloud Firestore बैकएंड के साथ सिंक करता है.
ऑफ़लाइन परसिस्टेंस का इस्तेमाल करने के लिए, आपको उस कोड में कोई बदलाव करने की ज़रूरत नहीं है जिसका इस्तेमाल Cloud Firestore का डेटा ऐक्सेस करने के लिए किया जाता है. ऑफ़लाइन पर्सिस्टेंस की सुविधा चालू होने पर, Cloud Firestore क्लाइंट लाइब्रेरी, ऑनलाइन और ऑफ़लाइन डेटा ऐक्सेस को अपने-आप मैनेज करती है. साथ ही, डिवाइस के ऑनलाइन होने पर स्थानीय डेटा को सिंक करती है.
ऑफ़लाइन पर्सेंटेंस कॉन्फ़िगर करें
Cloud Firestore को शुरू करने पर, ऑफ़लाइन परसिस्टेंस को चालू या बंद किया जा सकता है:
- Android और Apple प्लैटफ़ॉर्म के लिए, ऑफ़लाइन पर्सिस्टेंस की सुविधा डिफ़ॉल्ट रूप से चालू रहती है. परफ़ॉर्मेंस में मदद करने वाली सुविधा को बंद
करने के लिए,
PersistenceEnabled
विकल्प कोfalse
पर सेट करें. - वेब के लिए, ऑफ़लाइन परसिस्टेंस की सुविधा डिफ़ॉल्ट रूप से बंद होती है. डेटा को सेव रखने की सुविधा चालू करने के लिए,
enablePersistence
तरीके को कॉल करें. Cloud Firestore का कैश मेमोरी, सेशन के बीच अपने-आप नहीं मिटता. ऐसे में, अगर आपका वेब ऐप्लिकेशन संवेदनशील जानकारी का इस्तेमाल करता है, तो परसिस्टेंस चालू करने से पहले, उपयोगकर्ता से यह ज़रूर पूछें कि क्या वह भरोसेमंद डिवाइस का इस्तेमाल कर रहा है.
Web
// Memory cache is the default if no config is specified.
initializeFirestore(app);
// This is the default behavior if no persistence is specified.
initializeFirestore(app, {localCache: memoryLocalCache()});
// Defaults to single-tab persistence if no tab manager is specified.
initializeFirestore(app, {localCache: persistentLocalCache(/*settings*/{})});
// Same as `initializeFirestore(app, {localCache: persistentLocalCache(/*settings*/{})})`,
// but more explicit about tab management.
initializeFirestore(app,
{localCache:
persistentLocalCache(/*settings*/{tabManager: persistentSingleTabManager()})
});
// Use multi-tab IndexedDb persistence.
initializeFirestore(app,
{localCache:
persistentLocalCache(/*settings*/{tabManager: persistentMultipleTabManager()})
});
Web
firebase.firestore().enablePersistence() .catch((err) => { if (err.code == 'failed-precondition') { // Multiple tabs open, persistence can only be enabled // in one tab at a a time. // ... } else if (err.code == 'unimplemented') { // The current browser does not support all of the // features required to enable persistence // ... } }); // Subsequent queries will use persistence, if it was enabled successfully
Swift
let settings = FirestoreSettings() // Use memory-only cache settings.cacheSettings = MemoryCacheSettings(garbageCollectorSettings: MemoryLRUGCSettings()) // Use persistent disk cache, with 100 MB cache size settings.cacheSettings = PersistentCacheSettings(sizeBytes: 100 * 1024 * 1024 as NSNumber) // Any additional options // ... // Enable offline data persistence let db = Firestore.firestore() db.settings = settings
Objective-C
FIRFirestoreSettings *settings = [[FIRFirestoreSettings alloc] init]; // Use memory-only cache settings.cacheSettings = [[FIRMemoryCacheSettings alloc] initWithGarbageCollectorSettings:[[FIRMemoryLRUGCSettings alloc] init]]; // Use persistent disk cache (default behavior) // This example uses 100 MB. settings.cacheSettings = [[FIRPersistentCacheSettings alloc] initWithSizeBytes:@(100 * 1024 * 1024)]; // Any additional options // ... // Enable offline data persistence FIRFirestore *db = [FIRFirestore firestore]; db.settings = settings;
Kotlin+KTX
val settings = firestoreSettings { // Use memory cache setLocalCacheSettings(memoryCacheSettings {}) // Use persistent disk cache (default) setLocalCacheSettings(persistentCacheSettings {}) } db.firestoreSettings = settings
Java
FirebaseFirestoreSettings settings = new FirebaseFirestoreSettings.Builder(db.getFirestoreSettings()) // Use memory-only cache .setLocalCacheSettings(MemoryCacheSettings.newBuilder().build()) // Use persistent disk cache (default) .setLocalCacheSettings(PersistentCacheSettings.newBuilder() .build()) .build(); db.setFirestoreSettings(settings);
Dart
// Apple and Android db.settings = const Settings(persistenceEnabled: true); // Web await db .enablePersistence(const PersistenceSettings(synchronizeTabs: true));
कैश मेमोरी का साइज़ कॉन्फ़िगर करना
परसिस्टेंस चालू होने पर, Cloud Firestore बैकएंड से मिले हर दस्तावेज़ को कैश मेमोरी में सेव करता है. ऐसा करके, उसे ऑफ़लाइन ऐक्सेस किया जा सकता है. Cloud Firestore, कैश मेमोरी के साइज़ के लिए डिफ़ॉल्ट थ्रेशोल्ड सेट करता है. डिफ़ॉल्ट सेटिंग पार करने के बाद, Cloud Firestore समय-समय पर ऐसे दस्तावेज़ों को मिटाने की कोशिश करता है जो इस्तेमाल नहीं किए गए हैं. आप कैश मेमोरी के अलग-अलग साइज़ के थ्रेशोल्ड को कॉन्फ़िगर कर सकते हैं या साफ़ करने की प्रक्रिया को पूरी तरह से बंद कर सकते हैं:
Web
import { initializeFirestore, CACHE_SIZE_UNLIMITED } from "firebase/firestore"; const firestoreDb = initializeFirestore(app, { cacheSizeBytes: CACHE_SIZE_UNLIMITED });
Web
firebase.firestore().settings({ cacheSizeBytes: firebase.firestore.CACHE_SIZE_UNLIMITED });
Swift
// The default cache size threshold is 100 MB. Configure "cacheSizeBytes" // for a different threshold (minimum 1 MB) or set to "FirestoreCacheSizeUnlimited" // to disable clean-up. let settings = Firestore.firestore().settings // Set cache size to 100 MB settings.cacheSettings = PersistentCacheSettings(sizeBytes: 100 * 1024 * 1024 as NSNumber) Firestore.firestore().settings = settings
Objective-C
// The default cache size threshold is 100 MB. Configure "cacheSizeBytes" // for a different threshold (minimum 1 MB) or set to "kFIRFirestoreCacheSizeUnlimited" // to disable clean-up. FIRFirestoreSettings *settings = [FIRFirestore firestore].settings; // Set cache size to 100 MB settings.cacheSettings = [[FIRPersistentCacheSettings alloc] initWithSizeBytes:@(100 * 1024 * 1024)]; [FIRFirestore firestore].settings = settings;
Kotlin+KTX
// The default cache size threshold is 100 MB. Configure "setCacheSizeBytes" // for a different threshold (minimum 1 MB) or set to "CACHE_SIZE_UNLIMITED" // to disable clean-up. val settings = FirebaseFirestoreSettings.Builder() .setCacheSizeBytes(FirebaseFirestoreSettings.CACHE_SIZE_UNLIMITED) .build() db.firestoreSettings = settings
Java
// The default cache size threshold is 100 MB. Configure "setCacheSizeBytes" // for a different threshold (minimum 1 MB) or set to "CACHE_SIZE_UNLIMITED" // to disable clean-up. FirebaseFirestoreSettings settings = new FirebaseFirestoreSettings.Builder() .setCacheSizeBytes(FirebaseFirestoreSettings.CACHE_SIZE_UNLIMITED) .build(); db.setFirestoreSettings(settings);
Dart
db.settings = const Settings( persistenceEnabled: true, cacheSizeBytes: Settings.CACHE_SIZE_UNLIMITED, );
ऑफ़लाइन डेटा सुनना
डिवाइस के ऑफ़लाइन होने पर, अगर आपने ऑफ़लाइन परसिस्टेंस चालू किया है, तो लोकल कैश मेमोरी में सेव किए गए डेटा में बदलाव होने पर, आपके सुनने वालों को लिसनर इवेंट मिलने लगेंगे. दस्तावेज़ों, कलेक्शन, और क्वेरी को सुना जा सकता है.
यह देखने के लिए कि आपको सर्वर से डेटा मिल रहा है या कैश मेमोरी से, अपने स्नैपशॉट इवेंट में SnapshotMetadata
पर fromCache
प्रॉपर्टी का इस्तेमाल करें. अगर fromCache
true
है, तो इसका मतलब है कि डेटा कैश मेमोरी से मिला है. हो सकता है कि यह डेटा पुराना हो या अधूरा हो. अगर fromCache
की वैल्यू false
है, तो इसका मतलब है कि डेटा पूरा है और सर्वर पर मौजूद नए अपडेट के हिसाब से अप-टू-डेट है.
डिफ़ॉल्ट रूप से, अगर SnapshotMetadata
में सिर्फ़ बदलाव होता है, तो कोई इवेंट नहीं जनरेट होता. अगर fromCache
वैल्यू पर भरोसा किया जाता है, तो listen हैंडलर को अटैच करते समय includeMetadataChanges
listen विकल्प तय करें.
Web
import { collection, onSnapshot, where, query } from "firebase/firestore"; const q = query(collection(db, "cities"), where("state", "==", "CA")); onSnapshot(q, { includeMetadataChanges: true }, (snapshot) => { snapshot.docChanges().forEach((change) => { if (change.type === "added") { console.log("New city: ", change.doc.data()); } const source = snapshot.metadata.fromCache ? "local cache" : "server"; console.log("Data came from " + source); }); });
Web
db.collection("cities").where("state", "==", "CA") .onSnapshot({ includeMetadataChanges: true }, (snapshot) => { snapshot.docChanges().forEach((change) => { if (change.type === "added") { console.log("New city: ", change.doc.data()); } var source = snapshot.metadata.fromCache ? "local cache" : "server"; console.log("Data came from " + source); }); });
Swift
// Listen to metadata updates to receive a server snapshot even if // the data is the same as the cached data. db.collection("cities").whereField("state", isEqualTo: "CA") .addSnapshotListener(includeMetadataChanges: true) { querySnapshot, error in guard let snapshot = querySnapshot else { print("Error retreiving snapshot: \(error!)") return } for diff in snapshot.documentChanges { if diff.type == .added { print("New city: \(diff.document.data())") } } let source = snapshot.metadata.isFromCache ? "local cache" : "server" print("Metadata: Data fetched from \(source)") }
Objective-C
// Listen to metadata updates to receive a server snapshot even if // the data is the same as the cached data. [[[db collectionWithPath:@"cities"] queryWhereField:@"state" isEqualTo:@"CA"] addSnapshotListenerWithIncludeMetadataChanges:YES listener:^(FIRQuerySnapshot *snapshot, NSError *error) { if (snapshot == nil) { NSLog(@"Error retreiving snapshot: %@", error); return; } for (FIRDocumentChange *diff in snapshot.documentChanges) { if (diff.type == FIRDocumentChangeTypeAdded) { NSLog(@"New city: %@", diff.document.data); } } NSString *source = snapshot.metadata.isFromCache ? @"local cache" : @"server"; NSLog(@"Metadata: Data fetched from %@", source); }];
Kotlin+KTX
db.collection("cities").whereEqualTo("state", "CA") .addSnapshotListener(MetadataChanges.INCLUDE) { querySnapshot, e -> if (e != null) { Log.w(TAG, "Listen error", e) return@addSnapshotListener } for (change in querySnapshot!!.documentChanges) { if (change.type == DocumentChange.Type.ADDED) { Log.d(TAG, "New city: ${change.document.data}") } val source = if (querySnapshot.metadata.isFromCache) { "local cache" } else { "server" } Log.d(TAG, "Data fetched from $source") } }
Java
db.collection("cities").whereEqualTo("state", "CA") .addSnapshotListener(MetadataChanges.INCLUDE, new EventListener<QuerySnapshot>() { @Override public void onEvent(@Nullable QuerySnapshot querySnapshot, @Nullable FirebaseFirestoreException e) { if (e != null) { Log.w(TAG, "Listen error", e); return; } for (DocumentChange change : querySnapshot.getDocumentChanges()) { if (change.getType() == Type.ADDED) { Log.d(TAG, "New city:" + change.getDocument().getData()); } String source = querySnapshot.getMetadata().isFromCache() ? "local cache" : "server"; Log.d(TAG, "Data fetched from " + source); } } });
Dart
db .collection("cities") .where("state", isEqualTo: "CA") .snapshots(includeMetadataChanges: true) .listen((querySnapshot) { for (var change in querySnapshot.docChanges) { if (change.type == DocumentChangeType.added) { final source = (querySnapshot.metadata.isFromCache) ? "local cache" : "server"; print("Data fetched from $source}"); } } });
ऑफ़लाइन डेटा पाना
अगर डिवाइस ऑफ़लाइन होने पर आपको कोई दस्तावेज़ मिलता है, तो Cloud Firestore कैश मेमोरी से डेटा दिखाता है.
किसी कलेक्शन के लिए क्वेरी करने पर, अगर कैश मेमोरी में कोई दस्तावेज़ सेव नहीं है, तो कोई नतीजा नहीं दिखता. किसी खास दस्तावेज़ को फ़ेच करने के दौरान, गड़बड़ी का मैसेज दिखता है.
ऑफ़लाइन डेटा की क्वेरी करना
क्वेरी करने की सुविधा, ऑफ़लाइन पर्सेंटेंस के साथ काम करती है. जैसा कि पिछले सेक्शन में बताया गया है, आपको सीधे तौर पर या सुनकर, क्वेरी के नतीजे मिल सकते हैं. डिवाइस के ऑफ़लाइन होने पर भी, डिवाइस में सेव किए गए डेटा पर नई क्वेरी बनाई जा सकती हैं. हालांकि, शुरुआत में क्वेरी सिर्फ़ कैश मेमोरी में सेव किए गए दस्तावेज़ों के लिए ही चलेंगी.
ऑफ़लाइन क्वेरी इंडेक्स कॉन्फ़िगर करें
डिफ़ॉल्ट रूप से, ऑफ़लाइन क्वेरी लागू करते समय, Firestore SDK टूल अपने लोकल कैश मेमोरी में मौजूद कलेक्शन के सभी दस्तावेज़ों को स्कैन करता है. इस डिफ़ॉल्ट व्यवहार का इस्तेमाल करने पर, अगर उपयोगकर्ता लंबे समय तक ऑफ़लाइन रहते हैं, तो ऑफ़लाइन क्वेरी की परफ़ॉर्मेंस पर असर पड़ सकता है.
पर्सिस्टेंट कैश की सुविधा चालू होने पर, SDK टूल को स्थानीय क्वेरी इंडेक्स अपने-आप बनाने की अनुमति देकर, ऑफ़लाइन क्वेरी की परफ़ॉर्मेंस को बेहतर बनाया जा सकता है.
अपने-आप इंडेक्स होने की सुविधा डिफ़ॉल्ट रूप से बंद होती है. आपके ऐप्लिकेशन को हर बार शुरू होने पर, अपने-आप इंडेक्स होने की सुविधा चालू करनी होगी. नीचे दिए गए तरीके से यह कंट्रोल करें कि अपने-आप इंडेक्स होने की सुविधा चालू है या नहीं.
Swift
if let indexManager = Firestore.firestore().persistentCacheIndexManager { // Indexing is disabled by default indexManager.enableIndexAutoCreation() } else { print("indexManager is nil") }
Objective-C
PersistentCacheIndexManager *indexManager = [FIRFirestore firestore].persistentCacheIndexManager; if (indexManager) { // Indexing is disabled by default [indexManager enableIndexAutoCreation]; }
Kotlin+KTX
// return type: PersistentCacheManager? Firebase.firestore.persistentCacheIndexManager?.apply { // Indexing is disabled by default enableIndexAutoCreation() } ?: println("indexManager is null")
Java
// return type: @Nullable PersistentCacheIndexManager PersistentCacheIndexManager indexManager = FirebaseFirestore.getInstance().getPersistentCacheIndexManager(); if (indexManager != null) { // Indexing is disabled by default indexManager.enableIndexAutoCreation(); } // If not check indexManager != null, IDE shows warning: Method invocation 'enableIndexAutoCreation' may produce 'NullPointerException' FirebaseFirestore.getInstance().getPersistentCacheIndexManager().enableIndexAutoCreation();
अपने-आप इंडेक्स होने की सुविधा चालू होने के बाद, SDK टूल यह आकलन करता है कि किन कलेक्शन में बड़ी संख्या में कैश मेमोरी में सेव किए गए दस्तावेज़ हैं. साथ ही, यह स्थानीय क्वेरी की परफ़ॉर्मेंस को ऑप्टिमाइज़ करता है.
SDK टूल, क्वेरी इंडेक्स को मिटाने का तरीका उपलब्ध कराता है.
नेटवर्क ऐक्सेस बंद और चालू करें
अपने Cloud Firestore क्लाइंट का नेटवर्क ऐक्सेस बंद करने के लिए, नीचे दिया गया तरीका अपनाएं. नेटवर्क ऐक्सेस बंद होने पर, स्नैपशॉट लेने वाले सभी लोग और दस्तावेज़ का अनुरोध करने पर, कैश मेमोरी से नतीजे मिलते हैं. लिखने की कार्रवाइयाँ तब तक सूची में रखी जाती हैं, जब तक नेटवर्क का ऐक्सेस फिर से चालू नहीं किया जाता.
Web
import { disableNetwork } from "firebase/firestore"; await disableNetwork(db); console.log("Network disabled!"); // Do offline actions // ...
Web
firebase.firestore().disableNetwork() .then(() => { // Do offline actions // ... });
Swift
Firestore.firestore().disableNetwork { (error) in // Do offline things // ... }
Objective-C
[[FIRFirestore firestore] disableNetworkWithCompletion:^(NSError *_Nullable error) { // Do offline actions // ... }];
Kotlin+KTX
db.disableNetwork().addOnCompleteListener { // Do offline things // ... }
Java
db.disableNetwork() .addOnCompleteListener(new OnCompleteListener<Void>() { @Override public void onComplete(@NonNull Task<Void> task) { // Do offline things // ... } });
Dart
db.disableNetwork().then((_) { // Do offline things });
नेटवर्क का ऐक्सेस फिर से चालू करने के लिए, नीचे दिए गए तरीके का इस्तेमाल करें:
Web
import { enableNetwork } from "firebase/firestore"; await enableNetwork(db); // Do online actions // ...
Web
firebase.firestore().enableNetwork() .then(() => { // Do online actions // ... });
Swift
Firestore.firestore().enableNetwork { (error) in // Do online things // ... }
Objective-C
[[FIRFirestore firestore] enableNetworkWithCompletion:^(NSError *_Nullable error) { // Do online actions // ... }];
Kotlin+KTX
db.enableNetwork().addOnCompleteListener { // Do online things // ... }
Java
db.enableNetwork() .addOnCompleteListener(new OnCompleteListener<Void>() { @Override public void onComplete(@NonNull Task<Void> task) { // Do online things // ... } });
Dart
db.enableNetwork().then((_) { // Back online });