क्लाउड फायरस्टोर ऑफ़लाइन डेटा दृढ़ता का समर्थन करता है। यह सुविधा क्लाउड फायरस्टोर डेटा की एक कॉपी को कैश करती है जिसका उपयोग आपका ऐप सक्रिय रूप से कर रहा है, इसलिए आपका ऐप डिवाइस के ऑफ़लाइन होने पर डेटा तक पहुंच सकता है। आप कैश्ड डेटा को लिख, पढ़, सुन और क्वेरी कर सकते हैं। जब डिवाइस वापस ऑनलाइन आता है, तो क्लाउड फायरस्टोर आपके ऐप द्वारा क्लाउड फायरस्टोर बैकएंड में किए गए किसी भी स्थानीय परिवर्तन को सिंक्रनाइज़ करता है।
ऑफ़लाइन दृढ़ता का उपयोग करने के लिए, आपको उस कोड में कोई बदलाव करने की आवश्यकता नहीं है जिसका उपयोग आप Cloud Firestore डेटा तक पहुँचने के लिए करते हैं। ऑफ़लाइन दृढ़ता सक्षम होने के साथ, क्लाउड फायरस्टार क्लाइंट लाइब्रेरी स्वचालित रूप से ऑनलाइन और ऑफलाइन डेटा एक्सेस का प्रबंधन करती है और डिवाइस के ऑनलाइन होने पर स्थानीय डेटा को सिंक्रनाइज़ करती है।
ऑफ़लाइन दृढ़ता कॉन्फ़िगर करें
जब आप Cloud Firestore को प्रारंभ करते हैं, तो आप ऑफ़लाइन दृढ़ता को सक्षम या अक्षम कर सकते हैं:
- Android और Apple प्लेटफ़ॉर्म के लिए, ऑफ़लाइन दृढ़ता डिफ़ॉल्ट रूप से सक्षम है। दृढ़ता को अक्षम करने के लिए,
PersistenceEnabled
विकल्प कोfalse
पर सेट करें। - वेब के लिए, ऑफ़लाइन दृढ़ता डिफ़ॉल्ट रूप से अक्षम है। दृढ़ता को सक्षम करने के लिए
enablePersistence
विधि को कॉल करें। Cloud Firestore का कैश सत्रों के बीच अपने आप साफ़ नहीं होता है। नतीजतन, यदि आपका वेब ऐप संवेदनशील जानकारी को संभालता है, तो दृढ़ता को सक्षम करने से पहले उपयोगकर्ता से पूछना सुनिश्चित करें कि क्या वे विश्वसनीय डिवाइस पर हैं।
Web version 9
import { enableIndexedDbPersistence } from "firebase/firestore"; enableIndexedDbPersistence(db) .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
Web version 8
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
तीव्र
let settings = FirestoreSettings() settings.isPersistenceEnabled = true // Any additional options // ... // Enable offline data persistence let db = Firestore.firestore() db.settings = settings
उद्देश्य सी
FIRFirestoreSettings *settings = [[FIRFirestoreSettings alloc] init]; settings.persistenceEnabled = YES; // Any additional options // ... // Enable offline data persistence FIRFirestore *db = [FIRFirestore firestore]; db.settings = settings;
Kotlin+KTX
val settings = firestoreSettings { isPersistenceEnabled = true } db.firestoreSettings = settings
Java
FirebaseFirestoreSettings settings = new FirebaseFirestoreSettings.Builder() .setPersistenceEnabled(true) .build(); db.setFirestoreSettings(settings);
Dart
// Apple and Android db.settings = const Settings(persistenceEnabled: true); // Web await db .enablePersistence(const PersistenceSettings(synchronizeTabs: true));
कैश आकार कॉन्फ़िगर करें
दृढ़ता सक्षम होने पर, क्लाउड फायरस्टार बैकएंड से प्राप्त प्रत्येक दस्तावेज़ को ऑफ़लाइन एक्सेस के लिए कैश करता है। क्लाउड फायरस्टोर कैश आकार के लिए एक डिफ़ॉल्ट सीमा निर्धारित करता है। डिफ़ॉल्ट से अधिक होने के बाद, क्लाउड फायरस्टोर समय-समय पर पुराने, अप्रयुक्त दस्तावेज़ों को साफ़ करने का प्रयास करता है। आप एक अलग कैश आकार सीमा को कॉन्फ़िगर कर सकते हैं या क्लीन-अप प्रक्रिया को पूरी तरह अक्षम कर सकते हैं:
Web version 9
import { initializeFirestore, CACHE_SIZE_UNLIMITED } from "firebase/firestore"; const firestoreDb = initializeFirestore(app, { cacheSizeBytes: CACHE_SIZE_UNLIMITED });
Web version 8
firebase.firestore().settings({ cacheSizeBytes: firebase.firestore.CACHE_SIZE_UNLIMITED });
तीव्र
// 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 settings.cacheSizeBytes = FirestoreCacheSizeUnlimited Firestore.firestore().settings = settings
उद्देश्य सी
// 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; settings.cacheSizeBytes = kFIRFirestoreCacheSizeUnlimited; [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
मानों पर भरोसा करते हैं, तो includeMetadataChanges
सुनें विकल्प निर्दिष्ट करें जब आप अपना श्रोता हैंडलर संलग्न करते हैं।
Web version 9
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 version 8
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); }); });
तीव्र
// 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)") }
उद्देश्य सी
// 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 कैशे से डेटा लौटाता है।
किसी संग्रह की क्वेरी करते समय, यदि कैश्ड दस्तावेज़ नहीं हैं, तो एक खाली परिणाम लौटाया जाता है। विशिष्ट दस्तावेज़ प्राप्त करते समय, इसके बजाय एक त्रुटि दी जाती है।
ऑफ़लाइन डेटा क्वेरी करें
पूछताछ ऑफ़लाइन दृढ़ता के साथ काम करती है। जैसा कि पिछले अनुभागों में बताया गया है, आप सीधे प्राप्त करके या सुनकर प्रश्नों के परिणाम प्राप्त कर सकते हैं। डिवाइस के ऑफ़लाइन होने पर आप स्थानीय रूप से मौजूद डेटा पर नई क्वेरी भी बना सकते हैं, लेकिन शुरुआत में क्वेरी केवल कैश किए गए दस्तावेज़ों के विरुद्ध ही चलेंगी।
ऑफ़लाइन क्वेरी इंडेक्स कॉन्फ़िगर करें
डिफ़ॉल्ट रूप से, फायरस्टोर एसडीके ऑफ़लाइन प्रश्नों को निष्पादित करते समय संग्रह में सभी दस्तावेजों को अपने स्थानीय कैश में स्कैन करता है। इस डिफ़ॉल्ट व्यवहार के साथ, जब उपयोगकर्ता लंबे समय तक ऑफ़लाइन रहते हैं, तो ऑफ़लाइन क्वेरी प्रदर्शन प्रभावित हो सकता है।
आप स्थानीय क्वेरी अनुक्रमणिकाओं को कॉन्फ़िगर करके ऑफ़लाइन क्वेरीज़ के प्रदर्शन में सुधार कर सकते हैं:
तीव्र
Apple प्लेटफ़ॉर्म SDK एक setIndexConfiguration
विधि प्रदान करता है जो उसी JSON-संरचित कॉन्फ़िगरेशन को पढ़ता है जो सर्वर पर इंडेक्स को कॉन्फ़िगर करने के लिए उपयोग किया जाता है, समान इंडेक्स डेफिनिशन फॉर्मेट का पालन करता है।
// You will normally read this from a file asset or cloud storage. let indexConfigJson = """ { indexes: [ ... ], fieldOverrides: [ ... ] } """ // Apply the configuration. Firestore.firestore().setIndexConfiguration(indexConfigJson)
उद्देश्य सी
Apple प्लेटफ़ॉर्म SDK setIndexConfiguration
- विधियाँ प्रदान करता है जो समान JSON-संरचित कॉन्फ़िगरेशन को सर्वर पर अनुक्रमणिका को कॉन्फ़िगर करने के लिए उपयोग किया जाता है, उसी अनुक्रमणिका परिभाषा प्रारूप का अनुसरण करते हुए।
// You will normally read this from a file asset or cloud storage. NSString *indexConfigJson = @" { " " indexes: [ " " ... " " ], " " fieldOverrides: [ " " ... " " ] " " } "; // Apply the configuration. [[FIRFirestore firestore] setIndexConfigurationFromJSON:indexConfigJson completion:^(NSError * _Nullable error) { // ... }];
Java
एंड्रॉइड एसडीके एक setIndexConfiguration
विधि प्रदान करता है जो उसी जेएसओएन-संरचित कॉन्फ़िगरेशन को उसी इंडेक्स परिभाषा प्रारूप के बाद सर्वर पर इंडेक्स कॉन्फ़िगर करने के लिए उपयोग किया जाता है।
// You will normally read this from a file asset or cloud storage. String indexConfigJson = " { " + " indexes: [ " + " ... " + " ], " + " fieldOverrides: [ " + " ... " + " ] " + " } "; // Apply the configuration. FirebaseFirestore.getInstance().setIndexConfiguration(indexConfigJson);
Kotlin+KTX
एंड्रॉइड एसडीके एक setIndexConfiguration
विधि प्रदान करता है जो उसी जेएसओएन-संरचित कॉन्फ़िगरेशन को उसी इंडेक्स परिभाषा प्रारूप के बाद सर्वर पर इंडेक्स कॉन्फ़िगर करने के लिए उपयोग किया जाता है।
// You will normally read this from a file asset or cloud storage. val indexConfigJson = """ { indexes: [ ... ], fieldOverrides: [ ... ] } """ // Apply the configuration. FirebaseFirestore.getInstance().setIndexConfiguration(indexConfigJson)
Dart
Flutter SDK एक setIndexConfigurationFromJSON
विधि प्रदान करता है जो उसी JSON-संरचित कॉन्फ़िगरेशन को पढ़ता है जिसका उपयोग सर्वर पर अनुक्रमणिका को कॉन्फ़िगर करने के लिए किया जाता है, समान अनुक्रमणिका परिभाषा प्रारूप के बाद।
// You will normally read this from a file asset or cloud storage. var indexConfigJson = """ { indexes: [ ... ], fieldOverrides: [ ... ] } """; // Apply the configuration. await FirebaseFirestore.instance.setIndexConfigurationFromJSON(json: indexConfigJson);
वैकल्पिक रूप से, आप क्लास-आधारित एपीआई के साथ इंडेक्स को कॉन्फ़िगर करने के लिए setIndexConfiguration
विधि का उपयोग कर सकते हैं।
var indexes = [ Index( collectionGroup: "posts", queryScope: QueryScope.collection, fields: [ IndexField(fieldPath: "author", arrayConfig: ArrayConfig.contains), IndexField(fieldPath: "timestamp", order: Order.descending) ], ), ]; await FirebaseFirestore.instance.setIndexConfiguration(indexes: indexes);
उपयोग करने के लिए ऑफ़लाइन अनुक्रमणिका कॉन्फ़िगरेशन इस बात पर निर्भर करता है कि ऑफ़लाइन होने पर आपका ऐप किन संग्रहों और दस्तावेज़ों तक पहुँचता है और ऑफ़लाइन प्रदर्शन आप चाहते हैं। जब आप क्लाइंट पर उपयोग के लिए अपने बैकएंड इंडेक्स कॉन्फ़िगरेशन को निर्यात कर सकते हैं, तो आपके ऐप के ऑफ़लाइन एक्सेस पैटर्न ऑनलाइन एक्सेस पैटर्न से काफी भिन्न हो सकते हैं, इसलिए आपका ऑनलाइन इंडेक्स कॉन्फ़िगरेशन ऑफ़लाइन उपयोग के लिए उपयुक्त नहीं हो सकता है। आप अपने ऐप को उच्च प्रदर्शन के साथ कौन से संग्रह और दस्तावेज़ ऑफ़लाइन एक्सेस करना चाहते हैं? एक बार जब आप अपने ऐप के व्यवहार का विश्लेषण कर लेते हैं, तो इंडेक्सिंग गाइड से इंडेक्स परिभाषा के सिद्धांतों का पालन करें।
अपने क्लाइंट ऐप में लोड करने के लिए ऑफ़लाइन अनुक्रमणिका कॉन्फ़िगरेशन उपलब्ध कराने के लिए:
- उन्हें अपने ऐप से संकलित और वितरित करें
- उन्हें सीडीएन से डाउनलोड करें
- उन्हें Firebase के लिए क्लाउड स्टोरेज जैसे स्टोरेज सिस्टम से लाएं।
नेटवर्क एक्सेस को अक्षम और सक्षम करें
आप अपने क्लाउड फायरस्टोर क्लाइंट के लिए नेटवर्क एक्सेस को अक्षम करने के लिए नीचे दी गई विधि का उपयोग कर सकते हैं। जबकि नेटवर्क एक्सेस अक्षम है, सभी स्नैपशॉट श्रोता और दस्तावेज़ अनुरोध कैश से परिणाम पुनर्प्राप्त करते हैं। नेटवर्क एक्सेस को फिर से सक्षम करने तक राइट ऑपरेशंस कतारबद्ध हैं।
Web version 9
import { disableNetwork } from "firebase/firestore"; await disableNetwork(db); console.log("Network disabled!"); // Do offline actions // ...
Web version 8
firebase.firestore().disableNetwork() .then(() => { // Do offline actions // ... });
तीव्र
Firestore.firestore().disableNetwork { (error) in // Do offline things // ... }
उद्देश्य सी
[[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 version 9
import { enableNetwork } from "firebase/firestore"; await enableNetwork(db); // Do online actions // ...
Web version 8
firebase.firestore().enableNetwork() .then(() => { // Do online actions // ... });
तीव्र
Firestore.firestore().enableNetwork { (error) in // Do online things // ... }
उद्देश्य सी
[[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 });