डेटा को ऑफ़लाइन ऐक्सेस करना

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 और App Clip टारगेट पर उपलब्ध नहीं है.
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 और App Clip टारगेट पर उपलब्ध नहीं है.
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
ध्यान दें: यह प्रॉडक्ट WatchOS और App Clip टारगेट पर उपलब्ध नहीं है.
// 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 और App Clip टारगेट पर उपलब्ध नहीं है.
// 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 की वैल्यू का इस्तेमाल करें, 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 और App Clip टारगेट पर उपलब्ध नहीं है.
// 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 और App Clip टारगेट पर उपलब्ध नहीं है.
// 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
ध्यान दें: यह प्रॉडक्ट WatchOS और App Clip टारगेट पर उपलब्ध नहीं है.
Firestore.firestore().disableNetwork { (error) in
  // Do offline things
  // ...
}
Objective-C
ध्यान दें: यह प्रॉडक्ट WatchOS और App Clip टारगेट पर उपलब्ध नहीं है.
[[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
ध्यान दें: यह प्रॉडक्ट WatchOS और App Clip टारगेट पर उपलब्ध नहीं है.
Firestore.firestore().enableNetwork { (error) in
  // Do online things
  // ...
}
Objective-C
ध्यान दें: यह प्रॉडक्ट WatchOS और App Clip टारगेट पर उपलब्ध नहीं है.
[[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
});