Cloud Firestore অফলাইন ডেটা পার্সিস্টেন্স সমর্থন করে। এই ফিচারটি আপনার অ্যাপের সক্রিয়ভাবে ব্যবহৃত Cloud Firestore ডেটার একটি কপি ক্যাশ করে রাখে, ফলে ডিভাইস অফলাইনে থাকলেও আপনার অ্যাপ সেই ডেটা অ্যাক্সেস করতে পারে। আপনি ক্যাশ করা ডেটাতে লিখতে, পড়তে, তা শুনতে এবং কোয়েরি করতে পারেন।
ডিভাইসটি পুনরায় অনলাইন হলে, Cloud Firestore আপনার অ্যাপ দ্বারা করা যেকোনো স্থানীয় পরিবর্তনকে Cloud Firestore ব্যাকএন্ডের সাথে সিঙ্ক্রোনাইজ করে। একই ডকুমেন্টে একাধিক পরিবর্তনের ক্ষেত্রে, সর্বশেষ লেখা পরিবর্তনটিই চূড়ান্ত বলে গণ্য হয়।
অফলাইন পার্সিস্টেন্স ব্যবহার করার জন্য, Cloud Firestore ডেটা অ্যাক্সেস করতে ব্যবহৃত কোডে কোনো পরিবর্তন করার প্রয়োজন নেই। অফলাইন পার্সিস্টেন্স সক্রিয় থাকলে, Cloud Firestore ক্লায়েন্ট লাইব্রেরি স্বয়ংক্রিয়ভাবে অনলাইন ও অফলাইন ডেটা অ্যাক্সেস পরিচালনা করে এবং ডিভাইসটি পুনরায় অনলাইনে এলে স্থানীয় ডেটা সিঙ্ক্রোনাইজ করে।
অফলাইন স্থায়িত্ব কনফিগার করুন
যখন আপনি Cloud Firestore ইনিশিয়ালাইজ করেন, তখন আপনি অফলাইন পার্সিস্টেন্স চালু বা বন্ধ করতে পারেন:
- অ্যান্ড্রয়েড এবং অ্যাপল প্ল্যাটফর্মের জন্য, অফলাইন পার্সিস্টেন্স ডিফল্টরূপে সক্রিয় থাকে। পার্সিস্টেন্স নিষ্ক্রিয় করতে,
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
সুইফট
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
উদ্দেশ্য-সি
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));
ক্যাশে আকার কনফিগার করুন
যখন পার্সিস্টেন্স (persistence) সক্রিয় করা থাকে, তখন 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 });
সুইফট
// 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
উদ্দেশ্য-সি
// 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 লিসেন অপশনটি উল্লেখ করুন।
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); }); });
সুইফট
// 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
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 ক্যাশ থেকে ডেটা ফেরত দেয়।
কোনো কালেকশন কোয়েরি করার সময়, ক্যাশে করা কোনো ডকুমেন্ট না থাকলে একটি খালি ফলাফল ফেরত দেওয়া হয়। কোনো নির্দিষ্ট ডকুমেন্ট ফেচ করার সময়, এর পরিবর্তে একটি এরর ফেরত দেওয়া হয়।
অফলাইন ডেটা অনুসন্ধান করুন
অফলাইন পার্সিস্টেন্সের সাথে কোয়েরি করা যায়। পূর্ববর্তী বিভাগগুলিতে বর্ণিত পদ্ধতি অনুযায়ী, আপনি সরাসরি 'গেট' কমান্ডের মাধ্যমে অথবা 'লিসেনিং' ব্যবহার করে কোয়েরির ফলাফল পেতে পারেন। ডিভাইসটি অফলাইনে থাকা অবস্থায়ও আপনি স্থানীয়ভাবে সংরক্ষিত ডেটার উপর নতুন কোয়েরি তৈরি করতে পারেন, কিন্তু কোয়েরিগুলো প্রাথমিকভাবে শুধুমাত্র ক্যাশ করা ডকুমেন্টগুলোর উপরেই চলবে।
অফলাইন কোয়েরি ইনডেক্স কনফিগার করুন
ডিফল্টরূপে, ফায়ারস্টোর এসডিকে অফলাইন কোয়েরি চালানোর সময় একটি কালেকশনের সমস্ত ডকুমেন্ট তার লোকাল ক্যাশে স্ক্যান করে। এই ডিফল্ট আচরণের কারণে, ব্যবহারকারীরা দীর্ঘ সময় ধরে অফলাইনে থাকলে অফলাইন কোয়েরির পারফরম্যান্স ক্ষতিগ্রস্ত হতে পারে।
পারসিস্টেন্ট ক্যাশে সক্রিয় থাকলে, এসডিকে-কে স্বয়ংক্রিয়ভাবে স্থানীয় কোয়েরি ইনডেক্স তৈরি করার সুযোগ দিয়ে আপনি অফলাইন কোয়েরির পারফরম্যান্স উন্নত করতে পারেন।
স্বয়ংক্রিয় ইন্ডেক্সিং ডিফল্টরূপে নিষ্ক্রিয় থাকে। আপনার অ্যাপটিকে প্রতিবার চালু হওয়ার সময় স্বয়ংক্রিয় ইন্ডেক্সিং সক্রিয় করতে হবে। নিচে দেখানো পদ্ধতি অনুযায়ী স্বয়ংক্রিয় ইন্ডেক্সিং সক্রিয় থাকবে কিনা তা নিয়ন্ত্রণ করুন।
সুইফট
if let indexManager = Firestore.firestore().persistentCacheIndexManager { // Indexing is disabled by default indexManager.enableIndexAutoCreation() } else { print("indexManager is nil") }
উদ্দেশ্য-সি
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 // ... });
সুইফট
Firestore.firestore().disableNetwork { (error) in // Do offline things // ... }
উদ্দেশ্য-সি
[[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 // ... });
সুইফট
Firestore.firestore().enableNetwork { (error) in // Do online things // ... }
উদ্দেশ্য-সি
[[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 });