অফলাইনে ডেটা অ্যাক্সেস করুন

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
মনে রাখবেন: এই প্রোডাক্ট watchOS এবং অ্যাপ ক্লিপ টার্গেটে উপলভ্য নয়।
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
মনে রাখবেন: এই প্রোডাক্ট watchOS এবং অ্যাপ ক্লিপ টার্গেটে উপলভ্য নয়।
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
মনে রাখবেন: এই প্রোডাক্ট watchOS এবং অ্যাপ ক্লিপ টার্গেটে উপলভ্য নয়।
// 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
মনে রাখবেন: এই প্রোডাক্ট watchOS এবং অ্যাপ ক্লিপ টার্গেটে উপলভ্য নয়।
// 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);
      });
  });
Swift
মনে রাখবেন: এই প্রোডাক্ট watchOS এবং অ্যাপ ক্লিপ টার্গেটে উপলভ্য নয়।
// 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
মনে রাখবেন: এই প্রোডাক্ট watchOS এবং অ্যাপ ক্লিপ টার্গেটে উপলভ্য নয়।
// 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 মূল্যায়ন করে দেখে যে কোন কোন কালেকশনে অনেক বেশি সংখ্যক ক্যাশে করা ডকুমেন্ট আছে এবং লোকাল কোয়েরির পারফর্ম্যান্স অপ্টিমাইজ করে।

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
মনে রাখবেন: এই প্রোডাক্ট watchOS এবং অ্যাপ ক্লিপ টার্গেটে উপলভ্য নয়।
Firestore.firestore().disableNetwork { (error) in
  // Do offline things
  // ...
}
Objective-C
মনে রাখবেন: এই প্রোডাক্ট watchOS এবং অ্যাপ ক্লিপ টার্গেটে উপলভ্য নয়।
[[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
মনে রাখবেন: এই প্রোডাক্ট watchOS এবং অ্যাপ ক্লিপ টার্গেটে উপলভ্য নয়।
Firestore.firestore().enableNetwork { (error) in
  // Do online things
  // ...
}
Objective-C
মনে রাখবেন: এই প্রোডাক্ট watchOS এবং অ্যাপ ক্লিপ টার্গেটে উপলভ্য নয়।
[[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
});