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
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
// 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 वैल्यू पर भरोसा है, तो लिसन हैंडलर अटैच करते समय 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
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
// 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 यह पता लगाता है कि किन कलेक्शन में बड़ी संख्या में कैश मेमोरी में सेव किए गए दस्तावेज़ हैं. साथ ही, यह स्थानीय क्वेरी की परफ़ॉर्मेंस को ऑप्टिमाइज़ करता है.
एसडीके, क्वेरी इंडेक्स मिटाने का तरीका उपलब्ध कराता है.
नेटवर्क ऐक्सेस करने की सुविधा बंद और चालू करना
अपने 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
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
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 });